Meraki\Route\Rule

Complexity

Total Complexity

11

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	create()	0	3	1
A	getHandler()	0	3	1
A	getMethod()	0	3	1
A	getPattern()	0	3	1
A	matchesMethod()	0	3	1
A	getName()	0	3	1
A	name()	0	13	3

<?php
declare(strict_types=1);

namespace Meraki\Route;

use Meraki\Route\Pattern;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use InvalidArgumentException;

/**
 * A mapping of an incoming request to its appropriate request-handler.
 *
 * @author Nathan Bishop <nbish11@hotmail.com> (https://nathanbishop.name)
 * @copyright 2019 Nathan Bishop
 * @license The MIT license.
 */
final class Rule
{
	/**
	 * @var string [$method description]
	 */
    private $method;

    /**
	 * @var Pattern [$pattern description]
	 */
    private $pattern;

    /**
	 * @var RequestHandler [$handler description]
	 */
    private $handler;

    /**
	 * @var string [$name description]
	 */
    private $name;

    /**
     * [__construct description]
     *
     * @param string $method  [description]
     * @param Pattern $pattern [description]
     * @param RequestHandler $handler [description]
     * @throws InvalidArgumentException [<description>]
     */
    public function __construct(string $method, Pattern $pattern, RequestHandler $handler)
    {
        if (empty($method)) {
    		throw new InvalidArgumentException('A request method was not provided.');
    	}

    	$this->method = $method;
        $this->pattern = $pattern;
        $this->handler = $handler;
        $this->name = '';
    }

    /**
     * [getMethod description]
     *
     * @return string [description]
     */
    public function getMethod(): string
    {
        return $this->method;
    }

    /**
     * [getPattern description]
     *
     * @return Pattern [description]
     */
    public function getPattern(): Pattern
    {
        return $this->pattern;
    }

    /**
     * [getHandler description]
     *
     * @return RequestHandler [description]
     */
    public function getHandler(): RequestHandler
    {
        return $this->handler;
    }

    /**
     * [getName description]
     *
     * @return string [description]
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * [name description]
     *
     * @param string $name [description]
     * @throws InvalidArgumentException [description]
     * @throws InvalidArgumentException [description]
     * @return self [description]
     */
    public function name(string $name): self
    {
    	if ($this->name) {
    		throw new InvalidArgumentException('Name is immutable and cannot be changed once set.');
    	}

        if (empty($name)) {
        	throw new InvalidArgumentException('Name cannot be empty.');
        }

        $this->name = $name;

        return $this;
    }

    /**
     * [matchesMethod description]
     *
     * @param string $requestMethod [description]
     * @return boolean [description]
     */
    public function matchesMethod(string $requestMethod): bool
    {
        return strcasecmp($this->method, $requestMethod) === 0;
    }

    /**
     * [create description]
     *
     * @param string $method  [description]
     * @param string $pattern [description]
     * @param RequestHandler $handler [description]
     * @return self [description]
     */
    public static function create(string $method, string $pattern, RequestHandler $handler): self
    {
    	return new self($method, new Pattern($pattern), $handler);
    }
}