typo3/sysext/frontend/Classes/ContentObject/DataProcessorInterface.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 data processor classes processing data from
  19  * ContentObjectRenderer, used e.g. with the FLUIDTEMPLATE content object
  20  */
  21 interface DataProcessorInterface {
  22
  23         /**
  24          * Process content object data
  25          *
  26          * @param ContentObjectRenderer $cObj The data of the content element or page
  27          * @param array $processorConfiguration The configuration of this processor
  28          * @param array $contentObjectConfiguration The configuration of Content Object
  29          * @param array $processedData Key/value store of processed data (e.g. to be passed to a Fluid View)
  30          * @return array the processed data as key/value store
  31          */
  32         public function process(
  33                 ContentObjectRenderer $cObj,
  34                 array $contentObjectConfiguration,
  35                 array $processorConfiguration,
  36                 array $processedData
  37         );
  38 }