JsonView.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\Extbase\Mvc\View;
 
use ‪TYPO3\CMS\Extbase\Persistence\ObjectStorage;
use ‪TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use ‪TYPO3\CMS\Extbase\Reflection\ObjectAccess;
use TYPO3Fluid\Fluid\View\AbstractView;
 
class ‪JsonView extends AbstractView
{
    public const ‪EXPOSE_CLASSNAME_FULLY_QUALIFIED = 1;
 
    public const ‪EXPOSE_CLASSNAME_UNQUALIFIED = 2;
 
    protected ‪$variablesToRender = ['value'];
 
    protected ‪$currentVariable = '';
 
    protected ‪$configuration = [];
 
    protected ‪$persistenceManager;
 
    protected ‪$variables = [];
 
    public function ‪injectPersistenceManager(‪PersistenceManagerInterface ‪$persistenceManager): void
    {
        $this->persistenceManager = ‪$persistenceManager;
    }
 
    public function ‪assign($key, $value)
    {
        $this->variables[$key] = $value;
        return $this;
    }
 
    public function ‪assignMultiple(array $values)
    {
        foreach ($values as $key => $value) {
            $this->‪assign($key, $value);
        }
        return $this;
    }
 
    public function ‪setVariablesToRender(array ‪$variablesToRender): void
    {
        $this->variablesToRender = ‪$variablesToRender;
    }
 
    public function ‪setConfiguration(array ‪$configuration): void
    {
        $this->configuration = ‪$configuration;
    }
 
    public function ‪renderSection($sectionName, array ‪$variables = [], $ignoreUnknown = false)
    {
        // No-op: renderSection does not make sense for this view
        return '';
    }
 
    public function ‪renderPartial($partialName, $sectionName, array ‪$variables, $ignoreUnknown = false)
    {
        // No-op: renderPartial does not make sense for this view
        return '';
    }
 
    public function ‪render(): string
    {
        $propertiesToRender = $this->‪renderArray();
        return json_encode($propertiesToRender, JSON_UNESCAPED_UNICODE);
    }
 
    protected function ‪renderArray()
    {
        if (count($this->variablesToRender) === 1) {
            $firstLevel = false;
            $variableName = current($this->variablesToRender);
            $this->currentVariable = $variableName;
            $valueToRender = $this->variables[$variableName] ?? null;
            ‪$configuration = $this->configuration[$variableName] ?? [];
        } else {
            $firstLevel = true;
            $valueToRender = [];
            foreach ($this->variablesToRender as $variableName) {
                $valueToRender[$variableName] = $this->variables[$variableName] ?? null;
            }
            ‪$configuration = ‪$this->configuration;
        }
        return $this->‪transformValue($valueToRender, ‪$configuration, $firstLevel);
    }
 
    protected function ‪transformValue($value, array ‪$configuration, $firstLevel = false)
    {
        // ObjectStorage returns $key as string, which causes the resulting JSON to be an object instead of the expected array
        if ($value instanceof ObjectStorage) {
            $value = $value->toArray();
        }
        if (is_array($value) || $value instanceof \ArrayAccess) {
            $array = [];
            foreach ($value as $key => $element) {
                if ($firstLevel) {
                    $this->currentVariable = $key;
                }
                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 \DateTimeInterface) {
            return $object->format(\DateTimeInterface::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]);
            } elseif (isset(‪$configuration['_recursive']) && in_array($propertyName, ‪$configuration['_recursive'])) {
                $propertiesToRender[$propertyName] = $this->‪transformValue($propertyValue, $this->configuration[$this->currentVariable]);
            }
        }
        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;
    }
}