Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / interfaces / interface.tslib_content_stdwraphook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2007-2011 Ingo Renner <ingo@typo3.org>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28
29 /**
30 * interface for classes which hook into tslib_content and do additional stdWrap processing
31 *
32 * @author Ingo Renner <ingo@typo3.org>
33 * @package TYPO3
34 * @subpackage t3lib
35 */
36 interface tslib_content_stdWrapHook {
37
38 /**
39 * Hook for modifying $content before core's stdWrap does anything
40 *
41 * @param string input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
42 * @param array TypoScript stdWrap properties
43 * @param tslib_cObj parent content object
44 * @return string further processed $content
45 */
46 public function stdWrapPreProcess($content, array $configuration, tslib_cObj &$parentObject);
47
48 /**
49 * Hook for modifying $content after core's stdWrap has processed setContentToCurrent, setCurrent, lang, data, field, current, cObject, numRows, filelist and/or preUserFunc
50 *
51 * @param string input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
52 * @param array TypoScript stdWrap properties
53 * @param tslib_cObj parent content object
54 * @return string further processed $content
55 */
56 public function stdWrapOverride($content, array $configuration, tslib_cObj &$parentObject);
57
58 /**
59 * Hook for modifying $content after core's stdWrap has processed override, preIfEmptyListNum, ifEmpty, ifBlank, listNum, trim and/or more (nested) stdWraps
60 *
61 * @param string input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
62 * @param array TypoScript "stdWrap properties".
63 * @param tslib_cObj parent content object
64 * @return string further processed $content
65 */
66 public function stdWrapProcess($content, array $configuration, tslib_cObj &$parentObject);
67
68 /**
69 * Hook for modifying $content after core's stdWrap has processed anything but debug
70 *
71 * @param string input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
72 * @param array TypoScript stdWrap properties
73 * @param tslib_cObj parent content object
74 * @return string further processed $content
75 */
76 public function stdWrapPostProcess($content, array $configuration, tslib_cObj &$parentObject);
77
78 }
79
80 ?>