TYPO3 API  SVNRelease
interface.tslib_content_stdwraphook.php
Go to the documentation of this file.
00001 <?php
00002 /***************************************************************
00003 *  Copyright notice
00004 *
00005 *  (c) 2007-2011 Ingo Renner <ingo@typo3.org>
00006 *  All rights reserved
00007 *
00008 *  This script is part of the TYPO3 project. The TYPO3 project is
00009 *  free software; you can redistribute it and/or modify
00010 *  it under the terms of the GNU General Public License as published by
00011 *  the Free Software Foundation; either version 2 of the License, or
00012 *  (at your option) any later version.
00013 *
00014 *  The GNU General Public License can be found at
00015 *  http://www.gnu.org/copyleft/gpl.html.
00016 *  A copy is found in the textfile GPL.txt and important notices to the license
00017 *  from the author is found in LICENSE.txt distributed with these scripts.
00018 *
00019 *
00020 *  This script is distributed in the hope that it will be useful,
00021 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00022 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00023 *  GNU General Public License for more details.
00024 *
00025 *  This copyright notice MUST APPEAR in all copies of the script!
00026 ***************************************************************/
00027 
00028 
00029 /**
00030  * interface for classes which hook into tslib_content and do additional stdWrap processing
00031  *
00032  * @author  Ingo Renner <ingo@typo3.org>
00033  * @package TYPO3
00034  * @subpackage t3lib
00035  */
00036 interface tslib_content_stdWrapHook {
00037 
00038     /**
00039      * Hook for modifying $content before core's stdWrap does anything
00040      *
00041      * @param   string      input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
00042      * @param   array       TypoScript stdWrap properties
00043      * @param   tslib_cObj  parent content object
00044      * @return  string      further processed $content
00045      */
00046     public function stdWrapPreProcess($content, array $configuration, tslib_cObj &$parentObject);
00047 
00048     /**
00049      * Hook for modifying $content after core's stdWrap has processed setContentToCurrent, setCurrent, lang, data, field, current, cObject, numRows, filelist and/or preUserFunc
00050      *
00051      * @param   string      input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
00052      * @param   array       TypoScript stdWrap properties
00053      * @param   tslib_cObj  parent content object
00054      * @return  string      further processed $content
00055      */
00056     public function stdWrapOverride($content, array $configuration, tslib_cObj &$parentObject);
00057 
00058     /**
00059      * Hook for modifying $content after core's stdWrap has processed override, preIfEmptyListNum, ifEmpty, ifBlank, listNum, trim and/or more (nested) stdWraps
00060      *
00061      * @param   string      input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
00062      * @param   array       TypoScript "stdWrap properties".
00063      * @param   tslib_cObj  parent content object
00064      * @return  string      further processed $content
00065      */
00066     public function stdWrapProcess($content, array $configuration, tslib_cObj &$parentObject);
00067 
00068     /**
00069      * Hook for modifying $content after core's stdWrap has processed anything but debug
00070      *
00071      * @param   string      input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
00072      * @param   array       TypoScript stdWrap properties
00073      * @param   tslib_cObj  parent content object
00074      * @return  string      further processed $content
00075      */
00076     public function stdWrapPostProcess($content, array $configuration, tslib_cObj &$parentObject);
00077 
00078 }
00079 
00080 ?>