11.5/_css_view_helper_8php_source.html

<?php


declare(strict_types=1);


/*

 * 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\Asset;


use ‪TYPO3\CMS\Core\Page\AssetCollector;

use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;

use TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder;


class ‪CssViewHelper extends AbstractTagBasedViewHelper

{

    protected ‪$escapeOutput = false;


    protected ‪$escapeChildren = true;


    protected ‪$assetCollector;


    public function ‪injectAssetCollector(‪AssetCollector ‪$assetCollector): void

    {

        $this->assetCollector = ‪$assetCollector;

    }


    public function ‪initialize()

    {

        // Add a tag builder, that does not html encode values, because rendering with encoding happens in AssetRenderer

        $this->setTagBuilder(

            new class () extends TagBuilder {

                public function addAttribute($attributeName, $attributeValue, $escapeSpecialCharacters = false): void

                {

                    parent::addAttribute($attributeName, $attributeValue, false);

                }

            }

        );

        parent::initialize();

    }


    public function ‪initializeArguments(): void

    {

        parent::initializeArguments();

        $this->registerUniversalTagAttributes();

        $this->registerTagAttribute('as', 'string', 'Define the type of content being loaded (For rel="preload" or rel="prefetch" only).', false);

        $this->registerTagAttribute('crossorigin', 'string', 'Define how to handle crossorigin requests.', false);

        $this->registerTagAttribute('disabled', 'bool', 'Define whether or not the described stylesheet should be loaded and applied to the document.', false);

        $this->registerTagAttribute('href', 'string', 'Define the URL of the resource (absolute or relative).', false);

        $this->registerTagAttribute('hreflang', 'string', 'Define the language of the resource (Only to be used if \'href\' is set).', false);

        $this->registerTagAttribute('importance', 'string', 'Define the relative fetch priority of the resource.', false);

        $this->registerTagAttribute('integrity', 'string', 'Define base64-encoded cryptographic hash of the resource that allows browsers to verify what they fetch.', false);

        $this->registerTagAttribute('media', 'string', 'Define which media type the resources applies to.', false);

        $this->registerTagAttribute('referrerpolicy', 'string', 'Define which referrer is sent when fetching the resource.', false);

        $this->registerTagAttribute('rel', 'string', 'Define the relationship of the target object to the link object.', false);

        $this->registerTagAttribute('sizes', 'string', 'Define the icon size of the resource.', false);

        $this->registerTagAttribute('type', 'string', 'Define the MIME type (usually \'text/css\').', false);

        $this->registerTagAttribute('nonce', 'string', 'Define a cryptographic nonce (number used once) used to whitelist inline styles in a style-src Content-Security-Policy.', false);

        $this->registerArgument(

            'identifier',

            'string',

            'Use this identifier within templates to only inject your CSS once, even though it is added multiple times.',

            true

        );

        $this->registerArgument(

            'priority',

            'boolean',

            'Define whether the CSS should be included before other CSS. CSS will always be output in the <head> tag.',

            false,

            false

        );

    }


    public function ‪render(): string

    {

        $identifier = (string)$this->arguments['identifier'];

        $attributes = $this->tag->getAttributes();


        // boolean attributes shall output attr="attr" if set

        if ($attributes['disabled'] ?? false) {

            $attributes['disabled'] = 'disabled';

        }


        $file = $this->tag->getAttribute('href');

        unset($attributes['href']);

        $options = [

            'priority' => $this->arguments['priority'],

        ];

        if ($file !== null) {

            $this->assetCollector->addStyleSheet($identifier, $file, $attributes, $options);

        } else {

            $content = (string)$this->renderChildren();

            if ($content !== '') {

                $this->assetCollector->addInlineStyleSheet($identifier, $content, $attributes, $options);

            }

        }

        return '';

    }

}