Aimeos\Slim\Router

Complexity

Total Complexity

18

Size/Duplication

Total Lines	142
Duplicated Lines	4.23 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
C	relativePathFor()	0	52	8
A	processInvalidMethod()	3	20	4
B	process()	3	27	6

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2016
 * @package Slim
 */


namespace Aimeos\Slim;

use InvalidArgumentException;


/**
 * Router
 *
 * This class organizes Slim application route objects. It is responsible
 * for registering route objects, assigning names to route objects,
 * finding routes that match the current HTTP request, and creating
 * URLs for a named route.
 */
class Router extends \Slim\Router
{
	/**
	 * Build the path for a named route excluding the base path
	 *
	 * @param string $name		Route name
	 * @param array  $data		Named argument replacement data
	 * @param array  $queryParams Optional query string parameters
	 *
	 * @return string
	 *
	 * @throws RuntimeException		 If named route does not exist
	 * @throws InvalidArgumentException If required data not provided
	 */
	public function relativePathFor($name, array $data = [], array $queryParams = [])
	{
		$route = $this->getNamedRoute($name);
		$pattern = $route->getPattern();

		$routeDatas = $this->routeParser->parse($pattern);
		// $routeDatas is an array of all possible routes that can be made. There is
		// one routedata for each optional parameter plus one for no optional parameters.
		//
		// The most specific is last, so we look for that first.
		$routeDatas = array_reverse($routeDatas);

		$segments = $segmentKeys = [];
		foreach ($routeDatas as $routeData) {
			foreach ($routeData as $item) {
				if (is_string($item)) {
					// this segment is a static string
					$segments[] = $item;
					continue;
				}

				// This segment has a parameter: first element is the name
				if (!array_key_exists($item[0], $data)) {
					// we don't have a data element for this segment: cancel
					// testing this routeData item, so that we can try a less
					// specific routeData item.
					$segments = [];
					$segmentName = $item[0];
					break;
				}
				$segments[] = $data[$item[0]];
				$segmentKeys[$item[0]] = true;
			}
			if (!empty($segments)) {
				// we found all the parameters for this route data, no need to check
				// less specific ones
				break;
			}
		}

		if (empty($segments)) {
			throw new InvalidArgumentException('Missing data for URL segment: ' . $segmentName);
		}
		$url = implode('', $segments);

		$params = array_merge(array_diff_key($data, $segmentKeys), $queryParams);
		if ($params) {

The expression $params of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			$url .= '?' . http_build_query($params);
		}

		return $url;
	}

    /**
     * Pull route info for a request with a bad method to decide whether to
     * return a not-found error (default) or a bad-method error, then run
     * the handler for that error, returning the resulting response.
     *
     * Used for cases where an incoming request has an unrecognized method,
     * rather than throwing an exception and not catching it all the way up.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     * @return ResponseInterface
     */
    protected function processInvalidMethod(ServerRequestInterface $request, ResponseInterface $response)
    {
        $router = $this->container->get('router');
        if (is_callable([$request->getUri(), 'getBaseUrl']) && is_callable([$router, 'getBaseUrl'])) {

This code seems to be duplicated across your project.

            $router->setBasePath($request->getUri()->getBaseUrl());
        }

        $request = $this->dispatchRouterAndPrepareRoute($request, $router);

The method dispatchRouterAndPrepareRoute() does not exist on Aimeos\Slim\Router. Did you maybe mean dispatch()?

        $routeInfo = $request->getAttribute('routeInfo', [RouterInterface::DISPATCH_STATUS => Dispatcher::NOT_FOUND]);

        if ($routeInfo[RouterInterface::DISPATCH_STATUS] === Dispatcher::METHOD_NOT_ALLOWED) {
            return $this->handleException(

The method handleException() does not seem to exist on object<Aimeos\Slim\Router>.

                new MethodNotAllowedException($request, $response, $routeInfo[RouterInterface::ALLOWED_METHODS]),
                $request,
                $response
            );
        }

        return $this->handleException(new NotFoundException($request, $response), $request, $response);

The method handleException() does not seem to exist on object<Aimeos\Slim\Router>.

    }

    /**
     * Process a request
     *
     * This method traverses the application middleware stack and then returns the
     * resultant Response object.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     * @return ResponseInterface
     *
     * @throws Exception
     * @throws MethodNotAllowedException
     * @throws NotFoundException
     */
    public function process(ServerRequestInterface $request, ResponseInterface $response)
    {
        // Ensure basePath is set
        $router = $this->container->get('router');
        if (is_callable([$request->getUri(), 'getBaseUrl']) && is_callable([$router, 'getBaseUrl'])) {

This code seems to be duplicated across your project.

            $router->setBasePath($request->getUri()->getBaseUrl());
        }

        // Dispatch the Router first if the setting for this is on
        if ($this->container->get('settings')['determineRouteBeforeAppMiddleware'] === true) {
            // Dispatch router (note: you won't be able to alter routes after this)
            $request = $this->dispatchRouterAndPrepareRoute($request, $router);

The method dispatchRouterAndPrepareRoute() does not exist on Aimeos\Slim\Router. Did you maybe mean dispatch()?

        }

        // Traverse middleware stack
        try {
            $response = $this->callMiddlewareStack($request, $response);

The method callMiddlewareStack() does not seem to exist on object<Aimeos\Slim\Router>.

        } catch (Exception $e) {

The class Aimeos\Slim\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

            $response = $this->handleException($e, $request, $response);

The method handleException() does not seem to exist on object<Aimeos\Slim\Router>.

        } catch (Throwable $e) {

The class Aimeos\Slim\Throwable does not exist. Did you forget a USE statement, or did you not list all dependencies?

            $response = $this->handlePhpError($e, $request, $response);

The method handlePhpError() does not seem to exist on object<Aimeos\Slim\Router>.

        }

        $response = $this->finalize($response);

The method finalize() does not seem to exist on object<Aimeos\Slim\Router>.

        return $response;
    }
}