JsonView.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
 
namespace ‪TYPO3\CMS\Extbase\Mvc\View;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Extbase\Mvc\Web\Response as WebResponse;
use ‪TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use ‪TYPO3\CMS\Extbase\Reflection\ObjectAccess;
use ‪TYPO3\CMS\Extbase\Reflection\ReflectionService;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
class ‪JsonView extends ‪AbstractView
{
    const ‪EXPOSE_CLASSNAME_FULLY_QUALIFIED = 1;
 
    const ‪EXPOSE_CLASSNAME_UNQUALIFIED = 2;
 
    protected ‪$reflectionService;
 
    protected ‪$controllerContext;
 
    protected ‪$variablesToRender = ['value'];
 
    protected ‪$configuration = [];
 
    protected ‪$persistenceManager;
 
    public function ‪injectPersistenceManager(‪PersistenceManagerInterface ‪$persistenceManager): void
    {
        $this->persistenceManager = ‪$persistenceManager;
    }
 
    public function ‪injectReflectionService(‪ReflectionService ‪$reflectionService): void
    {
        $this->reflectionService = ‪$reflectionService;
    }
 
    public function ‪setVariablesToRender(array ‪$variablesToRender): void
    {
        $this->variablesToRender = ‪$variablesToRender;
    }
 
    public function ‪setConfiguration(array ‪$configuration): void
    {
        $this->configuration = ‪$configuration;
    }
 
    public function ‪render(): string
    {
        $response = $this->controllerContext->getResponse();
        if ($response instanceof WebResponse) {
            // @todo Ticket: #63643 This should be solved differently once request/response model is available for TSFE.
            if (!empty(‪$GLOBALS['TSFE']) && ‪$GLOBALS['TSFE'] instanceof TypoScriptFrontendController) {
                $typoScriptFrontendController = ‪$GLOBALS['TSFE'];
                if (empty($typoScriptFrontendController->config['config']['disableCharsetHeader'])) {
                    // If the charset header is *not* disabled in configuration,
                    // TypoScriptFrontendController will send the header later with the Content-Type which we set here.
                    $typoScriptFrontendController->setContentType('application/json');
                } else {
                    // Although the charset header is disabled in configuration, we *must* send a Content-Type header here.
                    // Content-Type headers optionally carry charset information at the same time.
                    // Since we have the information about the charset, there is no reason to not include the charset information although disabled in TypoScript.
                    $response->setHeader('Content-Type', 'application/json; charset=' . trim($typoScriptFrontendController->metaCharset));
                }
            } else {
                $response->setHeader('Content-Type', 'application/json');
            }
        }
        $propertiesToRender = $this->‪renderArray();
        return json_encode($propertiesToRender, JSON_UNESCAPED_UNICODE);
    }
 
    protected function ‪renderArray()
    {
        if (count($this->variablesToRender) === 1) {
            $variableName = current($this->variablesToRender);
            $valueToRender = $this->variables[$variableName] ?? null;
            ‪$configuration = $this->configuration[$variableName] ?? [];
        } else {
            $valueToRender = [];
            foreach ($this->variablesToRender as $variableName) {
                $valueToRender[$variableName] = $this->variables[$variableName] ?? null;
            }
            ‪$configuration = ‪$this->configuration;
        }
        return $this->‪transformValue($valueToRender, ‪$configuration);
    }
 
    protected function ‪transformValue($value, array ‪$configuration)
    {
        if (is_array($value) || $value instanceof \ArrayAccess) {
            $array = [];
            foreach ($value as $key => $element) {
                if (isset(‪$configuration['_descendAll']) && is_array(‪$configuration['_descendAll'])) {
                    $array[$key] = $this->‪transformValue($element, ‪$configuration['_descendAll']);
                } else {
                    if (isset(‪$configuration['_only']) && is_array(‪$configuration['_only']) && !in_array($key, ‪$configuration['_only'], true)) {
                        continue;
                    }
                    if (isset(‪$configuration['_exclude']) && is_array(‪$configuration['_exclude']) && in_array($key, ‪$configuration['_exclude'], true)) {
                        continue;
                    }
                    $array[$key] = $this->‪transformValue($element, ‪$configuration[$key] ?? []);
                }
            }
            return $array;
        }
        if (is_object($value)) {
            return $this->‪transformObject($value, ‪$configuration);
        }
        return $value;
    }
 
    protected function ‪transformObject(object $object, array ‪$configuration)
    {
        if ($object instanceof \DateTime) {
            return $object->format(\DateTime::ATOM);
        }
        $propertyNames = ‪ObjectAccess::getGettablePropertyNames($object);
 
        $propertiesToRender = [];
        foreach ($propertyNames as $propertyName) {
            if (isset(‪$configuration['_only']) && is_array(‪$configuration['_only']) && !in_array($propertyName, ‪$configuration['_only'], true)) {
                continue;
            }
            if (isset(‪$configuration['_exclude']) && is_array(‪$configuration['_exclude']) && in_array($propertyName, ‪$configuration['_exclude'], true)) {
                continue;
            }
 
            $propertyValue = ‪ObjectAccess::getProperty($object, $propertyName);
 
            if (!is_array($propertyValue) && !is_object($propertyValue)) {
                $propertiesToRender[$propertyName] = $propertyValue;
            } elseif (isset(‪$configuration['_descend']) && array_key_exists($propertyName, ‪$configuration['_descend'])) {
                $propertiesToRender[$propertyName] = $this->‪transformValue($propertyValue, ‪$configuration['_descend'][$propertyName]);
            }
        }
        if (isset(‪$configuration['_exposeObjectIdentifier']) && ‪$configuration['_exposeObjectIdentifier'] === true) {
            if (isset(‪$configuration['_exposedObjectIdentifierKey']) && strlen(‪$configuration['_exposedObjectIdentifierKey']) > 0) {
                $identityKey = ‪$configuration['_exposedObjectIdentifierKey'];
            } else {
                $identityKey = '__identity';
            }
            $propertiesToRender[$identityKey] = $this->persistenceManager->getIdentifierByObject($object);
        }
        if (isset(‪$configuration['_exposeClassName']) && (‪$configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_FULLY_QUALIFIED || ‪$configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_UNQUALIFIED)) {
            $className = get_class($object);
            $classNameParts = explode('\\', $className);
            $propertiesToRender['__class'] = (‪$configuration['_exposeClassName'] === self::EXPOSE_CLASSNAME_FULLY_QUALIFIED ? $className : array_pop($classNameParts));
        }
 
        return $propertiesToRender;
    }
}