GenericMetaTagManager.php

Go to the documentation of this file.

<?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\Core\MetaTag;
 
final class ‪GenericMetaTagManager implements ‪MetaTagManagerInterface
{
    protected ‪$subPropertySeparator = ':';
 
    protected ‪$properties = [];
 
    public function ‪addProperty(string $property, string $content, array $subProperties = [], bool $replace = false, string $type = 'name')
    {
        $property = strtolower($property);
        $type = strtolower($type) ?: 'name';
 
        if ($replace) {
            $this->‪removeProperty($property, $type);
        }
 
        $this->properties[$property][$type][] = [
            'content' => $content,
            'subProperties' => $subProperties,
        ];
    }
 
    public function ‪getProperty(string $property, string $type = 'name'): array
    {
        $property = strtolower($property);
        $type = strtolower($type) ?: 'name';
 
        if (!empty($this->properties[$property][$type])) {
            return $this->properties[$property][$type];
        }
        return [];
    }
 
    public function ‪getAllHandledProperties(): array
    {
        return [];
    }
 
    public function ‪renderAllProperties(): string
    {
        $metatags = [];
        foreach (array_keys($this->properties) as $property) {
            $metatags[] = $this->‪renderProperty($property);
        }
 
        return implode(PHP_EOL, $metatags);
    }
 
    public function ‪renderProperty(string $property): string
    {
        $property = strtolower($property);
 
        $metaTags = [];
        foreach ((array)$this->properties[$property] as $type => $propertyItems) {
            foreach ($propertyItems as $propertyItem) {
                $metaTags[] = '<meta ' .
                    htmlspecialchars($type) . '="' . htmlspecialchars($property) . '" ' .
                    'content="' . htmlspecialchars($propertyItem['content']) . '" />';
 
                if (!count($propertyItem['subProperties'])) {
                    continue;
                }
                foreach ($propertyItem['subProperties'] as $subProperty => $value) {
                    $metaTags[] = '<meta ' .
                        htmlspecialchars($type) . '="' . htmlspecialchars($property . $this->subPropertySeparator . $subProperty) . '" ' .
                        'content="' . htmlspecialchars((string)$value) . '" />';
                }
            }
        }
 
        return implode(PHP_EOL, $metaTags);
    }
 
    public function ‪removeProperty(string $property, string $type = '')
    {
        $property = strtolower($property);
        $type = strtolower($type);
 
        if (!empty($type)) {
            unset($this->properties[$property][$type]);
        } else {
            unset($this->properties[$property]);
        }
    }
 
    public function ‪removeAllProperties()
    {
        $this->properties = [];
    }
 
    public function ‪canHandleProperty(string $property): bool
    {
        return true;
    }
 
    public function ‪getState(): array
    {
        return [
            'properties' => ‪$this->properties,
        ];
    }
 
    public function ‪updateState(array $state): void
    {
        $this->properties = $state['properties'] ?? [];
    }
}