ResultFactory.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Controller;

use Magento\Framework\ObjectManagerInterface;

class ResultFactory
{
    const TYPE_JSON     = 'json';
    const TYPE_RAW      = 'raw';
    const TYPE_REDIRECT = 'redirect';
    const TYPE_FORWARD  = 'forward';
    const TYPE_LAYOUT   = 'layout';
    const TYPE_PAGE     = 'page';
    protected $typeMap = [
        self::TYPE_JSON     => Result\Json::class,
        self::TYPE_RAW      => Result\Raw::class,
        self::TYPE_REDIRECT => Result\Redirect::class,
        self::TYPE_FORWARD  => Result\Forward::class,
        self::TYPE_LAYOUT   => \Magento\Framework\View\Result\Layout::class,
        self::TYPE_PAGE     => \Magento\Framework\View\Result\Page::class,
    ];

    private $objectManager;

    public function __construct(
        ObjectManagerInterface $objectManager,
        array $typeMap = []
    ) {
        $this->objectManager = $objectManager;
        $this->mergeTypes($typeMap);
    }

    protected function mergeTypes(array $typeMap)
    {
        foreach ($typeMap as $typeInfo) {
            if (isset($typeInfo['type']) && isset($typeInfo['class'])) {
                $this->typeMap[$typeInfo['type']] = $typeInfo['class'];
            }
        }
    }

    public function create($type, array $arguments = [])
    {
        if (empty($this->typeMap[$type])) {
            throw new \InvalidArgumentException('"' . $type . ': isn\'t allowed');
        }

        $resultInstance = $this->objectManager->create($this->typeMap[$type], $arguments);
        if (!$resultInstance instanceof ResultInterface) {
            throw new \InvalidArgumentException(get_class($resultInstance) . ' isn\'t instance of ResultInterface');
        }

        if ($resultInstance instanceof \Magento\Framework\View\Result\Layout) {
            // Initialization has to be in constructor of ResultPage
            $resultInstance->addDefaultHandle();
        }

        return $resultInstance;
    }
}