[TASK] Deprecate PageRepository::setHash and storeHash 17/52217/2
authorBenni Mack <benni@typo3.org>
Tue, 28 Mar 2017 14:49:40 +0000 (16:49 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Tue, 28 Mar 2017 15:51:04 +0000 (17:51 +0200)
The two static methods are sole wrappers for the Caching Framework nowadays
which can simply be dealt with in a custom way.

Use the Caching Framework directly instead!

Resolves: #80524
Releases: master
Change-Id: I8fced0800a2c72705f1a01e0a3d6e52aeaf5daef
Reviewed-on: https://review.typo3.org/52217
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/core/Documentation/Changelog/master/Deprecation-80524-PageRepositorygetHashAndPageRepositorystoreHash.rst [new file with mode: 0644]
typo3/sysext/frontend/Classes/Page/PageRepository.php

diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80524-PageRepositorygetHashAndPageRepositorystoreHash.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80524-PageRepositorygetHashAndPageRepositorystoreHash.rst
new file mode 100644 (file)
index 0000000..0415841
--- /dev/null
@@ -0,0 +1,34 @@
+.. include:: ../../Includes.txt
+
+===========================================================================
+Deprecation: #80524 - PageRepository::getHash and PageRepository::storeHash
+===========================================================================
+
+See :issue:`80524`
+
+Description
+===========
+
+The two static methods php:`PageRepository::getHash()` and php:`PageRepository::storeHash()`, that
+act as simple wrappers for the Caching Frameworks's "cache_hash" frontend, have been deprecated.
+
+
+Impact
+======
+
+Calling any of the methods above will trigger a deprecation log entry.
+
+
+Affected Installations
+======================
+
+Any installation with a custom installation using any of the methods.
+
+
+Migration
+=========
+
+Use the Caching Framework directly. Simply spoken, the code that still exists in the functions,
+can simply be copied into the third-party extensions' code.
+
+.. index:: PHP-API
\ No newline at end of file
index dad9928..0be3678 100644 (file)
@@ -1258,9 +1258,11 @@ class PageRepository
      * @param string $hash The hash-string which was used to store the data value
      * @return mixed The "data" from the cache
      * @see tslib_TStemplate::start(), storeHash()
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, please use the Cache Manager directly to fetch cache entries
      */
     public static function getHash($hash)
     {
+        GeneralUtility::logDeprecatedFunction();
         $hashContent = null;
         /** @var \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $contentHashCache */
         $contentHashCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_hash');
@@ -1283,9 +1285,11 @@ class PageRepository
      * @param string $ident Is just a textual identification in order to inform about the content!
      * @param int $lifetime The lifetime for the cache entry in seconds
      * @see tslib_TStemplate::start(), getHash()
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, please use the Cache Manager directly to store cache entries
      */
     public static function storeHash($hash, $data, $ident, $lifetime = 0)
     {
+        GeneralUtility::logDeprecatedFunction();
         GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_hash')->set($hash, $data, ['ident_' . $ident], (int)$lifetime);
     }