Update Route docblocks

This commit is contained in:
PJ Dietz 2015-05-12 17:44:28 -04:00
parent 297e985e84
commit 22a17e42bb
4 changed files with 11 additions and 7 deletions

View File

@ -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 string $requestTarget
* @param array $captures * @return boolean
* @return bool
*/ */
public function matchesRequestTarget($requestTarget, &$captures = null) public function matchesRequestTarget($requestTarget)
{ {
return strrpos($requestTarget, $this->target, -strlen($requestTarget)) !== false; return strrpos($requestTarget, $this->target, -strlen($requestTarget)) !== false;
} }

View File

@ -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 * @param string $requestTarget
* @return bool * @return boolean
* @throws \RuntimeException
*/ */
public function matchesRequestTarget($requestTarget) public function matchesRequestTarget($requestTarget)
{ {

View File

@ -23,8 +23,9 @@ interface RouteInterface extends MiddlewareInterface
public function getMethodMap(); 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 * @return boolean
*/ */
public function matchesRequestTarget($requestTarget); public function matchesRequestTarget($requestTarget);

View File

@ -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 * @return boolean
*/ */
public function matchesRequestTarget($requestTarget) public function matchesRequestTarget($requestTarget)