<?php

use Psr\Container\ContainerInterface;

/**
 * StudipDispatcher.php - create the default Trails dispatcher
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * @author      <mlunzena@uos.de>
 * @copyright   2013 Stud.IP Core-Group
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 */

/**
 * Use this subclass to easily get an Stud.IP specific
 * Trails\Dispatcher.
 *
 * Example of use:
 *
 * @code
 * // deep in the Stud.IP jungle
 * $dispatcher = new StudipDispatcher();
 * $dispatcher->dispatch($requested_uri);
 * @endcode
 */
class StudipDispatcher extends Trails\Dispatcher
{
    /**
     * This variable contains the DI-Container.
     *
     * @var ContainerInterface
     */
    protected $container;

    /**
     * Create a new Trails\Dispatcher with Stud.IP specific parameters
     * for: trails_root is "$STUDIP_BASE_PATH/app", trails_uri is
     * "dispatch.php" and default_controller is "default" (which does
     * not map to anything).
     */
    public function __construct(ContainerInterface $container)
    {
        global $STUDIP_BASE_PATH, $ABSOLUTE_URI_STUDIP;

        $trails_root = $STUDIP_BASE_PATH . DIRECTORY_SEPARATOR . 'app';
        $trails_uri = rtrim($ABSOLUTE_URI_STUDIP, '/') . '/dispatch.php';
        $default_controller = 'default';
        $this->container = $container;

        parent::__construct($trails_root, $trails_uri, $default_controller);
    }

    /**
     * Adapted error method that just passes the exception to stud.ip's
     * exception instead of the standard trails handling.
     *
     * @param Exception $exception The exception that occured
     *
     * @throws Exception
     */
    public function trails_error($exception)
    {
        throw $exception;
    }

    /**
     * Loads the controller file for a given controller path and return an
     * instance of that controller. If an error occures, an exception will be
     * thrown.
     *
     * @param string $controller the relative controller path
     * @return Trails\Controller  an instance of that controller
     * @throws \Trails\Exceptions\UnknownController
     */
    public function load_controller($controller)
    {
        require_once "{$this->trails_root}/controllers/{$controller}.php";
        $class = Trails\Inflector::camelize($controller) . 'Controller';
        if (!class_exists($class)) {
            throw new Trails\Exceptions\UnknownController("Controller missing: '$class'");
        }

        return $this->container->make($class, ['dispatcher' => $this]);
    }
}