[TASK] Move classAliasMaps into compatibility6 extension part 6
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / ContentObject / ContentObjectStdWrapHookInterface.php
1 <?php
2 namespace TYPO3\CMS\Frontend\ContentObject;
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 /**
18 * interface for classes which hook into \TYPO3\CMS\Frontend\ContentObject and do additional stdWrap processing
19 *
20 * @author Ingo Renner <ingo@typo3.org>
21 */
22 interface ContentObjectStdWrapHookInterface {
23
24 /**
25 * Hook for modifying $content before core's stdWrap does anything
26 *
27 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
28 * @param array $configuration TypoScript stdWrap properties
29 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $parentObject Parent content object
30 * @return string Further processed $content
31 */
32 public function stdWrapPreProcess($content, array $configuration, ContentObjectRenderer &$parentObject);
33
34 /**
35 * Hook for modifying $content after core's stdWrap has processed setContentToCurrent, setCurrent, lang, data, field, current, cObject, numRows, filelist and/or preUserFunc
36 *
37 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
38 * @param array $configuration TypoScript stdWrap properties
39 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $parentObject Parent content object
40 * @return string Further processed $content
41 */
42 public function stdWrapOverride($content, array $configuration, ContentObjectRenderer &$parentObject);
43
44 /**
45 * Hook for modifying $content after core's stdWrap has processed override, preIfEmptyListNum, ifEmpty, ifBlank, listNum, trim and/or more (nested) stdWraps
46 *
47 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
48 * @param array $configuration TypoScript "stdWrap properties".
49 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $parentObject Parent content object
50 * @return string Further processed $content
51 */
52 public function stdWrapProcess($content, array $configuration, ContentObjectRenderer &$parentObject);
53
54 /**
55 * Hook for modifying $content after core's stdWrap has processed anything but debug
56 *
57 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
58 * @param array $configuration TypoScript stdWrap properties
59 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $parentObject Parent content object
60 * @return string Further processed $content
61 */
62 public function stdWrapPostProcess($content, array $configuration, ContentObjectRenderer &$parentObject);
63
64 }