ImageViewHelper::initializeArguments() - Code Metrics - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

ImageViewHelper::initializeArguments() A
last analyzed 2021-07-26 13:17 UTC

↳ Parent: ImageViewHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines	25
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	21
c	0
b	0
f	0
dl	0
loc	25
rs	9.584
cc	1
nc	1
nop	0

<?php

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Fluid\ViewHelpers;

use TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;
use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Service\ImageService;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;

/**
 * Resizes a given image (if required) and renders the respective img tag.
 *
 * External URLs are not processed. Only a given width and height will be set on the tag.
 *
 * Examples
 * ========
 *
 * Default
 * -------
 *
 * ::
 *
 *    <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
 *
 * Output in frontend::
 *
 *    <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
 *
 * or in backend::
 *
 *    <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
 *
 * Image Object
 * ------------
 *
 * ::
 *
 *    <f:image image="{imageObject}" />
 *
 * Output::
 *
 *    <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
 *
 * Inline notation
 * ---------------
 *
 * ::
 *
 *    {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
 *
 * Output::
 *
 *    <img alt="alt text" src="../typo3temp/assets/images/f13d79a526.png" width="40" height="38" />
 *
 * Depending on your TYPO3s encryption key.
 *
 * Other resource type (e.g. PDF)
 * ------------------------------
 *
 * ::
 *
 *    <f:image src="fileadmin/user_upload/example.pdf" alt="foo" />
 *
 * If your graphics processing library is set up correctly then it will output a thumbnail of the first page of your PDF document:
 * ``<img src="fileadmin/_processed_/1/2/csm_example_aabbcc112233.gif" width="200" height="284" alt="foo">``
 *
 * Non-existent image
 * ------------------
 *
 * ::
 *
 *    <f:image src="NonExistingImage.png" alt="foo" />
 *
 * ``Could not get image resource for "NonExistingImage.png".``
 */
class ImageViewHelper extends AbstractTagBasedViewHelper
{
    /**
     * @var string
     */
    protected $tagName = 'img';

    /**
     * Initialize arguments.
     */
    public function initializeArguments()
    {
        parent::initializeArguments();
        $this->registerUniversalTagAttributes();
        $this->registerTagAttribute('alt', 'string', 'Specifies an alternate text for an image', false);
        $this->registerTagAttribute('ismap', 'string', 'Specifies an image as a server-side image-map. Rarely used. Look at usemap instead', false);
        $this->registerTagAttribute('longdesc', 'string', 'Specifies the URL to a document that contains a long description of an image', false);
        $this->registerTagAttribute('usemap', 'string', 'Specifies an image as a client-side image-map', false);
        $this->registerTagAttribute('loading', 'string', 'Native lazy-loading for images property. Can be "lazy", "eager" or "auto"', false);
        $this->registerTagAttribute('decoding', 'string', 'Provides an image decoding hint to the browser. Can be "sync", "async" or "auto"', false);

        $this->registerArgument('src', 'string', 'a path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead', false, '');
        $this->registerArgument('treatIdAsReference', 'bool', 'given src argument is a sys_file_reference record', false, false);
        $this->registerArgument('image', 'object', 'a FAL object');
        $this->registerArgument('crop', 'string|bool', 'overrule cropping of image (setting to FALSE disables the cropping set in FileReference)');
        $this->registerArgument('cropVariant', 'string', 'select a cropping variant, in case multiple croppings have been specified or stored in FileReference', false, 'default');
        $this->registerArgument('fileExtension', 'string', 'Custom file extension to use');

        $this->registerArgument('width', 'string', 'width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.');
        $this->registerArgument('height', 'string', 'height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.');
        $this->registerArgument('minWidth', 'int', 'minimum width of the image');
        $this->registerArgument('minHeight', 'int', 'minimum height of the image');
        $this->registerArgument('maxWidth', 'int', 'maximum width of the image');
        $this->registerArgument('maxHeight', 'int', 'maximum height of the image');
        $this->registerArgument('absolute', 'bool', 'Force absolute URL', false, false);
    }

    /**
     * Resizes a given image (if required) and renders the respective img tag
     *
     * @see https://docs.typo3.org/typo3cms/TyposcriptReference/ContentObjects/Image/
     *
     * @throws Exception
     * @return string Rendered tag
     */
    public function render()
    {
        $src = (string)$this->arguments['src'];
        if (($src === '' && $this->arguments['image'] === null) || ($src !== '' && $this->arguments['image'] !== null)) {
            throw new Exception('You must either specify a string src or a File object.', 1382284106);
        }

        if ((string)$this->arguments['fileExtension'] && !GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], (string)$this->arguments['fileExtension'])) {
            throw new Exception('The extension ' . $this->arguments['fileExtension'] . ' is not specified in $GLOBALS[\'TYPO3_CONF_VARS\'][\'GFX\'][\'imagefile_ext\'] as a valid image file extension and can not be processed.', 1618989190);
        }

        // A URL was given as src, this is kept as is, and we can only scale
        if ($src !== '' && preg_match('/^(https?:)?\/\//', $src)) {
            $this->tag->addAttribute('src', $src);
            if (isset($this->arguments['width'])) {
                $this->tag->addAttribute('width', $this->arguments['width']);
            }
            if (isset($this->arguments['height'])) {
                $this->tag->addAttribute('height', $this->arguments['height']);
            }
        } else {
            try {
                $imageService = $this->getImageService();
                $image = $imageService->getImage($src, $this->arguments['image'], (bool)$this->arguments['treatIdAsReference']);
                $cropString = $this->arguments['crop'];
                if ($cropString === null && $image->hasProperty('crop') && $image->getProperty('crop')) {
                    $cropString = $image->getProperty('crop');
                }
                $cropVariantCollection = CropVariantCollection::create((string)$cropString);
                $cropVariant = $this->arguments['cropVariant'] ?: 'default';
                $cropArea = $cropVariantCollection->getCropArea($cropVariant);
                $processingInstructions = [
                    'width' => $this->arguments['width'],
                    'height' => $this->arguments['height'],
                    'minWidth' => $this->arguments['minWidth'],
                    'minHeight' => $this->arguments['minHeight'],
                    'maxWidth' => $this->arguments['maxWidth'],
                    'maxHeight' => $this->arguments['maxHeight'],
                    'crop' => $cropArea->isEmpty() ? null : $cropArea->makeAbsoluteBasedOnFile($image),
                ];
                if (!empty($this->arguments['fileExtension'] ?? '')) {
                    $processingInstructions['fileExtension'] = $this->arguments['fileExtension'];
                }
                $processedImage = $imageService->applyProcessingInstructions($image, $processingInstructions);
                $imageUri = $imageService->getImageUri($processedImage, $this->arguments['absolute']);

                if (!$this->tag->hasAttribute('data-focus-area')) {
                    $focusArea = $cropVariantCollection->getFocusArea($cropVariant);
                    if (!$focusArea->isEmpty()) {
                        $this->tag->addAttribute('data-focus-area', $focusArea->makeAbsoluteBasedOnFile($image));
                    }
                }
                $this->tag->addAttribute('src', $imageUri);
                $this->tag->addAttribute('width', $processedImage->getProperty('width'));
                $this->tag->addAttribute('height', $processedImage->getProperty('height'));

                // The alt-attribute is mandatory to have valid html-code, therefore add it even if it is empty
                if (empty($this->arguments['alt'])) {
                    $this->tag->addAttribute('alt', $image->hasProperty('alternative') ? $image->getProperty('alternative') : '');
                }
                // Add title-attribute from property if not already set and the property is not an empty string
                $title = (string)($image->hasProperty('title') ? $image->getProperty('title') : '');
                if (empty($this->arguments['title']) && $title !== '') {
                    $this->tag->addAttribute('title', $title);
                }
            } catch (ResourceDoesNotExistException $e) {
                // thrown if file does not exist
                throw new Exception($e->getMessage(), 1509741911, $e);
            } catch (\UnexpectedValueException $e) {
                // thrown if a file has been replaced with a folder
                throw new Exception($e->getMessage(), 1509741912, $e);
            } catch (\RuntimeException $e) {
                // RuntimeException thrown if a file is outside of a storage
                throw new Exception($e->getMessage(), 1509741913, $e);
            } catch (\InvalidArgumentException $e) {
                // thrown if file storage does not exist
                throw new Exception($e->getMessage(), 1509741914, $e);
            }
        }
        return $this->tag->render();
    }

    protected function getImageService(): ImageService
    {
        return GeneralUtility::makeInstance(ImageService::class);
    }
}


1			<?php
2
3			/*
4			* This file is part of the TYPO3 CMS project.
5			*
6			* It is free software; you can redistribute it and/or modify it under
7			* the terms of the GNU General Public License, either version 2
8			* of the License, or any later version.
9			*
10			* For the full copyright and license information, please read the
11			* LICENSE.txt file that was distributed with this source code.
12			*
13			* The TYPO3 project - inspiring people to share!
14			*/
15
16			namespace TYPO3\CMS\Fluid\ViewHelpers;
17
18			use TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;
19			use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
20			use TYPO3\CMS\Core\Utility\GeneralUtility;
21			use TYPO3\CMS\Extbase\Service\ImageService;
22			use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
23			use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
24
25			/**
26			* Resizes a given image (if required) and renders the respective img tag.
27			*
28			* External URLs are not processed. Only a given width and height will be set on the tag.
29			*
30			* Examples
31			* ========
32			*
33			* Default
34			* -------
35			*
36			* ::
37			*
38			* <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
39			*
40			* Output in frontend::
41			*
42			* <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
43			*
44			* or in backend::
45			*
46			* <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
47			*
48			* Image Object
49			* ------------
50			*
51			* ::
52			*
53			* <f:image image="{imageObject}" />
54			*
55			* Output::
56			*
57			* <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
58			*
59			* Inline notation
60			* ---------------
61			*
62			* ::
63			*
64			* {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
65			*
66			* Output::
67			*
68			* <img alt="alt text" src="../typo3temp/assets/images/f13d79a526.png" width="40" height="38" />
69			*
70			* Depending on your TYPO3s encryption key.
71			*
72			* Other resource type (e.g. PDF)
73			* ------------------------------
74			*
75			* ::
76			*
77			* <f:image src="fileadmin/user_upload/example.pdf" alt="foo" />
78			*
79			* If your graphics processing library is set up correctly then it will output a thumbnail of the first page of your PDF document:
80			* ``<img src="fileadmin/_processed_/1/2/csm_example_aabbcc112233.gif" width="200" height="284" alt="foo">``
81			*
82			* Non-existent image
83			* ------------------
84			*
85			* ::
86			*
87			* <f:image src="NonExistingImage.png" alt="foo" />
88			*
89			* ``Could not get image resource for "NonExistingImage.png".``
90			*/
91			class ImageViewHelper extends AbstractTagBasedViewHelper
92			{
93			/**
94			* @var string
95			*/
96			protected $tagName = 'img';
97
98			/**
99			* Initialize arguments.
100			*/
101			public function initializeArguments()
102			{
103			parent::initializeArguments();
104			$this->registerUniversalTagAttributes();
105			$this->registerTagAttribute('alt', 'string', 'Specifies an alternate text for an image', false);
106			$this->registerTagAttribute('ismap', 'string', 'Specifies an image as a server-side image-map. Rarely used. Look at usemap instead', false);
107			$this->registerTagAttribute('longdesc', 'string', 'Specifies the URL to a document that contains a long description of an image', false);
108			$this->registerTagAttribute('usemap', 'string', 'Specifies an image as a client-side image-map', false);
109			$this->registerTagAttribute('loading', 'string', 'Native lazy-loading for images property. Can be "lazy", "eager" or "auto"', false);
110			$this->registerTagAttribute('decoding', 'string', 'Provides an image decoding hint to the browser. Can be "sync", "async" or "auto"', false);
111
112			$this->registerArgument('src', 'string', 'a path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead', false, '');
113			$this->registerArgument('treatIdAsReference', 'bool', 'given src argument is a sys_file_reference record', false, false);
114			$this->registerArgument('image', 'object', 'a FAL object');
115			$this->registerArgument('crop', 'string\|bool', 'overrule cropping of image (setting to FALSE disables the cropping set in FileReference)');
116			$this->registerArgument('cropVariant', 'string', 'select a cropping variant, in case multiple croppings have been specified or stored in FileReference', false, 'default');
117			$this->registerArgument('fileExtension', 'string', 'Custom file extension to use');
118
119			$this->registerArgument('width', 'string', 'width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.');
120			$this->registerArgument('height', 'string', 'height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.');
121			$this->registerArgument('minWidth', 'int', 'minimum width of the image');
122			$this->registerArgument('minHeight', 'int', 'minimum height of the image');
123			$this->registerArgument('maxWidth', 'int', 'maximum width of the image');
124			$this->registerArgument('maxHeight', 'int', 'maximum height of the image');
125			$this->registerArgument('absolute', 'bool', 'Force absolute URL', false, false);
126			}
127
128			/**
129			* Resizes a given image (if required) and renders the respective img tag
130			*
131			* @see https://docs.typo3.org/typo3cms/TyposcriptReference/ContentObjects/Image/
132			*
133			* @throws Exception
134			* @return string Rendered tag
135			*/
136			public function render()
137			{
138			$src = (string)$this->arguments['src'];
139			if (($src === '' && $this->arguments['image'] === null) \|\| ($src !== '' && $this->arguments['image'] !== null)) {
140			throw new Exception('You must either specify a string src or a File object.', 1382284106);
141			}
142
143			if ((string)$this->arguments['fileExtension'] && !GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], (string)$this->arguments['fileExtension'])) {
144			throw new Exception('The extension ' . $this->arguments['fileExtension'] . ' is not specified in $GLOBALS[\'TYPO3_CONF_VARS\'][\'GFX\'][\'imagefile_ext\'] as a valid image file extension and can not be processed.', 1618989190);
145			}
146
147			// A URL was given as src, this is kept as is, and we can only scale
148			if ($src !== '' && preg_match('/^(https?:)?\/\//', $src)) {
149			$this->tag->addAttribute('src', $src);
150			if (isset($this->arguments['width'])) {
151			$this->tag->addAttribute('width', $this->arguments['width']);
152			}
153			if (isset($this->arguments['height'])) {
154			$this->tag->addAttribute('height', $this->arguments['height']);
155			}
156			} else {
157			try {
158			$imageService = $this->getImageService();
159			$image = $imageService->getImage($src, $this->arguments['image'], (bool)$this->arguments['treatIdAsReference']);
160			$cropString = $this->arguments['crop'];
161			if ($cropString === null && $image->hasProperty('crop') && $image->getProperty('crop')) {
162			$cropString = $image->getProperty('crop');
163			}
164			$cropVariantCollection = CropVariantCollection::create((string)$cropString);
165			$cropVariant = $this->arguments['cropVariant'] ?: 'default';
166			$cropArea = $cropVariantCollection->getCropArea($cropVariant);
167			$processingInstructions = [
168			'width' => $this->arguments['width'],
169			'height' => $this->arguments['height'],
170			'minWidth' => $this->arguments['minWidth'],
171			'minHeight' => $this->arguments['minHeight'],
172			'maxWidth' => $this->arguments['maxWidth'],
173			'maxHeight' => $this->arguments['maxHeight'],
174			'crop' => $cropArea->isEmpty() ? null : $cropArea->makeAbsoluteBasedOnFile($image),
175			];
176			if (!empty($this->arguments['fileExtension'] ?? '')) {
177			$processingInstructions['fileExtension'] = $this->arguments['fileExtension'];
178			}
179			$processedImage = $imageService->applyProcessingInstructions($image, $processingInstructions);
180			$imageUri = $imageService->getImageUri($processedImage, $this->arguments['absolute']);
181
182			if (!$this->tag->hasAttribute('data-focus-area')) {
183			$focusArea = $cropVariantCollection->getFocusArea($cropVariant);
184			if (!$focusArea->isEmpty()) {
185			$this->tag->addAttribute('data-focus-area', $focusArea->makeAbsoluteBasedOnFile($image));
186			}
187			}
188			$this->tag->addAttribute('src', $imageUri);
189			$this->tag->addAttribute('width', $processedImage->getProperty('width'));
190			$this->tag->addAttribute('height', $processedImage->getProperty('height'));
191
192			// The alt-attribute is mandatory to have valid html-code, therefore add it even if it is empty
193			if (empty($this->arguments['alt'])) {
194			$this->tag->addAttribute('alt', $image->hasProperty('alternative') ? $image->getProperty('alternative') : '');
195			}
196			// Add title-attribute from property if not already set and the property is not an empty string
197			$title = (string)($image->hasProperty('title') ? $image->getProperty('title') : '');
198			if (empty($this->arguments['title']) && $title !== '') {
199			$this->tag->addAttribute('title', $title);
200			}
201			} catch (ResourceDoesNotExistException $e) {
202			// thrown if file does not exist
203			throw new Exception($e->getMessage(), 1509741911, $e);
204			} catch (\UnexpectedValueException $e) {
205			// thrown if a file has been replaced with a folder
206			throw new Exception($e->getMessage(), 1509741912, $e);
207			} catch (\RuntimeException $e) {
208			// RuntimeException thrown if a file is outside of a storage
209			throw new Exception($e->getMessage(), 1509741913, $e);
210			} catch (\InvalidArgumentException $e) {
211			// thrown if file storage does not exist
212			throw new Exception($e->getMessage(), 1509741914, $e);
213			}
214			}
215			return $this->tag->render();
216			}
217
218			protected function getImageService(): ImageService
219			{
220			return GeneralUtility::makeInstance(ImageService::class);
221			}
222			}
223

TYPO3 / TYPO3.CMS

ImageViewHelper::initializeArguments() A last analyzed 2021-07-26 13:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ImageViewHelper::initializeArguments() A
last analyzed 2021-07-26 13:17 UTC