codeburnerframework / routing

src/Collectors/ResourceCollectorTrait.php

Indentation +97 added lines, -97 removed lines

@@ -22,102 +22,102 @@
 trait ResourceCollectorTrait
 {
 
-    abstract public function set($method, $pattern, $action);
-
-    /**
-     * A map of all routes of resources.
-     *
-     * @var array
-     */
-
-    protected $map = [
-        "index"  => ["get",    "/{name}"],
-        "make"   => ["get",    "/{name}/make"],
-        "create" => ["post",   "/{name}"],
-        "show"   => ["get",    "/{name}/{id:int+}"],
-        "edit"   => ["get",    "/{name}/{id:int+}/edit"],
-        "update" => ["put",    "/{name}/{id:int+}"],
-        "delete" => ["delete", "/{name}/{id:int+}"],
-    ];
-
-    /**
-     * Resource routing allows you to quickly declare all of the common routes for a given resourceful controller. 
-     * Instead of declaring separate routes for your index, show, new, edit, create, update and destroy actions, 
-     * a resourceful route declares them in a single line of code.
-     *
-     * @param string $controller The controller name.
-     * @param array  $options    Some options like, "as" to name the route pattern, "only" to
-     *                           explicit say that only this routes will be registered, and
-     *                           "except" that register all the routes except the indicates.
-     * @return Resource
-     */
-
-    public function resource($controller, array $options = array())
-    {
-        $name       = isset($options["prefix"]) ? $options["prefix"] : "";
-        $name      .= $this->getResourceName($controller, $options);
-        $actions    = $this->getResourceActions($options);
-        $resource = new Resource;
-
-        foreach ($actions as $action => $map) {
-            $resource->set($this->set($map[0], $this->getResourcePath($action, $map[1], $name, $options), [$controller, $action]));
-        }
-
-        return $resource;
-    }
-
-    /**
-     * Collect several resources at same time.
-     *
-     * @param array $controllers Several controller names as parameters or an array with all controller names.
-     * @return Resource
-     */
-
-    public function resources(array $controllers)
-    {
-        $resource = new Resource;
-        foreach ($controllers as $controller)
-            $resource->set($this->resource($controller));
-        return $resource;
-    }
-
-    /**
-     * @param string $controller
-     * @param array $options
-     *
-     * @return mixed
-     */
-
-    protected function getResourceName($controller, array $options)
-    {
-        return isset($options["as"]) ? $options["as"] : str_replace("controller", "", strtolower($controller));
-    }
-
-    /**
-     * @param  array $options
-     * @return array
-     */
-
-    protected function getResourceActions(array $options)
-    {
-        return isset($options["only"])   ? array_intersect_key($this->map, array_flip((array) $options["only"])) :
-              (isset($options["except"]) ? array_diff_key($this->map, array_flip((array) $options["except"]))    : $this->map);
-    }
-
-    /**
-     * @param string $action
-     * @param string $path
-     * @param string $name
-     * @param string[] $options
-     *
-     * @return string
-     */
-
-    protected function getResourcePath($action, $path, $name, array $options)
-    {
-        return str_replace("{name}", $name,
-            $action === "make" && isset($options["translate"]["make"]) ? str_replace("make", $options["translate"]["make"], $path) :
-           ($action === "edit" && isset($options["translate"]["edit"]) ? str_replace("edit", $options["translate"]["edit"], $path) : $path));
-    }
+	abstract public function set($method, $pattern, $action);
+
+	/**
+	 * A map of all routes of resources.
+	 *
+	 * @var array
+	 */
+
+	protected $map = [
+		"index"  => ["get",    "/{name}"],
+		"make"   => ["get",    "/{name}/make"],
+		"create" => ["post",   "/{name}"],
+		"show"   => ["get",    "/{name}/{id:int+}"],
+		"edit"   => ["get",    "/{name}/{id:int+}/edit"],
+		"update" => ["put",    "/{name}/{id:int+}"],
+		"delete" => ["delete", "/{name}/{id:int+}"],
+	];
+
+	/**
+	 * Resource routing allows you to quickly declare all of the common routes for a given resourceful controller. 
+	 * Instead of declaring separate routes for your index, show, new, edit, create, update and destroy actions, 
+	 * a resourceful route declares them in a single line of code.
+	 *
+	 * @param string $controller The controller name.
+	 * @param array  $options    Some options like, "as" to name the route pattern, "only" to
+	 *                           explicit say that only this routes will be registered, and
+	 *                           "except" that register all the routes except the indicates.
+	 * @return Resource
+	 */
+
+	public function resource($controller, array $options = array())
+	{
+		$name       = isset($options["prefix"]) ? $options["prefix"] : "";
+		$name      .= $this->getResourceName($controller, $options);
+		$actions    = $this->getResourceActions($options);
+		$resource = new Resource;
+
+		foreach ($actions as $action => $map) {
+			$resource->set($this->set($map[0], $this->getResourcePath($action, $map[1], $name, $options), [$controller, $action]));
+		}
+
+		return $resource;
+	}
+
+	/**
+	 * Collect several resources at same time.
+	 *
+	 * @param array $controllers Several controller names as parameters or an array with all controller names.
+	 * @return Resource
+	 */
+
+	public function resources(array $controllers)
+	{
+		$resource = new Resource;
+		foreach ($controllers as $controller)
+			$resource->set($this->resource($controller));
+		return $resource;
+	}
+
+	/**
+	 * @param string $controller
+	 * @param array $options
+	 *
+	 * @return mixed
+	 */
+
+	protected function getResourceName($controller, array $options)
+	{
+		return isset($options["as"]) ? $options["as"] : str_replace("controller", "", strtolower($controller));
+	}
+
+	/**
+	 * @param  array $options
+	 * @return array
+	 */
+
+	protected function getResourceActions(array $options)
+	{
+		return isset($options["only"])   ? array_intersect_key($this->map, array_flip((array) $options["only"])) :
+			  (isset($options["except"]) ? array_diff_key($this->map, array_flip((array) $options["except"]))    : $this->map);
+	}
+
+	/**
+	 * @param string $action
+	 * @param string $path
+	 * @param string $name
+	 * @param string[] $options
+	 *
+	 * @return string
+	 */
+
+	protected function getResourcePath($action, $path, $name, array $options)
+	{
+		return str_replace("{name}", $name,
+			$action === "make" && isset($options["translate"]["make"]) ? str_replace("make", $options["translate"]["make"], $path) :
+		   ($action === "edit" && isset($options["translate"]["edit"]) ? str_replace("edit", $options["translate"]["edit"], $path) : $path));
+	}
 
 }

src/Exceptions/BadDispatchStrategyException.php

Indentation +3 added lines, -3 removed lines

@@ -20,8 +20,8 @@
 class BadDispatchStrategyException extends BadRouteException
 {
 
-    public function __construct($strategy) {
-        parent::__construct("`$strategy` is not a valid route dispatch strategy, it must implement the `Codeburner\Router\DispatchStrategies\DispatchStrategyInterface` interface.");
-    }
+	public function __construct($strategy) {
+		parent::__construct("`$strategy` is not a valid route dispatch strategy, it must implement the `Codeburner\Router\DispatchStrategies\DispatchStrategyInterface` interface.");
+	}
     
 }

src/Exceptions/MethodNotSupportedException.php

Indentation +3 added lines, -3 removed lines

@@ -20,8 +20,8 @@
 class MethodNotSupportedException extends BadRouteException
 {
 
-    public function __construct($method) {
-        parent::__construct("The HTTP method '$method' is not supported by the route collector.");
-    }
+	public function __construct($method) {
+		parent::__construct("The HTTP method '$method' is not supported by the route collector.");
+	}
 
 }

src/Exceptions/NotFoundException.php

Indentation +27 added lines, -27 removed lines

@@ -19,36 +19,36 @@
 class NotFoundException extends \Exception
 {
 
-    /**
-     * The HTTP method from request.
-     *
-     * @var string
-     */
+	/**
+	 * The HTTP method from request.
+	 *
+	 * @var string
+	 */
 
-    public $requestedMethod;
+	public $requestedMethod;
 
-    /**
-     * The requested Path.
-     *
-     * @var string
-     */
+	/**
+	 * The requested Path.
+	 *
+	 * @var string
+	 */
 
-    public $requestedPath;
+	public $requestedPath;
     
-    /**
-     * Exception constructor.
-     *
-     * @param string  $requestedMethod  The request HTTP method.
-     * @param string  $requestedPath    The request Path.
-     * @param string  $message          The exception error message.
-     * @param integer $code             The exception error code.
-     */
-
-    public function __construct($requestedMethod, $requestedPath, $message = null, $code = 405)
-    {
-        $this->requestedMethod = $requestedMethod;
-        $this->requestedPath = $requestedPath;
-        parent::__construct($message, $code);
-    }
+	/**
+	 * Exception constructor.
+	 *
+	 * @param string  $requestedMethod  The request HTTP method.
+	 * @param string  $requestedPath    The request Path.
+	 * @param string  $message          The exception error message.
+	 * @param integer $code             The exception error code.
+	 */
+
+	public function __construct($requestedMethod, $requestedPath, $message = null, $code = 405)
+	{
+		$this->requestedMethod = $requestedMethod;
+		$this->requestedPath = $requestedPath;
+		parent::__construct($message, $code);
+	}
 	
 }

src/Strategies/EnhancerAbstractStrategy.php

Indentation +32 added lines, -32 removed lines

@@ -24,37 +24,37 @@
 abstract class EnhancerAbstractStrategy implements StrategyInterface
 {
 
-    /**
-     * Key used to store the real route strategy on metadata.
-     *
-     * @var string
-     */
-
-    protected $metadataStrategyKey = "strategy";
-
-    /**
-     * @inheritdoc
-     * @throws BadRouteException
-     */
-
-    public function call(Route $route)
-    {
-        if ($route->hasMetadata($this->metadataStrategyKey)) {
-               $route->setStrategy($route->getMetadata($this->metadataStrategyKey));
-        } else $route->setStrategy(null);
-
-        $this->enhance($route);
-
-        return $route->call();
-    }
-
-    /**
-     * Manipulate route object before the dispatch.
-     *
-     * @param Route $route
-     * @return mixed
-     */
-
-    abstract public function enhance(Route $route);
+	/**
+	 * Key used to store the real route strategy on metadata.
+	 *
+	 * @var string
+	 */
+
+	protected $metadataStrategyKey = "strategy";
+
+	/**
+	 * @inheritdoc
+	 * @throws BadRouteException
+	 */
+
+	public function call(Route $route)
+	{
+		if ($route->hasMetadata($this->metadataStrategyKey)) {
+			   $route->setStrategy($route->getMetadata($this->metadataStrategyKey));
+		} else $route->setStrategy(null);
+
+		$this->enhance($route);
+
+		return $route->call();
+	}
+
+	/**
+	 * Manipulate route object before the dispatch.
+	 *
+	 * @param Route $route
+	 * @return mixed
+	 */
+
+	abstract public function enhance(Route $route);
 
 }

src/Strategies/MatcherAwareInterface.php

Indentation +8 added lines, -8 removed lines

@@ -20,16 +20,16 @@
 interface MatcherAwareInterface
 {
 
-    /**
-     * @param \Codeburner\Router\Matcher $matcher
-     */
+	/**
+	 * @param \Codeburner\Router\Matcher $matcher
+	 */
 
-    public function setMatcher(\Codeburner\Router\Matcher $matcher);
+	public function setMatcher(\Codeburner\Router\Matcher $matcher);
 
-    /**
-     * @return \Codeburner\Router\Matcher
-     */
+	/**
+	 * @return \Codeburner\Router\Matcher
+	 */
 
-    public function getMatcher();
+	public function getMatcher();
 
 }
\ No newline at end of file

src/Strategies/StrategyInterface.php

Indentation +7 added lines, -7 removed lines

@@ -19,13 +19,13 @@
 interface StrategyInterface
 {
 
-    /**
-     * Dispatch the matched route action.
-     *
-     * @param \Codeburner\Router\Route $route
-     * @return mixed The response of request.
-     */
+	/**
+	 * Dispatch the matched route action.
+	 *
+	 * @param \Codeburner\Router\Route $route
+	 * @return mixed The response of request.
+	 */
 
-    public function call(\Codeburner\Router\Route $route);
+	public function call(\Codeburner\Router\Route $route);
 
 }

src/Exceptions/BadRouteException.php

Indentation +4 added lines, -4 removed lines

@@ -20,9 +20,9 @@
 class BadRouteException extends \Exception
 {
 
-    const OPTIONAL_SEGMENTS_ON_MIDDLE    = "Optional segments can only occur at the end of a route.";
-    const UNCLOSED_OPTIONAL_SEGMENTS     = "Number of opening [ and closing ] does not match.";
-    const EMPTY_OPTIONAL_PARTS           = "Empty optional part.";
-    const WRONG_CONTROLLER_CREATION_FUNC = "The controller creation function passed is not callable.";
+	const OPTIONAL_SEGMENTS_ON_MIDDLE    = "Optional segments can only occur at the end of a route.";
+	const UNCLOSED_OPTIONAL_SEGMENTS     = "Number of opening [ and closing ] does not match.";
+	const EMPTY_OPTIONAL_PARTS           = "Empty optional part.";
+	const WRONG_CONTROLLER_CREATION_FUNC = "The controller creation function passed is not callable.";
 
 }

src/Exceptions/MethodNotAllowedException.php

Indentation +55 added lines, -55 removed lines

@@ -20,71 +20,71 @@
 class MethodNotAllowedException extends BadRouteException
 {
 
-    /**
-     * The HTTP method from request.
-     *
-     * @var string
-     */
+	/**
+	 * The HTTP method from request.
+	 *
+	 * @var string
+	 */
 
-    public $requestedMethod;
+	public $requestedMethod;
 
-    /**
-     * The requested URi.
-     *
-     * @var string
-     */
+	/**
+	 * The requested URi.
+	 *
+	 * @var string
+	 */
 
-    public $requestedUri;
+	public $requestedUri;
 
-    /**
-     * All the allowed HTTP methods and routes for the request.
-     *
-     * @var array
-     */
+	/**
+	 * All the allowed HTTP methods and routes for the request.
+	 *
+	 * @var array
+	 */
 
-    public $allowedMethods;
+	public $allowedMethods;
 	
-    /**
-     * Exception constructor.
-     *
-     * @param string  $requestedMethod The request HTTP method.
-     * @param string  $requestedUri    The request URi.
-     * @param array   $allowedMethods  All the allowed HTTP methods and routes for the request.
-     * @param string  $message         The exception error message.
-     * @param integer $code            The exception error code.
-     */
+	/**
+	 * Exception constructor.
+	 *
+	 * @param string  $requestedMethod The request HTTP method.
+	 * @param string  $requestedUri    The request URi.
+	 * @param array   $allowedMethods  All the allowed HTTP methods and routes for the request.
+	 * @param string  $message         The exception error message.
+	 * @param integer $code            The exception error code.
+	 */
 
-    public function __construct($requestedMethod, $requestedUri, array $allowedMethods, $message = null, $code = 405)
-    {
-        $this->requestedMethod = $requestedMethod;
-        $this->requestedUri    = $requestedUri;
-        $this->allowedMethods  = $allowedMethods;
-        parent::__construct($message, $code);
-    }
+	public function __construct($requestedMethod, $requestedUri, array $allowedMethods, $message = null, $code = 405)
+	{
+		$this->requestedMethod = $requestedMethod;
+		$this->requestedUri    = $requestedUri;
+		$this->allowedMethods  = $allowedMethods;
+		parent::__construct($message, $code);
+	}
 
-    /**
-     * Verify if the given HTTP method is allowed for the request.
-     *
-     * @param string $method An HTTP method
-     * @return bool
-     */
+	/**
+	 * Verify if the given HTTP method is allowed for the request.
+	 *
+	 * @param string $method An HTTP method
+	 * @return bool
+	 */
 
-    public function can($method)
-    {
-        return in_array(strtolower($method), $this->allowedMethods);
-    }
+	public function can($method)
+	{
+		return in_array(strtolower($method), $this->allowedMethods);
+	}
 
-    /**
-     * The HTTP specification requires that a 405 Method Not Allowed response include the 
-     * Allow: header to detail available methods for the requested resource.
-     *
-     * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html section 14.7
-     * @return string
-     */
+	/**
+	 * The HTTP specification requires that a 405 Method Not Allowed response include the 
+	 * Allow: header to detail available methods for the requested resource.
+	 *
+	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html section 14.7
+	 * @return string
+	 */
     
-    public function allowed()
-    {
-        return implode(', ', $this->allowedMethods);
-    }
+	public function allowed()
+	{
+		return implode(', ', $this->allowedMethods);
+	}
 
 }