[TASK] Create new processor registry
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Processing / FileBasedConstraintInterface.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 /**
31 * Base Interface for file processing task like Extractor and FileProcessor that
32 * can be constrained to certain Drivers or FileTypes.
33 */
34 interface FileBasedConstraintInterface {
35
36 /**
37 * Returns an array of supported file types
38 * An empty array indicates all file types
39 *
40 * @return array
41 */
42 public function getFileTypeRestrictions();
43
44 /**
45 * Get all supported DriverTypes
46 *
47 * Since some processors may only work for local files, and other
48 * are especially made for processing files from remote.
49 *
50 * Returns array of strings with driver names of Drivers which are supported,
51 * If the driver did not register a name, it's the class name.
52 * empty array indicates no restrictions
53 *
54 * @return array
55 */
56 public function getDriverRestrictions();
57
58 /**
59 * Returns the data priority of the processing Service.
60 * Defines the precedence if several processors
61 * can handle the same file.
62 *
63 * Should be between 1 and 100, 100 is more important than 1
64 *
65 * @return integer
66 */
67 public function getPriority();
68
69 }