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