From 22a17e42bb45f08ae42d7cda5a9d1f06550dc940 Mon Sep 17 00:00:00 2001 From: PJ Dietz Date: Tue, 12 May 2015 17:44:28 -0400 Subject: [PATCH] Update Route docblocks --- src/Routing/Route/PrefixRoute.php | 7 ++++--- src/Routing/Route/RegexRoute.php | 5 +++-- src/Routing/Route/RouteInterface.php | 3 ++- src/Routing/Route/StaticRoute.php | 3 ++- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/Routing/Route/PrefixRoute.php b/src/Routing/Route/PrefixRoute.php index 516e85c..26b74f9 100644 --- a/src/Routing/Route/PrefixRoute.php +++ b/src/Routing/Route/PrefixRoute.php @@ -16,11 +16,12 @@ class PrefixRoute extends Route } /** + * Examines a request target to see if it is a match for the route. + * * @param string $requestTarget - * @param array $captures - * @return bool + * @return boolean */ - public function matchesRequestTarget($requestTarget, &$captures = null) + public function matchesRequestTarget($requestTarget) { return strrpos($requestTarget, $this->target, -strlen($requestTarget)) !== false; } diff --git a/src/Routing/Route/RegexRoute.php b/src/Routing/Route/RegexRoute.php index 2804885..4259b39 100644 --- a/src/Routing/Route/RegexRoute.php +++ b/src/Routing/Route/RegexRoute.php @@ -15,9 +15,10 @@ class RegexRoute extends Route } /** + * Examines a request target to see if it is a match for the route. + * * @param string $requestTarget - * @return bool - * @throws \RuntimeException + * @return boolean */ public function matchesRequestTarget($requestTarget) { diff --git a/src/Routing/Route/RouteInterface.php b/src/Routing/Route/RouteInterface.php index 2c6e94a..88e22a5 100644 --- a/src/Routing/Route/RouteInterface.php +++ b/src/Routing/Route/RouteInterface.php @@ -23,8 +23,9 @@ interface RouteInterface extends MiddlewareInterface public function getMethodMap(); /** - * Examines a path (request target) to see if it is a match for the route. + * Examines a request target to see if it is a match for the route. * + * @param string $requestTarget * @return boolean */ public function matchesRequestTarget($requestTarget); diff --git a/src/Routing/Route/StaticRoute.php b/src/Routing/Route/StaticRoute.php index bee0bbc..e9aeb20 100644 --- a/src/Routing/Route/StaticRoute.php +++ b/src/Routing/Route/StaticRoute.php @@ -10,8 +10,9 @@ class StaticRoute extends Route } /** - * Examines a path (request target) to see if it is a match for the route. + * Examines a request target to see if it is a match for the route. * + * @param string $requestTarget * @return boolean */ public function matchesRequestTarget($requestTarget)