417d166d073119185d14366abbe5b5a91cf9fc26
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Processing / ImagePreviewTask.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Processing;
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 use \TYPO3\CMS\Core\Resource;
18
19 /**
20 * A task for generating an image preview.
21 */
22 class ImagePreviewTask extends AbstractGraphicalTask {
23
24 /**
25 * @var string
26 */
27 protected $type = 'Image';
28
29 /**
30 * @var string
31 */
32 protected $name = 'Preview';
33
34 /**
35 * Returns the target filename for this task.
36 *
37 * @return string
38 */
39 public function getTargetFileName() {
40 return 'preview_' . parent::getTargetFilename();
41 }
42
43 /**
44 * Checks if the given configuration is sensible for this task, i.e. if all required parameters
45 * are given, within the boundaries and don't conflict with each other.
46 *
47 * @param array $configuration
48 * @return bool
49 */
50 protected function isValidConfiguration(array $configuration) {
51 /**
52 * Checks to perform:
53 * - width and/or height given, integer values?
54 */
55 }
56
57 /**
58 * Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
59 *
60 * Note: This does not indicate if the concrete ProcessedFile attached to this task has to be (re)processed.
61 * This check is done in ProcessedFile::isOutdated().
62 * @todo isOutdated()/needsReprocessing()?
63 *
64 * @return bool
65 */
66 public function fileNeedsProcessing() {
67 // @todo Implement fileNeedsProcessing() method.
68
69 /**
70 * Checks to perform:
71 * - width/height smaller than image, keeping aspect ratio?
72 */
73 }
74
75 }