Respect / Rest

library/Respect/Rest/Request.php

Doc Comments +7 added lines, -7 removed lines

@@ -75,7 +75,7 @@ 
      * @see    Respect\Rest\Request::forwardErrors
      * @see    http://php.net/set_error_handler
      *
-     * @return mixed The previous error handler
+     * @return null|callable The previous error handler
      */
     protected function prepareForErrorForwards()
     {
@@ -169,10 +169,10 @@ 
      * Restores the previous error handler if present then check error routes
      * for logged errors, forwarding them or returning null silently
      *
-     * @param mixed $errorHandler Some error handler (internal or external to
+     * @param null|callable $errorHandler Some error handler (internal or external to
      *                            Respect)
      *
-     * @return mixed A route forwarding or a silent null
+     * @return string|null A route forwarding or a silent null
      */
     protected function forwardErrors($errorHandler)
     {
@@ -195,9 +195,9 @@ 
      * Does a catch-like operation on an exception based on previously
      * declared instances from Router::exceptionRoute
      *
-     * @param Exception $e Any exception
+     * @param \Exception $e Any exception
      *
-     * @return mixed A route forwarding or a silent null
+     * @return string|null A route forwarding or a silent null
      */
     protected function catchExceptions($e)
     {
@@ -269,7 +269,7 @@ 
      * @param Routinable $routine Some routine instance
      * @param array      $params  Params from the routine
      *
-     * @return mixed Whatever the routine returns
+     * @return AbstractRoute Whatever the routine returns
      */
     public function routineCall($type, $method, Routinable $routine, &$params)
     {
@@ -331,7 +331,7 @@ 
      *
      * @param AbstractRoute $route Any route
      *
-     * @return Response from the forwarded route
+     * @return string from the forwarded route
      */
     public function forward(AbstractRoute $route)
     {

library/Respect/Rest/Router.php

Doc Comments +17 added lines, -17 removed lines

@@ -319,7 +319,7 @@ 
      * @param callable $callback  Any callback for this route
      * @param array    $arguments Additional arguments for the callback
      *
-     * @return Respect\Rest\Routes\Callback The route instance
+     * @return Routes\Callback The route instance
      */
     public function callbackRoute(
         $method,
@@ -341,7 +341,7 @@ 
      * @param string $class     Some class name
      * @param array  $arguments The class constructor arguments
      *
-     * @return Respect\Rest\Routes\ClassName The route instance
+     * @return Routes\ClassName The route instance
      */
     public function classRoute($method, $path, $class, array $arguments = array())
     {
@@ -387,7 +387,7 @@ 
      *                          catch. 'Exception' will catch them all.
      * @param string $callback  The function to run when an exception is cautght
      *
-     * @return Respect\Rest\Routes\Exception
+     * @return Routes\Exception
      */
     public function exceptionRoute($className, $callback = null)
     {
@@ -402,7 +402,7 @@ 
      *
      * @param string $callback The function to run when an error is cautght
      *
-     * @return Respect\Rest\Routes\Error
+     * @return Routes\Error
      */
     public function errorRoute($callback)
     {
@@ -420,7 +420,7 @@ 
      * @param string $className The class name of the factored instance
      * @param string $factory   Any callable
      *
-     * @return Respect\Rest\Routes\Factory The route created
+     * @return Routes\Factory The route created
      */
     public function factoryRoute($method, $path, $className, $factory)
     {
@@ -467,9 +467,9 @@ 
      *
      * @param string $method  The HTTP metod (GET, POST, etc)
      * @param string $path    The URI Path (/foo/bar...)
-     * @param string $intance An instance of Routinable
+     * @param Routable $instance An instance of Routinable
      *
-     * @return Respect\Rest\Routes\Instance The route created
+     * @return Routes\Instance The route created
      */
     public function instanceRoute($method, $path, $instance)
     {
@@ -495,7 +495,7 @@ 
      *
      * @param Request $request A request
      *
-     * @return bool true if the request doesn't apply for routes
+     * @return boolean|null true if the request doesn't apply for routes
      */
     public function isRoutelessDispatch(Request $request = null)
     {
@@ -583,7 +583,7 @@ 
      * @param string $path        The URI Path (/foo/bar...)
      * @param string $staticValue Some static value to be printed
      *
-     * @return Respect\Rest\Routes\StaticValue The route created
+     * @return Routes\StaticValue The route created
      */
     public function staticRoute($method, $path, $staticValue)
     {
@@ -610,7 +610,7 @@ 
      *
      * @param Request       $request Some request
      * @param AbstractRoute $route   Some route
-     * @param array         $param   A list of URI params
+     * @param array         $params   A list of URI params
      *
      * @see Respect\Rest\Request::$params
      *
@@ -630,7 +630,7 @@ 
     /**
      * Return routes matched by path
      *
-     * @return SplObjectStorage a list of routes matched by path
+     * @return \SplObjectStorage a list of routes matched by path
      */
     protected function getMatchedRoutesByPath()
     {
@@ -648,7 +648,7 @@ 
     /**
      * Sends an Allow header with allowed methods from a list
      *
-     * @param array $allowedMehods A list of allowed methods
+     * @param array $allowedMethods A list of allowed methods
      *
      * @return null sends an Allow header.
      */
@@ -661,7 +661,7 @@ 
      * Informs the PHP environment of a not allowed method alongside
      * its allowed methods for that path
      *
-     * @param array $allowedMehods A list of allowed methods
+     * @param array $allowedMethods A list of allowed methods
      *
      * @return null sends HTTP Status Line and Allow header.
      */
@@ -681,7 +681,7 @@ 
      * Handles a OPTIONS request, inform of the allowed methods and
      * calls custom OPTIONS handler (if any).
      *
-     * @param array $allowedMehods A list of allowed methods
+     * @param array $allowedMethods A list of allowed methods
      * @param \SplObjectStorage $matchedByPath A list of matched routes by path
      *
      * @return null sends Allow header.
@@ -725,7 +725,7 @@ 
      *
      * @see Respect\Rest\Request::$params
      *
-     * @return bool true if the route matches the request with that params
+     * @return boolean|null true if the route matches the request with that params
      */
     protected function matchRoute(
         Request $request,
@@ -742,9 +742,9 @@ 
     /**
      * Checks if a route matches its routines
      *
-     * @param SplObjectStorage $matchedByPath A list of routes matched by path
+     * @param \SplObjectStorage $matchedByPath A list of routes matched by path
      *
-     * @return bool true if route matches its routines
+     * @return Request|null true if route matches its routines
      */
     protected function routineMatch(\SplObjectStorage $matchedByPath)
     {

library/Respect/Rest/Routes/StaticValue.php

Doc Comments +5 added lines

@@ -17,6 +17,11 @@
     /** @var ReflectionFunctionAbstract */
     protected $reflection;
 
+    /**
+     * @param string $method
+     * @param string $pattern
+     * @param string $value
+     */
     public function __construct($method, $pattern, $value)
     {
         $this->value = $value;

library/Respect/Rest/Routines/AbstractCallbackList.php

Doc Comments +4 added lines

@@ -54,6 +54,10 @@
 
         return array_key_exists($key, $this);
     }
+
+    /**
+     * @param string $needle
+     */
     public function filterKeysContain($needle)
     {
         return array_filter($this->getKeys(), function ($key) use ($needle) {

library/Respect/Rest/Routines/AbstractSyncedRoutine.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /**
      * Executes the routine and return its result.
      *
-     * @param  Respect\Rest\Request $request
+     * @param  Request $request
      * @param  array                $params
      * @return mixed
      */