[TASK] Deprecate visibility for internal variables in Datahandler class 11/51411/6
authorThomas Hohn <thomas@hohn.dk>
Tue, 24 Jan 2017 21:00:33 +0000 (22:00 +0100)
committerMorton Jonuschat <m.jonuschat@mojocode.de>
Thu, 26 Jan 2017 02:06:34 +0000 (03:06 +0100)
This patch marks some internal cache variables in the
Datahandler as deprecated since their visibility should be
changed from public to protected or even be replaced
by a runtime cache. Since this can't be done before
TYPO3 v9 they are marked as deprecated in TYPO3 v8
as a preparation.

Fixes: #79441
Releases: master
Change-Id: I7d35792fb81e6f16b3b729a3841c1cfda109952f
Reviewed-on: https://review.typo3.org/51411
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Morton Jonuschat <m.jonuschat@mojocode.de>
Tested-by: Morton Jonuschat <m.jonuschat@mojocode.de>
typo3/sysext/core/Classes/DataHandling/DataHandler.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-79441-ChangeVisibilityInternalCacheDatahandler.rst [new file with mode: 0644]

index 73fd884..de95dab 100644 (file)
@@ -466,6 +466,8 @@ class DataHandler
      * Used by function checkRecordUpdateAccess() to store whether a record is updatable or not.
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $recUpdateAccessCache = [];
 
@@ -473,6 +475,8 @@ class DataHandler
      * User by function checkRecordInsertAccess() to store whether a record can be inserted on a page id
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $recInsertAccessCache = [];
 
@@ -480,6 +484,8 @@ class DataHandler
      * Caching array for check of whether records are in a webmount
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $isRecordInWebMount_Cache = [];
 
@@ -487,6 +493,8 @@ class DataHandler
      * Caching array for page ids in webmounts
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $isInWebMount_Cache = [];
 
@@ -494,6 +502,8 @@ class DataHandler
      * Caching for collecting TSconfig for page ids
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $cachedTSconfig = [];
 
@@ -501,6 +511,8 @@ class DataHandler
      * Used for caching page records in pageInfo()
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, visibility will change to protected or to a run-time cache in TYPO3 v9
      */
     public $pageCache = [];
 
@@ -508,6 +520,8 @@ class DataHandler
      * Array caching workspace access for BE_USER
      *
      * @var array
+     *
+     * @deprecated since TYPO3 v8, no refereces could be found in class will be removed in TYPO3 v9
      */
     public $checkWorkspaceCache = [];
 
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79441-ChangeVisibilityInternalCacheDatahandler.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79441-ChangeVisibilityInternalCacheDatahandler.rst
new file mode 100644 (file)
index 0000000..ab82e2b
--- /dev/null
@@ -0,0 +1,56 @@
+.. include:: ../../Includes.txt
+
+==================================================================
+Deprecation: #79441 - Deprecate visibility internal caching arrays
+==================================================================
+
+See :issue:`79441`
+
+Description
+===========
+
+The following variables have been marked as deprecated in the
+Datahandler since their visibility will change from public to
+protected or even be replaced by a run-time cache.
+The documentation states that these are "internal-cache"
+variables and hence the visibility public is misleading.
+
+.. code-block:: php
+
+       public $recUpdateAccessCache = [];
+        public $recInsertAccessCache = [];
+        public $isRecordInWebMount_Cache = [];
+        public $isInWebMount_Cache = [];
+        public $cachedTSconfig = [];
+        public $pageCache = [];
+
+
+The following variable has been marked as deprecated in the
+Datahandler since it is not referenced in the class.
+
+.. code-block:: php
+
+       public $checkWorkspaceCache = [];
+
+
+
+Impact
+======
+
+These variables should not be accessed in Datahandler from outside
+the class since their visibility or even implementation will
+change with TYPO3 v9.
+
+
+Affected Installations
+======================
+
+Extensions using one of the above variables.
+
+
+Migration
+=========
+
+None - since public internal
+
+.. index:: PHP-API
\ No newline at end of file