Action::getMethods() - Code Metrics - o2system/kernel - Measure and Improve Code Quality continuously with Scrutinizer

Action::getMethods() A
last analyzed 2019-10-02 16:44 UTC

↳ Parent: Action
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Kernel\Http\Router\DataStructures;

// ------------------------------------------------------------------------

/**
 * Class Action
 * @package O2System\Kernel\Http\Router\DataStructures
 */
class Action
{
    /**
     * Action::$methods
     *
     * Action Methods
     *
     * @var array
     */
    private $methods;

    /**
     * Action::$domain
     *
     * Routing map domain.
     *
     * @var string
     */
    private $domain;

    /**
     * Action::$path
     *
     * Action Path
     *
     * @var string
     */
    private $path;

    /**
     * Action::$closure
     *
     * Action Closure
     *
     * @var \Closure
     */
    private $closure;

    /**
     * Action::$closureParameters
     *
     * Action Closure Parameters
     *
     * @var array
     */
    private $closureParameters = [];

    // ------------------------------------------------------------------------

    /**
     * Action::__construct
     *
     * @param string   $method  The route method.
     * @param string   $path    The route path.
     * @param \Closure $closure The route closure.
     * @param string   $domain  The route domain.
     */
    public function __construct($method, $path, \Closure $closure, $domain = null)
    {
        $this->methods = explode('|', $method);
        $this->methods = array_map('strtoupper', $this->methods);

        $this->path = $path;
        $this->closure = $closure;
        $this->domain = is_null($domain)
            ? isset($_SERVER[ 'HTTP_HOST' ])
                ? @$_SERVER[ 'HTTP_HOST' ]
                : @$_SERVER[ 'SERVER_NAME' ]
            : $domain;

        // Remove www
        if (strpos($this->domain, 'www.') !== false) {
            $this->domain = str_replace('www.', '', $this->domain);
        }

        if (preg_match_all("/{(.*)}/", $this->domain, $matches)) {
            foreach ($matches[ 1 ] as $match) {
                $this->closureParameters[] = $match;
            }
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getMethods
     *
     * @return array
     */
    public function getMethods()
    {
        return $this->methods;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getDomain
     *
     * @return mixed|string
     */
    public function getDomain()
    {
        return $this->domain;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getPath
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getClosure
     *
     * @return mixed
     */
    public function getClosure()
    {
        return call_user_func_array($this->closure, $this->closureParameters);
    }

    // ------------------------------------------------------------------------

    /**
     * Action::addClosureParameters
     *
     * @param mixed $value
     *
     * @return static
     */
    public function addClosureParameters($value)
    {
        $this->closureParameters[] = $value;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getClosureParameters
     *
     * @return array
     */
    public function getClosureParameters()
    {
        return $this->closureParameters;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::setClosureParameters
     *
     * @param array $parameters
     *
     * @return static
     */
    public function setClosureParameters(array $parameters)
    {
        $this->closureParameters = $parameters;

        return $this;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::isValidDomain
     *
     * @return bool
     */
    public function isValidDomain()
    {
        $domain = isset($_SERVER[ 'HTTP_HOST' ])
            ? $_SERVER[ 'HTTP_HOST' ]
            : $_SERVER[ 'SERVER_NAME' ];

        if ($this->domain === $domain) {
            return true;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::isValidUriString
     *
     * @param string $uriString
     *
     * @return bool
     * @throws \ReflectionException
     */
    public function isValidUriString($uriString)
    {
        $uriString = '/' . ltrim($uriString, '/');

        if (strtolower($uriString) === $this->path) {
            $this->closureParameters = array_merge(
                $this->closureParameters,
                array_filter(explode('/', $uriString))
            );

            return true;
        } elseif (false !== ($matches = $this->getParseUriString($uriString))) {
            $parameters = [];
            $closure = new \ReflectionFunction($this->closure);

            if (is_string(key($matches))) {
            if (is_string(key(/** @scrutinizer ignore-type */ $matches))) {
                foreach ($closure->getParameters() as $index => $parameter) {
                    if (($class = $parameter->getClass()) instanceof \ReflectionClass) {
                        $className = $class->getName();
                        if (class_exists($className)) {
                            if (isset($matches[ $parameter->name ])) {
                                $parameters[ $index ] = new $className($matches[ $parameter->name ]);
                            }
                        }
                    } elseif (isset($matches[ $parameter->name ])) {
                        $parameters[ $index ] = $matches[ $parameter->name ];
                    } else {
                        $parameters[ $index ] = null;
                    }
                }
            } else {
                foreach ($closure->getParameters() as $index => $parameter) {
                    if (isset($matches[ $index ])) {
                        $parameters[ $index ] = $matches[ $index ];
                    } else {
                        $parameters[ $index ] = null;
                    }
                }
            }

            $this->closureParameters = $parameters;

            return true;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::getParseUriString
     *
     * @param string $uriString
     *
     * @return array|bool
     */
    public function getParseUriString($uriString)
    {
        // Convert wildcards to RegEx
        $regex = str_replace(['/(:any?)', ':any', ':num'], ['/?([^/]+)?', '[^/]+', '[0-9]+'], $this->path);
        $regex = str_replace('/', '\/', $regex);

        $uriString = '/' . ltrim($uriString, '/');

        // CodeIgniter Like Routing
        if (preg_match('/' . $regex . '/', $uriString, $matches)) {

            // Remove first match
            array_shift($matches);

            return (count($matches) ? $matches : false);
        }

        // Laravel Like Routing
        if (preg_match("/{(.*)}/", $this->path)) {
            // Try to find from each parts
            $pathParts = explode('/', $this->path);
            $stringParts = explode('/', $uriString);

            $pathParts = array_filter($pathParts);
            $stringParts = array_filter($stringParts);

            $matches = [];
            $parameters = [];

            for ($i = 0; $i <= count($pathParts); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                if (isset($pathParts[ $i ]) && isset($stringParts[ $i ])) {
                    if ($pathParts[ $i ] == $stringParts[ $i ]) {
                        $matches[ $i ] = $stringParts[ $i ];
                    }
                }

                if (isset($pathParts[ $i ])) {
                    if (preg_match("/{(.*)}/", $pathParts[ $i ])) {
                        $index = str_replace(['{$', '}'], '', $pathParts[ $i ]);
                        $parameters[ $index ] = isset($stringParts[ $i ]) ? $stringParts[ $i ] : null;
                    }
                }
            }

            return (count($matches) ? $parameters : false);
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * Action::isValidHttpMethod
     *
     * @param string $method
     *
     * @return bool
     */
    public function isValidHttpMethod($method)
    {
        $method = strtoupper($method);

        if (in_array('ANY', $this->methods)) {
            return true;
        }

        return (bool)in_array($method, $this->methods);
    }

    // ------------------------------------------------------------------------

    /**
     * Action::isAnyHttpMethod
     *
     * @return bool
     */
    public function isAnyHttpMethod()
    {
        return (bool)in_array('ANY', $this->methods);
    }
}
o2system / kernel

GitHub Access Token became invalid

Action::getMethods() A last analyzed 2019-10-02 16:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Action::getMethods() A
last analyzed 2019-10-02 16:44 UTC
