merakiframework / route

src/Exception/RequestTargetNotMatched.php

Indentation +1 added lines, -1 removed lines

@@ -54,6 +54,6 @@
      */
     private function generateMessage(): string
     {
-    	return sprintf('The request target "%s" could not be matched!', $this->failedRequestTarget);
+        return sprintf('The request target "%s" could not be matched!', $this->failedRequestTarget);
     }
 }

src/UrlGenerator.php

Indentation +105 added lines, -105 removed lines

@@ -17,109 +17,109 @@
  */
 final class UrlGenerator
 {
-	/**
-	 * @const string [RELATIVE_URI_REFERENCE_REGEX description]
-	 */
-	private const RELATIVE_URI_REFERENCE_REGEX = '~^//([^/?#]+)([^?#]*)(\?([^#]*))?~';
-
-	/**
-	 * @var Collection The route collection.
-	 */
-	private $routes;
-
-	/**
-	 * @var string [$base description]
-	 */
-	private $base;
-
-	/**
-	 * Constructs a new route path generator.
-	 *
-	 * @param Collection $routes The collection of "named" routes.
-	 */
-	public function __construct(Collection $routes)
-	{
-		$this->routes = $routes;
-		$this->base = '';
-	}
-
-	/**
-	 * Set a URL for the path to be appended to.
-	 *
-	 * @param string $relativeUri A relative URI reference (a URI without the scheme component).
-	 * @throws InvalidArgumentException If a relative URI reference was not provided.
-	 */
-	public function setBaseUrl(string $relativeUri): void
-	{
-		if (preg_match(self::RELATIVE_URI_REFERENCE_REGEX, $relativeUri) !== 1) {
-			throw new InvalidArgumentException(sprintf('Invalid relative-uri reference "%s".', $relativeUri));
-		}
-
-		$this->base = $relativeUri;
-	}
-
-	/**
-	 * Retrieve the URL that the path is being resolved against.
-	 *
-	 * @return string Either the URI that was set or an empty string if none was set.
-	 */
-	public function getBaseUrl(): string
-	{
-		return $this->base;
-	}
-
-	/**
-	 * Generates a URL for the given route name.
-	 *
-	 * @param string $name The route name.
-	 * @param mixed[] $parameters Replacements for named placeholders.
-	 * @throws RuntimeException If a route could not be found for the given name.
-	 * @return string The full protocol-less URL.
-	 */
-	public function generate(string $name, array $parameters = [])
-	{
-		foreach ($this->routes as $route) {
-			if ($route->getName() === $name) {
-				$requestTarget = $this->interpolate($route->getPattern(), $parameters);
-
-				return $this->resolve($this->base, $requestTarget);
-			}
-		}
-
-		throw new RuntimeException(sprintf('A route could not be found for "%s".', $name));
-	}
-
-	/**
-	 * Resolve the request-target against a base URL.
-	 *
-	 * @param string $base A relative URI reference.
-	 * @param string $requestTarget The interpolated request-target.
-	 * @return string A protocol-relative (begins with two slashes) URL.
-	 */
-	protected function resolve(string $base, string $requestTarget): string
-	{
-		if ($base) {
-			return rtrim($base . $requestTarget, '/');
-		}
-
-		return $requestTarget;
-	}
-
-	/**
-	 * Replace placeholders in a template with their contextual values.
-	 *
-	 * @param Pattern $template The template/pattern to use.
-	 * @param mixed[] $parameters Replacements for the named placeholders.
-	 * @return string The pattern with the placeholders filled in.
-	 */
-	protected function interpolate(Pattern $template, array $parameters)
-	{
-		$replacements = [];
-
-		foreach ($parameters as $key => $value) {
-			$replacements[":{$key}"] = $value;
-		}
-
-		return strtr((string)$template, $replacements);
-	}
+    /**
+     * @const string [RELATIVE_URI_REFERENCE_REGEX description]
+     */
+    private const RELATIVE_URI_REFERENCE_REGEX = '~^//([^/?#]+)([^?#]*)(\?([^#]*))?~';
+
+    /**
+     * @var Collection The route collection.
+     */
+    private $routes;
+
+    /**
+     * @var string [$base description]
+     */
+    private $base;
+
+    /**
+     * Constructs a new route path generator.
+     *
+     * @param Collection $routes The collection of "named" routes.
+     */
+    public function __construct(Collection $routes)
+    {
+        $this->routes = $routes;
+        $this->base = '';
+    }
+
+    /**
+     * Set a URL for the path to be appended to.
+     *
+     * @param string $relativeUri A relative URI reference (a URI without the scheme component).
+     * @throws InvalidArgumentException If a relative URI reference was not provided.
+     */
+    public function setBaseUrl(string $relativeUri): void
+    {
+        if (preg_match(self::RELATIVE_URI_REFERENCE_REGEX, $relativeUri) !== 1) {
+            throw new InvalidArgumentException(sprintf('Invalid relative-uri reference "%s".', $relativeUri));
+        }
+
+        $this->base = $relativeUri;
+    }
+
+    /**
+     * Retrieve the URL that the path is being resolved against.
+     *
+     * @return string Either the URI that was set or an empty string if none was set.
+     */
+    public function getBaseUrl(): string
+    {
+        return $this->base;
+    }
+
+    /**
+     * Generates a URL for the given route name.
+     *
+     * @param string $name The route name.
+     * @param mixed[] $parameters Replacements for named placeholders.
+     * @throws RuntimeException If a route could not be found for the given name.
+     * @return string The full protocol-less URL.
+     */
+    public function generate(string $name, array $parameters = [])
+    {
+        foreach ($this->routes as $route) {
+            if ($route->getName() === $name) {
+                $requestTarget = $this->interpolate($route->getPattern(), $parameters);
+
+                return $this->resolve($this->base, $requestTarget);
+            }
+        }
+
+        throw new RuntimeException(sprintf('A route could not be found for "%s".', $name));
+    }
+
+    /**
+     * Resolve the request-target against a base URL.
+     *
+     * @param string $base A relative URI reference.
+     * @param string $requestTarget The interpolated request-target.
+     * @return string A protocol-relative (begins with two slashes) URL.
+     */
+    protected function resolve(string $base, string $requestTarget): string
+    {
+        if ($base) {
+            return rtrim($base . $requestTarget, '/');
+        }
+
+        return $requestTarget;
+    }
+
+    /**
+     * Replace placeholders in a template with their contextual values.
+     *
+     * @param Pattern $template The template/pattern to use.
+     * @param mixed[] $parameters Replacements for the named placeholders.
+     * @return string The pattern with the placeholders filled in.
+     */
+    protected function interpolate(Pattern $template, array $parameters)
+    {
+        $replacements = [];
+
+        foreach ($parameters as $key => $value) {
+            $replacements[":{$key}"] = $value;
+        }
+
+        return strtr((string)$template, $replacements);
+    }
 }

src/MatchResult.php

Indentation +149 added lines, -149 removed lines

@@ -15,153 +15,153 @@
  */
 final class MatchResult
 {
-	/**
-	 * @const integer [FOUND description]
-	 */
-	const MATCHED = 200;
-
-	/**
-	 * @const integer [NOT_FOUND description]
-	 */
-	const REQUEST_TARGET_NOT_MATCHED = 404;
-
-	/**
-	 * @const integer [METHOD_NOT_ALLOWED description]
-	 */
-	const METHOD_NOT_MATCHED = 405;
-
-	/**
-	 * @var integer [$type description]
-	 */
-	private $type;
-
-	/**
-	 * @var ServerRequest [$request description]
-	 */
-	private $request;
-
-	/**
-	 * @var Rule [$matchedRule description]
-	 */
-	private $matchedRule;
-
-	/**
-	 * @var string[] [$allowedMethods description]
-	 */
-	private $allowedMethods;
-
-	/**
-	 * [__construct description]
-	 *
-	 * @param integer $type [description]
-	 * @param ServerRequest $request [description]
-	 */
-	private function __construct(int $type, ServerRequest $request)
-	{
-		$this->type = $type;
-		$this->request = $request;
-		$this->allowedMethods = [];
-	}
-
-	/**
-	 * [getType description]
-	 *
-	 * @return integer [description]
-	 */
-	public function getType(): int
-	{
-		return $this->type;
-	}
-
-	/**
-	 * [getRequest description]
-	 *
-	 * @return ServerRequest [description]
-	 */
-	public function getRequest(): ServerRequest
-	{
-		return $this->request;
-	}
-
-	/**
-	 * [getMatchedRule description]
-	 *
-	 * @return Rule|null [description]
-	 */
-	public function getMatchedRule(): ?Rule
-	{
-		return $this->matchedRule;
-	}
-
-	/**
-	 * [getAllowedMethods description]
-	 *
-	 * @return string[] [description]
-	 */
-	public function getAllowedMethods(): array
-	{
-		return $this->allowedMethods;
-	}
-
-	/**
-	 * [isSuccessful description]
-	 *
-	 * @return boolean [description]
-	 */
-	public function isSuccessful(): bool
-	{
-		return $this->type === self::MATCHED;
-	}
-
-	/**
-	 * [isFailure description]
-	 *
-	 * @return boolean [description]
-	 */
-	public function isFailure(): bool
-	{
-		return $this->type === self::REQUEST_TARGET_NOT_MATCHED
-			|| $this->type === self::METHOD_NOT_MATCHED;
-	}
-
-	/**
-	 * [success description]
-	 *
-	 * @param ServerRequest $request [description]
-	 * @param Rule $rule [description]
-	 * @return self [description]
-	 */
-	public static function matched(ServerRequest $request, Rule $rule): self
-	{
-		$result = new self(self::MATCHED, $request);
-		$result->matchedRule = $rule;
-
-		return $result;
-	}
-
-	/**
-	 * [notFound description]
-	 *
-	 * @param ServerRequest $request [description]
-	 * @return self [description]
-	 */
-	public static function requestTargetNotMatched(ServerRequest $request): self
-	{
-		return new self(self::REQUEST_TARGET_NOT_MATCHED, $request);
-	}
-
-	/**
-	 * [methodNotAllowed description]
-	 *
-	 * @param ServerRequest $request [description]
-	 * @param string[] $allowedMethods [description]
-	 * @return self [description]
-	 */
-	public static function methodNotMatched(ServerRequest $request, array $allowedMethods): self
-	{
-		$result = new self(self::METHOD_NOT_MATCHED, $request);
-		$result->allowedMethods = $allowedMethods;
-
-		return $result;
-	}
+    /**
+     * @const integer [FOUND description]
+     */
+    const MATCHED = 200;
+
+    /**
+     * @const integer [NOT_FOUND description]
+     */
+    const REQUEST_TARGET_NOT_MATCHED = 404;
+
+    /**
+     * @const integer [METHOD_NOT_ALLOWED description]
+     */
+    const METHOD_NOT_MATCHED = 405;
+
+    /**
+     * @var integer [$type description]
+     */
+    private $type;
+
+    /**
+     * @var ServerRequest [$request description]
+     */
+    private $request;
+
+    /**
+     * @var Rule [$matchedRule description]
+     */
+    private $matchedRule;
+
+    /**
+     * @var string[] [$allowedMethods description]
+     */
+    private $allowedMethods;
+
+    /**
+     * [__construct description]
+     *
+     * @param integer $type [description]
+     * @param ServerRequest $request [description]
+     */
+    private function __construct(int $type, ServerRequest $request)
+    {
+        $this->type = $type;
+        $this->request = $request;
+        $this->allowedMethods = [];
+    }
+
+    /**
+     * [getType description]
+     *
+     * @return integer [description]
+     */
+    public function getType(): int
+    {
+        return $this->type;
+    }
+
+    /**
+     * [getRequest description]
+     *
+     * @return ServerRequest [description]
+     */
+    public function getRequest(): ServerRequest
+    {
+        return $this->request;
+    }
+
+    /**
+     * [getMatchedRule description]
+     *
+     * @return Rule|null [description]
+     */
+    public function getMatchedRule(): ?Rule
+    {
+        return $this->matchedRule;
+    }
+
+    /**
+     * [getAllowedMethods description]
+     *
+     * @return string[] [description]
+     */
+    public function getAllowedMethods(): array
+    {
+        return $this->allowedMethods;
+    }
+
+    /**
+     * [isSuccessful description]
+     *
+     * @return boolean [description]
+     */
+    public function isSuccessful(): bool
+    {
+        return $this->type === self::MATCHED;
+    }
+
+    /**
+     * [isFailure description]
+     *
+     * @return boolean [description]
+     */
+    public function isFailure(): bool
+    {
+        return $this->type === self::REQUEST_TARGET_NOT_MATCHED
+            || $this->type === self::METHOD_NOT_MATCHED;
+    }
+
+    /**
+     * [success description]
+     *
+     * @param ServerRequest $request [description]
+     * @param Rule $rule [description]
+     * @return self [description]
+     */
+    public static function matched(ServerRequest $request, Rule $rule): self
+    {
+        $result = new self(self::MATCHED, $request);
+        $result->matchedRule = $rule;
+
+        return $result;
+    }
+
+    /**
+     * [notFound description]
+     *
+     * @param ServerRequest $request [description]
+     * @return self [description]
+     */
+    public static function requestTargetNotMatched(ServerRequest $request): self
+    {
+        return new self(self::REQUEST_TARGET_NOT_MATCHED, $request);
+    }
+
+    /**
+     * [methodNotAllowed description]
+     *
+     * @param ServerRequest $request [description]
+     * @param string[] $allowedMethods [description]
+     * @return self [description]
+     */
+    public static function methodNotMatched(ServerRequest $request, array $allowedMethods): self
+    {
+        $result = new self(self::METHOD_NOT_MATCHED, $request);
+        $result->allowedMethods = $allowedMethods;
+
+        return $result;
+    }
 }

src/Rule.php

Indentation +17 added lines, -17 removed lines

@@ -16,24 +16,24 @@ 
  */
 final class Rule
 {
-	/**
-	 * @var string [$method description]
-	 */
+    /**
+     * @var string [$method description]
+     */
     private $method;
 
     /**
-	 * @var Pattern [$pattern description]
-	 */
+     * @var Pattern [$pattern description]
+     */
     private $pattern;
 
     /**
-	 * @var RequestHandler [$handler description]
-	 */
+     * @var RequestHandler [$handler description]
+     */
     private $handler;
 
     /**
-	 * @var string [$name description]
-	 */
+     * @var string [$name description]
+     */
     private $name;
 
     /**
@@ -47,10 +47,10 @@ 
     public function __construct(string $method, Pattern $pattern, RequestHandler $handler)
     {
         if (empty($method)) {
-    		throw new InvalidArgumentException('A request method was not provided.');
-    	}
+            throw new InvalidArgumentException('A request method was not provided.');
+        }
 
-    	$this->method = $method;
+        $this->method = $method;
         $this->pattern = $pattern;
         $this->handler = $handler;
         $this->name = '';
@@ -106,12 +106,12 @@ 
      */
     public function name(string $name): self
     {
-    	if ($this->name) {
-    		throw new InvalidArgumentException('Name is immutable and cannot be changed once set.');
-    	}
+        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.');
+            throw new InvalidArgumentException('Name cannot be empty.');
         }
 
         $this->name = $name;
@@ -140,6 +140,6 @@ 
      */
     public static function create(string $method, string $pattern, RequestHandler $handler): self
     {
-    	return new self($method, new Pattern($pattern), $handler);
+        return new self($method, new Pattern($pattern), $handler);
     }
 }

src/Pattern.php

Indentation +108 added lines, -108 removed lines

@@ -12,7 +12,7 @@ 
  */
 final class Pattern
 {
-	/**
+    /**
      * @const string [PLACEHOLDER_REGEX description]
      */
     const PLACEHOLDER_SEARCH_REGEX = '~:([^/]+)~';
@@ -25,113 +25,113 @@ 
     /**
      * @var string [$pattern description]
      */
-	private $pattern;
-
-	/**
-	 * @var string[] [$placeholders description]
-	 */
-	private $placeholders;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param string $pattern [description]
-	 */
-	public function __construct(string $pattern)
-	{
-		$this->pattern = $this->stripQueryString($pattern);
-		$this->placeholders = [];
-	}
-
-	/**
-	 * Retrieve any placeholders and their values.
-	 *
-	 * @return string[] The placeholder names and its values (only after compiling).
-	 */
-	public function getPlaceholders(): array
-	{
-		return $this->placeholders;
-	}
-
-	/**
-	 * Allow this object to be treated like a string.
-	 *
-	 * @return string The pattern BEFORE it's compiled.
-	 */
-	public function __toString(): string
-	{
-		return $this->pattern;
-	}
-
-	/**
-	 * Compile the request-target pattern into a regular expression.
-	 *
-	 * @todo Extract into a separate object along with the placeholders (something like `CompiledPattern`).
-	 * @return string A regular expression representing the pattern.
-	 */
-	public function compile(): string
-	{
-		$regex = preg_replace_callback(self::PLACEHOLDER_SEARCH_REGEX, [$this, 'extractPlaceholders'], $this->pattern);
-    	$regex = sprintf('~^%s$~', $regex);
+    private $pattern;
+
+    /**
+     * @var string[] [$placeholders description]
+     */
+    private $placeholders;
+
+    /**
+     * Constructor.
+     *
+     * @param string $pattern [description]
+     */
+    public function __construct(string $pattern)
+    {
+        $this->pattern = $this->stripQueryString($pattern);
+        $this->placeholders = [];
+    }
+
+    /**
+     * Retrieve any placeholders and their values.
+     *
+     * @return string[] The placeholder names and its values (only after compiling).
+     */
+    public function getPlaceholders(): array
+    {
+        return $this->placeholders;
+    }
+
+    /**
+     * Allow this object to be treated like a string.
+     *
+     * @return string The pattern BEFORE it's compiled.
+     */
+    public function __toString(): string
+    {
+        return $this->pattern;
+    }
+
+    /**
+     * Compile the request-target pattern into a regular expression.
+     *
+     * @todo Extract into a separate object along with the placeholders (something like `CompiledPattern`).
+     * @return string A regular expression representing the pattern.
+     */
+    public function compile(): string
+    {
+        $regex = preg_replace_callback(self::PLACEHOLDER_SEARCH_REGEX, [$this, 'extractPlaceholders'], $this->pattern);
+        $regex = sprintf('~^%s$~', $regex);
 
         return $regex;
-	}
-
-	/**
-	 * Compiles the pattern, checks if the request-target matches and extracts the placeholders.
-	 *
-	 * @param string $requestTarget The request-target to match against.
-	 * @return boolean `true` if compiled, matched and extracted successfully, `false` otherwise.
-	 */
-	public function matches(string $requestTarget): bool
-	{
-		$compiledPattern = $this->compile();
-		$requestTarget = $this->stripQueryString($requestTarget);
-
-		if (preg_match($compiledPattern, $requestTarget, $matches) === 1) {
-			$this->setPlaceholderValues($matches);
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Extract placeholder names and give it an appropriate regex for matching.
-	 *
-	 * @param array $matches The matches returned from compile().
-	 * @return string The regex to use in place of the placeholder name.
-	 */
-	private function extractPlaceholders(array $matches): string
-	{
-		$this->placeholders[$matches[1]] = null;
-
-		return sprintf('(?<%s>[^/]+)', $matches[1]);
-	}
-
-	/**
-	 * Set the placeholder values from the match results.
-	 *
-	 * @param string[] $matches The results from preg_match().
-	 */
-	private function setPlaceholderValues(array $matches): void
-	{
-		foreach ($this->placeholders as $key => $value) {
-			if (isset($matches[$key])) {
-				$this->placeholders[$key] = $matches[$key];
-			}
-		}
-	}
-
-	/**
-	 * Remove the 'query string' part from a request-target.
-	 *
-	 * @param string $requestTarget The request-target which may or may not have a query string.
-	 * @return string The request-target without the query string.
-	 */
-	private function stripQueryString(string $requestTarget): string
-	{
-		return strpos($requestTarget, '?') !== false ? strstr($requestTarget, '?', true) : $requestTarget;
-	}
+    }
+
+    /**
+     * Compiles the pattern, checks if the request-target matches and extracts the placeholders.
+     *
+     * @param string $requestTarget The request-target to match against.
+     * @return boolean `true` if compiled, matched and extracted successfully, `false` otherwise.
+     */
+    public function matches(string $requestTarget): bool
+    {
+        $compiledPattern = $this->compile();
+        $requestTarget = $this->stripQueryString($requestTarget);
+
+        if (preg_match($compiledPattern, $requestTarget, $matches) === 1) {
+            $this->setPlaceholderValues($matches);
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Extract placeholder names and give it an appropriate regex for matching.
+     *
+     * @param array $matches The matches returned from compile().
+     * @return string The regex to use in place of the placeholder name.
+     */
+    private function extractPlaceholders(array $matches): string
+    {
+        $this->placeholders[$matches[1]] = null;
+
+        return sprintf('(?<%s>[^/]+)', $matches[1]);
+    }
+
+    /**
+     * Set the placeholder values from the match results.
+     *
+     * @param string[] $matches The results from preg_match().
+     */
+    private function setPlaceholderValues(array $matches): void
+    {
+        foreach ($this->placeholders as $key => $value) {
+            if (isset($matches[$key])) {
+                $this->placeholders[$key] = $matches[$key];
+            }
+        }
+    }
+
+    /**
+     * Remove the 'query string' part from a request-target.
+     *
+     * @param string $requestTarget The request-target which may or may not have a query string.
+     * @return string The request-target without the query string.
+     */
+    private function stripQueryString(string $requestTarget): string
+    {
+        return strpos($requestTarget, '?') !== false ? strstr($requestTarget, '?', true) : $requestTarget;
+    }
 }

src/Collection.php

Indentation +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
  */
 class Collection implements IteratorAggregate, Countable
 {
-	/**
+    /**
      * @var Rule[] [$rules description]
      */
     private $rules = [];
@@ -49,7 +49,7 @@ 
         $index = $this->indexOf($rule);
 
         if ($index === -1) {
-        	throw new LogicException('Cannot remove a rule that is not in the collection.');
+            throw new LogicException('Cannot remove a rule that is not in the collection.');
         }
 
         unset($this->rules[$index]);
@@ -102,7 +102,7 @@ 
      */
     public function isEmpty(): bool
     {
-    	return empty($this->rules);
+        return empty($this->rules);
     }
 
     /**

src/Matcher.php

Indentation +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
             $allowedMethods[] = $matchedRule->getMethod();
 
             if ($matchedRule->matchesMethod($request->getMethod())) {
-            	return MatchResult::matched($request, $matchedRule);
+                return MatchResult::matched($request, $matchedRule);
             }
         }