HummingBirdAnimeClient/src/Base/Router.php

230 lines
4.8 KiB
PHP
Raw Normal View History

2015-05-22 12:36:26 -04:00
<?php
/**
* Routing logic
*/
namespace AnimeClient\Base;
2015-05-22 12:36:26 -04:00
use \Aura\Web\Request;
use \Aura\Web\Response;
2015-06-26 16:39:10 -04:00
/**
* Basic routing/ dispatch
*/
2015-05-22 12:36:26 -04:00
class Router {
/**
* The route-matching object
* @var object $router
*/
protected $router;
/**
* The global configuration object
* @var object $config
*/
protected $config;
/**
* Class wrapper for input superglobals
* @var object
*/
protected $request;
2015-06-29 09:46:49 -04:00
/**
* Array containing request and response objects
* @var array $web
*/
protected $web;
/**
* Routes added to router
* @var array $output_routes
*/
protected $output_routes;
/**
* Injection Container
* @var Container $container
*/
protected $container;
/**
* Constructor
2015-06-29 09:46:49 -04:00
*
* @param Config $config
* @param Router $router
* @param Request $request
* @param Response $response
*/
public function __construct(Container $container)
2015-05-22 12:36:26 -04:00
{
$this->config = $container->get('config');
$this->router = $container->get('aura-router');
$this->request = $container->get('request');
$this->web = [$this->request, $container->get('response')];
2015-05-22 12:36:26 -04:00
$this->output_routes = $this->_setup_routes();
$this->container = $container;
2015-05-22 12:36:26 -04:00
}
/**
* Get the current route object, if one matches
*
* @return object
*/
public function get_route()
{
$error_handler = $this->container->get('error-handler');
$raw_route = $this->request->server->get('PATH_INFO');
$route_path = "/" . trim($raw_route, '/');
$error_handler->addDataTable('Route Info', [
'route_path' => $route_path
]);
$route = $this->router->match($route_path, $_SERVER);
2015-05-22 12:36:26 -04:00
return $route;
}
/**
* Get list of routes applied
*
* @return array
*/
public function get_output_routes()
{
return $this->output_routes;
}
2015-05-22 12:36:26 -04:00
/**
* Handle the current route
*
* @codeCoverageIgnore
2015-05-22 12:36:26 -04:00
* @param [object] $route
* @return void
*/
public function dispatch($route = NULL)
{
$error_handler = $this->container->get('error-handler');
2015-05-27 09:03:42 -04:00
2015-05-22 12:36:26 -04:00
if (is_null($route))
{
$route = $this->get_route();
$error_handler->addDataTable('route_args', (array)$route);
2015-05-22 12:36:26 -04:00
}
if ( ! $route)
{
2015-05-27 09:03:42 -04:00
$failure = $this->router->getFailedRoute();
$error_handler->addDataTable('failed_route', (array)$failure);
2015-05-22 12:36:26 -04:00
}
else
{
2015-06-17 08:50:01 -04:00
list($controller_name, $action_method) = $route->params['action'];
2015-05-22 12:36:26 -04:00
$params = (isset($route->params['params'])) ? $route->params['params'] : [];
if ( ! empty($route->tokens))
{
foreach($route->tokens as $key => $v)
{
if (array_key_exists($key, $route->params))
{
$params[$key] = $route->params[$key];
}
}
}
2015-05-22 12:36:26 -04:00
}
$controller = new $controller_name($this->container);
2015-05-22 12:36:26 -04:00
// Run the appropriate controller method
$error_handler->addDataTable('controller_args', $params);
2015-05-22 12:36:26 -04:00
call_user_func_array([$controller, $action_method], $params);
}
/**
* Get the type of route, to select the current controller
*
* @return string
*/
public function get_controller()
{
$route_type = $this->config->default_list;
$host = $this->request->server->get("HTTP_HOST");
$request_uri = $this->request->server->get('PATH_INFO');
$path = trim($request_uri, '/');
$route_type_map = [
$this->config->anime_path => 'anime',
$this->config->manga_path => 'manga',
$this->config->collection_path => 'collection',
$this->config->stats_path => 'stats'
];
$segments = explode('/', $path);
$controller = array_shift($segments);
if (array_key_exists($controller, array_keys($route_type_map)))
{
return $route_type_map[$controller];
}
return $route_type;
}
/**
* Select controller based on the current url, and apply its relevent routes
*
* @return array
*/
public function _setup_routes()
2015-05-22 12:36:26 -04:00
{
$output_routes = [];
$route_type = $this->get_controller();
// Return early if invalid route array
if ( ! array_key_exists($route_type, $this->config->routes)) return [];
2015-05-22 12:36:26 -04:00
$applied_routes = array_merge($this->config->routes[$route_type], $this->config->routes['common']);
2015-05-22 12:36:26 -04:00
// Add routes
foreach($applied_routes as $name => &$route)
2015-05-22 12:36:26 -04:00
{
$path = $route['path'];
unset($route['path']);
$controller_class = '\\AnimeClient\\Controller\\' . ucfirst($route_type);
// Prepend the controller to the route parameters
array_unshift($route['action'], $controller_class);
2015-06-17 08:50:01 -04:00
// Select the appropriate router method based on the http verb
$add = (array_key_exists('verb', $route)) ? "add" . ucfirst(strtolower($route['verb'])) : "addGet";
2015-06-17 08:50:01 -04:00
// Add the route to the router object
if ( ! array_key_exists('tokens', $route))
{
$output_routes[] = $this->router->$add($name, $path)->addValues($route);
}
else
{
$tokens = $route['tokens'];
unset($route['tokens']);
2015-06-17 08:50:01 -04:00
$output_routes[] = $this->router->$add($name, $path)
->addValues($route)
->addTokens($tokens);
2015-06-17 08:50:01 -04:00
}
}
return $output_routes;
2015-05-22 12:36:26 -04:00
}
}
// End of Router.php