phpOMS/Dispatcher/Dispatcher.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.0
 *
 * @category   TBD
 * @package    TBD
 * @author     OMS Development Team <dev@oms.com>
 * @author     Dennis Eichhorn <d.eichhorn@oms.com>
 * @copyright  2013 Dennis Eichhorn
 * @license    OMS License 1.0
 * @version    1.0.0
 * @link       http://orange-management.com
 */
namespace phpOMS\Dispatcher;

use phpOMS\ApplicationAbstract;
use phpOMS\Message\RequestAbstract;
use phpOMS\Message\ResponseAbstract;
use phpOMS\Module\ModuleAbstract;
use phpOMS\Views\ViewLayout;

/**
 * Dispatcher class.
 *
 * @category   Framework
 * @package    Framework
 * @author     OMS Development Team <dev@oms.com>
 * @author     Dennis Eichhorn <d.eichhorn@oms.com>
 * @license    OMS License 1.0
 * @link       http://orange-management.com
 * @since      1.0.0
 */
class Dispatcher
{

    /**
     * Application.
     *
     * @var ApplicationAbstract
     * @since 1.0.0
     */
    private $app = null;

    /**
     * Controller.
     *
     * Set in the module manager on module initialization.
     *
     * @var array
     * @since 1.0.0
     */
    private $controllers = [];

    /**
     * Constructor.
     *
     * @param ApplicationAbstract $app Appliaction
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function __construct(ApplicationAbstract $app)
    {
        $this->app = $app;
    }

    /**
     * Dispatch controller.
     *
     * @param \string|array|\Closure $controller Controller string
     * @param RequestAbstract        $request    Request
     * @param ResponseAbstract       $response   Response
     * @param mixed                  $data       Data
     *
     * @return array
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function dispatch($controller, RequestAbstract $request, ResponseAbstract $response, $data = null) : array
    {
        $views = [];
        $type  = ViewLayout::UNDEFINED;

        if (isset($controller['type'])) {
            $type       = $controller['type'];
            $controller = $controller['dest'];
        }

        if (is_string($controller)) {
            $dispatch = explode(':', $controller);
            $this->get($dispatch[0]);

            if (count($dispatch) == 3) {
                /* Handling static functions */
                $views[$type][$controller] = $dispatch[0]::$dispatch[2]();
            } else {
                $views[$type][$controller] = $this->controllers[$dispatch[0]]->{$dispatch[1]}($request, $response, $data);
            }
        } elseif (is_array($controller)) {
            foreach ($controller as $controllerSingle) {
                foreach ($controllerSingle as $c) {
                    $views += $this->dispatch($c, $request, $response, $data);
                }
            }
        } elseif ($controller instanceof \Closure) {
            $views[$type][] = $controller($this->app, $request, $response, $data);
        } else {
            throw new \UnexpectedValueException('Unexpected controller type.');
        }

        return $views;
    }

    /**
     * Get controller.
     *
     * @param \string $controller Controller string
     *
     * @return \bool
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function get(\string $controller) : \bool
    {
        if (!isset($this->controllers[$controller])) {
            $this->controllers[$controller] = new $controller($this->app);

            return true;
        }

        return false;
    }

    /**
     * Set controller by alias.
     *
     * @param ModuleAbstract $controller Controller
     * @param \string        $name       Controller string
     *
     * @return \bool
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function set(ModuleAbstract $controller, \string $name) : \bool
    {
        if (!isset($this->controllers[$name])) {
            $this->controllers[$name] = $controller;

            return true;
        }

        return false;
    }

}