[CLEANUP] Improve the @param/@return/@var PHPDoc
[Packages/TYPO3.CMS.git] / typo3 / sysext / indexed_search / Classes / Hook / TypoScriptFrontendHook.php
1 <?php
2 namespace TYPO3\CMS\IndexedSearch\Hook;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
18
19 /**
20 * Hooks for \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController (TSFE).
21 *
22 * @author Oliver Hader <oliver@typo3.org>
23 */
24 class TypoScriptFrontendHook {
25
26 /**
27 * Frontend hook: If the page is not being re-generated this is our chance to force it to be (because re-generation of the page is required in order to have the indexer called!)
28 *
29 * @param array $params Parameters from frontend
30 * @param TypoScriptFrontendController $ref TSFE object
31 * @return void
32 */
33 public function headerNoCache(array &$params, $ref) {
34 // Requirements are that the crawler is loaded, a crawler session is running and re-indexing requested as processing instruction:
35 if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('crawler') && $params['pObj']->applicationData['tx_crawler']['running'] && in_array('tx_indexedsearch_reindex', $params['pObj']->applicationData['tx_crawler']['parameters']['procInstructions'])) {
36 // Setting simple log entry:
37 $params['pObj']->applicationData['tx_crawler']['log'][] = 'RE_CACHE (indexed), old status: ' . $params['disableAcquireCacheData'];
38 // Disables a look-up for cached page data - thus resulting in re-generation of the page even if cached.
39 $params['disableAcquireCacheData'] = TRUE;
40 }
41 }
42
43 }