core/Classes/Http/AjaxRequestHandler.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Http;

/*
 * 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 Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class AjaxRequestHandler
{
    protected $ajaxId = null;

    protected $errorMessage = null;

    protected $isError = false;

    protected $content = array();

    protected $contentFormat = 'plain';

    protected $javascriptCallbackWrap = '
                <script type="text/javascript">
                        /*<![CDATA[*/
                        response = |;
                        /*]]>*/
                </script>
        ';

    public function __construct($ajaxId)
    {
        $this->ajaxId = $ajaxId;
    }

    public function getAjaxID()
    {
        return $this->ajaxId;
    }

    public function setContent($content)
    {
        $oldcontent = false;
        if (is_array($content)) {
            $oldcontent = $this->content;
            $this->content = $content;
        }
        return $oldcontent;
    }

    public function addContent($key, $content)
    {
        $oldcontent = false;
        if (array_key_exists($key, $this->content)) {
            $oldcontent = $this->content[$key];
        }
        if (!isset($content) || empty($content)) {
            unset($this->content[$key]);
        } elseif (!isset($key) || empty($key)) {
            $this->content[] = $content;
        } else {
            $this->content[$key] = $content;
        }
        return $oldcontent;
    }

    public function getContent($key = '')
    {
        return $key && array_key_exists($key, $this->content) ? $this->content[$key] : $this->content;
    }

    public function setContentFormat($format)
    {
        if (ArrayUtility::inArray(array('plain', 'xml', 'json', 'jsonhead', 'jsonbody', 'javascript'), $format)) {
            $this->contentFormat = $format;
        }
    }

    public function setJavascriptCallbackWrap($javascriptCallbackWrap)
    {
        $this->javascriptCallbackWrap = $javascriptCallbackWrap;
    }

    public function setError($errorMsg = '')
    {
        $this->errorMessage = $errorMsg;
        $this->isError = true;
    }

    public function isError()
    {
        return $this->isError;
    }

    public function render()
    {
        if ($this->isError) {
            return $this->renderAsError();
        }
        switch ($this->contentFormat) {
            case 'jsonhead':
            case 'jsonbody':
            case 'json':
                return $this->renderAsJSON();
                break;
            case 'javascript':
                return $this->renderAsJavascript();
                break;
            case 'xml':
                return $this->renderAsXML();
                break;
            default:
                return $this->renderAsPlain();
        }
    }

    protected function renderAsError()
    {
        $response = GeneralUtility::makeInstance(Response::class);
        $response = $response
            ->withStatus(500, ' (AJAX)')
            ->withHeader('Content-type', 'text/xml; charset=utf-8')
            ->withHeader('X-JSON', 'false');

        $response->getBody()->write('<t3err>' . htmlspecialchars($this->errorMessage) . '</t3err>');
        return $response;
    }

    protected function renderAsPlain()
    {
        $response = GeneralUtility::makeInstance(Response::class);
        $response = $response
            ->withHeader('Content-type', 'text/html; charset=utf-8')
            ->withHeader('X-JSON', 'true');

        $response->getBody()->write(implode('', $this->content));
        return $response;
    }

    protected function renderAsXML()
    {
        $response = GeneralUtility::makeInstance(Response::class);
        $response = $response
            ->withHeader('Content-type', 'text/xml; charset=utf-8')
            ->withHeader('X-JSON', 'true');

        $response->getBody()->write(implode('', $this->content));
        return $response;
    }

    protected function renderAsJSON()
    {
        $response = GeneralUtility::makeInstance(Response::class);
        $response = $response->withHeader('Content-type', 'application/json; charset=utf-8');

        $content = json_encode($this->content);
        // Bring content in xhr.responseText except when in "json head only" mode
        if ($this->contentFormat === 'jsonhead') {
            $response = $response->withHeader('X-JSON', $content);
        } else {
            $response = $response->withHeader('X-JSON', 'true');
            $response->getBody()->write($content);
        }
        return $response;
    }

    protected function renderAsJavascript()
    {
        $response = GeneralUtility::makeInstance(Response::class);
        $response = $response->withHeader('Content-type', 'text/html; charset=utf-8');
        $response->getBody()->write(str_replace('|', json_encode($this->content), $this->javascriptCallbackWrap));
        return $response;
    }
}