Route::cacheable() - Code Metrics - Inspection of "149 View cache" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#178)

unknown
created 2024-11-14 15:06 UTC
Route::cacheable() B

↳ Parent: Route
Complexity

Conditions	9
Paths	8
Size

Total Lines	33
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	9
eloc	19
c	0
b	0
f	0
nc	8
nop	2
dl	0
loc	33
rs	8.0555
<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.0
 */

namespace Quantum\Router;

use Quantum\Exceptions\RouteException;
use Closure;
use Quantum\Loader\Setup;

/**
 * Route Class
 * @package Quantum\Router
 */
class Route
{

    /**
     * Current module name
     * @var string
     */
    private $moduleName;

    /**
     * Module options
     * @var array
     */
    private $moduleOptions = [];

    /**
     * Identifies the group middleware
     * @var bool
     */
    private $isGroupMiddlewares;

    /**
     * Identifies the group
     * @var boolean
     */
    private $isGroup = false;

    /**
     * Current group name
     * @var string
     */
    private $currentGroupName = null;

    /**
     * Current route
     * @var array
     */
    private $currentRoute = [];

    /**
     * Virtual routes
     * @var array
     */
    private $virtualRoutes = [];

    /**
     * Class constructor
     * @param array $module
     */
    public function __construct(array $module)
    {
        $this->virtualRoutes['*'] = [];
        $this->moduleName = key($module);
        $this->moduleOptions = $module[key($module)];

		if (config()->has('resource_cache') && !config()->has('view_cache')){
			config()->import(new Setup('config', 'view_cache'));
		}
    }

    /**
     * Adds new route entry to routes
     * @param string $route
     * @param string $method
     * @param array $params
     * @return Route
     */
    public function add(string $route, string $method, ...$params): Route
    {
        $this->currentRoute = [
            'route' => !empty($this->moduleOptions['prefix']) ? $this->moduleOptions['prefix'] . '/' . $route : $route,
            'prefix' => $this->moduleOptions['prefix'],
            'method' => $method,
            'module' => $this->moduleName
        ];

	    if ($this->canSetCacheToCurrentRoute()){
		    $this->currentRoute['cache'] = [
			    'shouldCache' => true,
			    'ttl' => config()->get('view_cache.ttl', 300),
		    ];
	    }

        if (is_callable($params[0])) {
            $this->currentRoute['callback'] = $params[0];
        } else {
            $this->currentRoute['controller'] = $params[0];
            $this->currentRoute['action'] = $params[1];
        }

        if ($this->currentGroupName) {
            $this->currentRoute['group'] = $this->currentGroupName;
            $this->virtualRoutes[$this->currentGroupName][] = $this->currentRoute;
        } else {
            $this->isGroup = false;
            $this->isGroupMiddlewares = false;
            $this->virtualRoutes['*'][] = $this->currentRoute;
        }

        return $this;
    }

    /**
     * Adds new get route entry to routes
     * @param string $route
     * @param array $params
     * @return Route
     */
    public function get(string $route, ...$params): Route
    {
        return $this->add($route, 'GET', ...$params);
    }

    /**
     * Adds new post route entry to routes
     * @param string $route
     * @param array $params
     * @return Route
     */
    public function post(string $route, ...$params): Route
    {
        return $this->add($route, 'POST', ...$params);
    }

    /**
     * Starts a named group of routes
     * @param string $groupName
     * @param Closure $callback
     * @return Route
     */
    public function group(string $groupName, Closure $callback): Route
    {
        $this->currentGroupName = $groupName;

        $this->isGroup = true;
        $this->isGroupMiddlewares = false;
        $callback($this);
        $this->isGroupMiddlewares = true;
        $this->currentGroupName = null;

        return $this;
    }

    /**
     * Adds middlewares to routes and route groups
     * @param array $middlewares
     * @return Route
     */
    public function middlewares(array $middlewares = []): Route
    {
        if (!$this->isGroup) {
            end($this->virtualRoutes['*']);
            $lastKey = key($this->virtualRoutes['*']);
            $this->assignMiddlewaresToRoute($this->virtualRoutes['*'][$lastKey], $middlewares);
            return $this;
        }

        end($this->virtualRoutes);
        $lastKeyOfFirstRound = key($this->virtualRoutes);

        if (!$this->isGroupMiddlewares) {
            end($this->virtualRoutes[$lastKeyOfFirstRound]);
            $lastKeyOfSecondRound = key($this->virtualRoutes[$lastKeyOfFirstRound]);
            $this->assignMiddlewaresToRoute($this->virtualRoutes[$lastKeyOfFirstRound][$lastKeyOfSecondRound], $middlewares);
            return $this;
        }

        foreach ($this->virtualRoutes[$lastKeyOfFirstRound] as &$route) {
            $this->assignMiddlewaresToRoute($route, $middlewares);
        }

        return $this;
    }

	public function cacheable(bool $shouldCache, int $ttl = null): Route
	{
		if (!$ttl) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$ttl = config()->get('view_cache.ttl', 300);
		}

		if (isset($_COOKIE['PHPSESSID'])){
			if (!$this->isGroup){
				end($this->virtualRoutes['*']);
				$lastKey = key($this->virtualRoutes['*']);

				if (!$shouldCache && key_exists('cache', $this->virtualRoutes['*'][$lastKey])) {
					unset($this->virtualRoutes['*'][$lastKey]['cache']);
				}else{
					$this->assignCacheToCurrentRoute($this->virtualRoutes['*'][$lastKey], $shouldCache, $ttl);
					$this->assignCacheToCurrentRoute($this->virtualRoutes['*'][$lastKey], $shouldCache, /** @scrutinizer ignore-type */ $ttl);
				}

				return $this;
			}

			end($this->virtualRoutes);
			$lastKeyOfFirstRound = key($this->virtualRoutes);

			foreach ($this->virtualRoutes[$lastKeyOfFirstRound] as &$route) {
				if (!$shouldCache && key_exists('cache', $route)) {
					unset($route['cache']);
				}else{
					$this->assignCacheToCurrentRoute($route, $shouldCache, $ttl);
				}
			}
		}

		return $this;
	}

    /**
     * Sets a unique name for a route
     * @param string $name
     * @return Route
     * @throws RouteException
     */
    public function name(string $name): Route
    {
        if (empty($this->currentRoute)) {
            throw RouteException::nameBeforeDefinition();
        }

        if ($this->isGroupMiddlewares) {
            throw RouteException::nameOnGroup();
        }

        foreach ($this->virtualRoutes as &$virtualRoute) {
            foreach ($virtualRoute as &$route) {
                if (isset($route['name']) && $route['name'] == $name) {
                    throw RouteException::nonUniqueName();
                }

                if ($route['route'] == $this->currentRoute['route']) {
                    $route['name'] = $name;
                }
            }
        }

        return $this;
    }

    /**
     * Gets the run-time routes
     * @return array
     */
    public function getRuntimeRoutes(): array
    {
        $runtimeRoutes = [];
        foreach ($this->virtualRoutes as $virtualRoute) {
            foreach ($virtualRoute as $route) {
                $runtimeRoutes[] = $route;
            }
        }
        return $runtimeRoutes;
    }

    /**
     * Gets the virtual routes
     * @return array
     */
    public function getVirtualRoutes(): array
    {
        return $this->virtualRoutes;
    }

    /**
     * Assigns middlewares to the route
     * @param array $route
     * @param array $middlewares
     */
    private function assignMiddlewaresToRoute(array &$route, array $middlewares)
    {
        if (!key_exists('middlewares', $route)) {
            $route['middlewares'] = $middlewares;
        } else {
            $middlewares = array_reverse($middlewares);

            foreach ($middlewares as $middleware) {
                array_unshift($route['middlewares'], $middleware);
            }
        }
    }

	private function assignCacheToCurrentRoute(array &$route, bool $shouldCache, int $ttl)
	{
		$route['cache'] = [
			'shouldCache' => $shouldCache,
			'ttl' => $ttl,
		];
	}

	private function canSetCacheToCurrentRoute(): bool
	{
		return isset($_COOKIE['PHPSESSID']) &&
			config()->has('resource_cache') &&
			config()->get('resource_cache') &&
			!empty($this->moduleOptions) &&
			isset($this->moduleOptions['cacheable']) &&
			$this->moduleOptions['cacheable'];
	}

}

softberg / quantum-php-core

Pull Request — master (#178)

Route::cacheable() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
