[TASK] Priority is not execution order in for Extractors
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Index / ExtractorInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Index;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Steffen Ritter <steffen.ritter@typo3.org>
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 * An Interface for MetaData extractors the FAL Indexer uses
34 */
35 interface ExtractorInterface {
36
37 /**
38 * Returns an array of supported file types;
39 * An empty array indicates all filetypes
40 *
41 * @return array
42 */
43 public function getFileTypeRestrictions();
44
45
46 /**
47 * Get all supported DriverClasses
48 *
49 * Since some extractors may only work for local files, and other extractors
50 * are especially made for grabbing data from remote.
51 *
52 * Returns array of string with driver names of Drivers which are supported,
53 * If the driver did not register a name, it's the classname.
54 * empty array indicates no restrictions
55 *
56 * @return array
57 */
58 public function getDriverRestrictions();
59
60 /**
61 * Returns the data priority of the extraction Service.
62 * Defines the precedence of Data if several extractors
63 * extracted the same property.
64 *
65 * Should be between 1 and 100, 100 is more important than 1
66 *
67 * @return integer
68 */
69 public function getPriority();
70
71 /**
72 * Returns the execution priority of the extraction Service
73 * Should be between 1 and 100, 100 means runs as first service, 1 runs at last service
74 *
75 * @return integer
76 */
77 public function getExecutionPriority();
78
79 /**
80 * Checks if the given file can be processed by this Extractor
81 *
82 * @param Resource\File $file
83 * @return boolean
84 */
85 public function canProcess(Resource\File $file);
86
87 /**
88 * The actual processing TASK
89 *
90 * Should return an array with database properties for sys_file_metadata to write
91 *
92 * @param Resource\File $file
93 * @param array $previousExtractedData optional, contains the array of already extracted data
94 * @return array
95 */
96 public function extractMetaData(Resource\File $file, array $previousExtractedData = array());
97
98
99 }