[TASK] Create new processor registry
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Processing / FileProcessorInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Processing;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2014 Frans Saris <franssaris@gmail.com>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the text file GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29
30 use TYPO3\CMS\Core\Resource;
31
32 /**
33 * Interface for file processors. All classes capable of processing a file have to implement this interface.
34 */
35 interface FileProcessorInterface extends FileBasedConstraintInterface {
36
37 /**
38 * Returns TRUE if this processor can process the given configuration
39 *
40 * @param Resource\FileInterface $file
41 * @param ProcessingRequestInterface $processingRequest
42 * @return boolean
43 */
44 public function canProcess(Resource\FileInterface $file, ProcessingRequestInterface $processingRequest);
45
46 /**
47 * Processes the given request and returns the processing result
48 *
49 * @param Resource\FileInterface $file
50 * @param ProcessingRequestInterface $processingRequest
51 * @return Resource\ProcessedFile
52 */
53 public function process(Resource\FileInterface $file, ProcessingRequestInterface $processingRequest);
54 }