nafigator / Veles

Routing/Route.php

<?php
/**
 * Routing class
 *
 * @file      Route.php
 *
 * PHP version 8.0+
 *
 * @author    Alexander Yancharuk <alex at itvault dot info>
 * @copyright © 2012-2021 Alexander Yancharuk
 * @date      Сбт Июн 23 08:52:41 2012
 * @license   The BSD 3-Clause License
 *            <https://tldrlegal.com/license/bsd-3-clause-license-(revised)>
 */

namespace Veles\Routing;

use Exception;
use Veles\Controllers\BaseController;
use Veles\Controllers\RestApiController;
use Veles\Request\HttpRequestAbstract;
use Veles\Request\Validator\ValidatorInterface;
use Veles\View\Adapters\ViewAdapterAbstract;

/**
 * Class Route
 *
 * @author  Alexander Yancharuk <alex at itvault dot info>
 */
class Route extends RouteBase
{
	protected $name;
	/** @var  array Current route config */
	protected $config;
	protected $template;
	protected $params = [];
	/** @var  ValidatorInterface */
	protected $validator;
	/** @var  HttpRequestAbstract */
	protected $request;
	/** @var string */
	protected $uri = '';

	/**
	 * Config parser and controller vars initialisation
	 *
	 * @throws Exception
	 */
	public function init(): self
	{
		$path = parse_url(
			filter_input(INPUT_SERVER, 'REQUEST_URI'),
			PHP_URL_PATH
		);

		if (!is_string($path)) {

The condition is_string($path) is always true.

			return $this->execNotFoundHandler();
		}

		[$uri, $section] = $this->parseUri($path);
		$this->uri = $uri;
		$routes    = $this->getConfigHandler()->getSection($section);

		foreach ($routes as $name => $route) {
			if (!$route['class']::check($route['route'], $uri)) {
				continue;
			}

			$this->process($name, $route);
		}

		return $this->execNotFoundHandler();
	}

	/**
	 * Get current URI
	 *
	 * @return string
	 */
	public function getUri(): string
	{
		return $this->uri;
	}

	/**
	 * Process route
	 *
	 * @param $name
	 * @param array $config
	 */
	protected function process($name, array $config): void
	{
		$this->config = $config;
		$this->name   = $name;

		if (isset($config['tpl'])) {
			$this->template = $config['tpl'];
		}

		if (RouteRegex::class === $config['class']) {
			/** @noinspection PhpUndefinedMethodInspection */
			$this->params = $config['class']::getParams();
		}
	}

	/**
	 * Safe way to get uri
	 *
	 * @param  string  $uri
	 *
	 * @return array
	 * @codeCoverageIgnore
	 */
	protected function parseUri(string $uri): array
	{
		$parts   = explode('/', $uri);
		$section = isset($parts[2]) ? $parts[1] : '';

		return [$uri, $section];
	}

	/**
	 * Not found exception handler
	 *
	 * @return $this
	 */
	protected function execNotFoundHandler(): self
	{
		if (null === $this->config && null !== $this->ex404) {
			throw new $this->ex404;
		}

		return $this;
	}

	/**
	 * Getting ajax-flag
	 *
	 * @return bool
	 * @throws Exception
	 */
	public function isAjax(): bool
	{
		return isset($this->config['ajax']);
	}

	/**
	 * Build and return controller object
	 *
	 * @return BaseController|RestApiController
	 * @throws Exception
	 */
	public function getController()
	{
		if (!isset($this->config['controller'])) {
			throw new Exception('Controller name not set!');
		}

		$controller = 'Controllers\\' . $this->config['controller'];

		return new $controller;
	}

	/**
	 * Get controller method name
	 *
	 * @return string
	 * @throws Exception
	 */
	public function getActionName(): string
	{
		if (!isset($this->config['action'])) {
			throw new Exception('Action not set!');
		}

		return $this->config['action'];
	}

	/**
	 * Get View adapter class
	 *
	 * @return ViewAdapterAbstract
	 * @throws Exception
	 */
	public function getAdapter()
	{
		if (!isset($this->config['view'])) {
			throw new Exception('Route adapter not set!');
		}

		/** @var ViewAdapterAbstract $adapter_name */
		$adapter_name = $this->config['view'];

		return $adapter_name::instance();
	}

	/**
	 * Getting route name
	 *
	 * @return string
	 */
	public function getName(): string
	{
		return $this->name;
	}

	/**
	 * Getting URL-params
	 *
	 * @return array
	 */
	public function getParams(): array
	{
		return $this->params;
	}

	/**
	 * Return template path
	 *
	 * @return string|null
	 */
	public function getTemplate(): ?string
	{
		return $this->template;
	}
}