diff --git a/src/ApiServiceProvider.php b/src/ApiServiceProvider.php index d9af2ada..f329d4ca 100644 --- a/src/ApiServiceProvider.php +++ b/src/ApiServiceProvider.php @@ -33,7 +33,7 @@ public function boot() /** * Boot the container bindings. - * + * * @return void */ protected function bootContainerBindings() @@ -53,7 +53,7 @@ protected function bootContainerBindings() /** * Boot the response facade macro. - * + * * @return void */ protected function bootResponseMacro() @@ -65,7 +65,7 @@ protected function bootResponseMacro() /** * Boot the response transformer. - * + * * @return void */ protected function bootResponseTransformer() @@ -100,7 +100,7 @@ protected function bootResponseFormats() /** * Boot the current route and the authentication. - * + * * @return void */ protected function bootRouteAndAuthentication() @@ -142,7 +142,7 @@ public function register() /** * Register the booting event. - * + * * @return void */ protected function registerBootingEvent() @@ -180,7 +180,7 @@ protected function registerRouter() /** * Register the API response builder. - * + * * @return void */ protected function registerResponseBuilder() diff --git a/src/Auth/LeagueOAuth2Provider.php b/src/Auth/LeagueOAuth2Provider.php index a882d1b4..918ac2ef 100644 --- a/src/Auth/LeagueOAuth2Provider.php +++ b/src/Auth/LeagueOAuth2Provider.php @@ -27,14 +27,14 @@ class LeagueOAuth2Provider extends AuthorizationProvider /** * Callback to fetch a user. - * + * * @var callable */ protected $userCallback; /** * Callback to fetch a client. - * + * * @var callable */ protected $clientCallback; @@ -89,7 +89,7 @@ public function authenticate(Request $request, Route $route) /** * Resolve the resource owner. - * + * * @return mixed */ protected function resolveResourceOwner() @@ -116,7 +116,7 @@ protected function getRouteScopes(Route $route) /** * Set the callback to fetch a user. - * + * * @param callable $callback * @return \Dingo\Api\Auth\LeagueOAuth2Provider */ @@ -129,7 +129,7 @@ public function setUserCallback(callable $callback) /** * Set the callback to fetch a client. - * + * * @param callable $callback * @return \Dingo\Api\Auth\LeagueOAuth2Provider */ diff --git a/src/Auth/Shield.php b/src/Auth/Shield.php index 5d1e2e90..5920a4d3 100644 --- a/src/Auth/Shield.php +++ b/src/Auth/Shield.php @@ -50,14 +50,14 @@ class Shield /** * Illuminate request instance. - * + * * @var \Illuminate\Http\Request */ protected $request; /** * Illuminate route instance. - * + * * @var \Illumimate\Routing\Route */ protected $route; @@ -181,7 +181,7 @@ public function getProviderUsed() /** * Set the request instance. - * + * * @param \Illuminate\Routing\Route $route * @return \Dingo\Api\Auth\Shield */ @@ -194,7 +194,7 @@ public function setRequest(Request $request) /** * Set the route instance. - * + * * @param \Illuminate\Routing\Route $route * @return \Dingo\Api\Auth\Shield */ diff --git a/src/Dispatcher.php b/src/Dispatcher.php index 349596aa..a67685e0 100644 --- a/src/Dispatcher.php +++ b/src/Dispatcher.php @@ -75,7 +75,7 @@ class Dispatcher /** * Request uploaded files. - * + * * @var array */ protected $files = []; @@ -118,7 +118,7 @@ protected function setupRequestStack() /** * Attach files to be uploaded. - * + * * @param array $files * @return \Dingo\Api\Dispatcher */ diff --git a/src/Http/Middleware/Authentication.php b/src/Http/Middleware/Authentication.php index d042d825..06305e1b 100644 --- a/src/Http/Middleware/Authentication.php +++ b/src/Http/Middleware/Authentication.php @@ -105,7 +105,7 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ /** * Get the API route collection for the given request. - * + * * @param \Symfony\Component\HttpFoundation\Request $request * @return \Dingo\Api\Routing\ApiRouteCollection */ diff --git a/src/Http/ResponseBuilder.php b/src/Http/ResponseBuilder.php index f0e40961..a68973aa 100644 --- a/src/Http/ResponseBuilder.php +++ b/src/Http/ResponseBuilder.php @@ -37,14 +37,14 @@ class ResponseBuilder /** * The Fractal serializer. - * + * * @var \League\Fractal\Serializer\SerializerAbstract */ protected $serializer; /** * Array of meta data. - * + * * @var array */ protected $meta = []; @@ -125,7 +125,7 @@ public function withArray(array $array) /** * Return an error response. - * + * * @param string|array $error * @param int $statusCode * @return \Illuminate\Http\Response @@ -143,7 +143,7 @@ public function withError($error, $statusCode) /** * Add a Fractal meta key and value pair. - * + * * @param string $key * @param mixed $value * @return \Dingo\Api\Http\ResponseBuilder @@ -157,7 +157,7 @@ public function addMeta($key, $value) /** * Add a Fractal meta key and value pair. - * + * * @param string $key * @param mixed $value * @return \Dingo\Api\Http\ResponseBuilder @@ -198,7 +198,7 @@ protected function build($data) /** * Reset this response builder instance. - * + * * @return void */ protected function reset() @@ -225,7 +225,7 @@ public function addHeader($name, $value) /** * Add an array of headers. - * + * * @param array $headers * @return \Dingo\Api\Http\ResponseBuilder */ @@ -238,7 +238,7 @@ public function addHeaders(array $headers) /** * Add a header to the response. - * + * * @param string $name * @param string $value * @return \Dingo\Api\Http\ResponseBuilder @@ -250,7 +250,7 @@ public function header($name, $value) /** * Add an array of headers. - * + * * @param array $headers * @return \Dingo\Api\Http\ResponseBuilder */ @@ -274,7 +274,7 @@ public function setStatusCode($statusCode) /** * Return a 404 not found error. - * + * * @param string|array $message * @return \Illuminate\Http\Response */ @@ -285,7 +285,7 @@ public function errorNotFound($message = 'Not Found') /** * Return a 400 bad request error. - * + * * @param string|array $message * @return \Illuminate\Http\Response */ @@ -296,7 +296,7 @@ public function errorBadRequest($message = 'Bad Request') /** * Return a 403 forbidden error. - * + * * @param string|array $message * @return \Illuminate\Http\Response */ @@ -307,7 +307,7 @@ public function errorForbidden($message = 'Forbidden') /** * Return a 500 internal server error. - * + * * @param string|array $message * @return \Illuminate\Http\Response */ @@ -318,7 +318,7 @@ public function errorInternal($message = 'Internal Error') /** * Return a 401 unauthorized error. - * + * * @param string|array $message * @return \Illuminate\Http\Response */ @@ -329,7 +329,7 @@ public function errorUnauthorized($message = 'Unauthorized') /** * Set the Fractal serializer. - * + * * @param \League\Fractal\Serializer\SerializerAbstract $serializer * @return \Dingo\Api\Http\ResponseBuilder */ @@ -342,7 +342,7 @@ public function setSerializer(SerializerAbstract $serializer) /** * Set the Fractal serializer. - * + * * @param \League\Fractal\Serializer\SerializerAbstract $serializer * @return \Dingo\Api\Http\ResponseBuilder */ diff --git a/src/Http/ResponseFormat/JsonpResponseFormat.php b/src/Http/ResponseFormat/JsonpResponseFormat.php index faaa0eb0..635a711f 100644 --- a/src/Http/ResponseFormat/JsonpResponseFormat.php +++ b/src/Http/ResponseFormat/JsonpResponseFormat.php @@ -24,7 +24,7 @@ protected function hasValidCallback() /** * Get the callback from the query string. - * + * * @return string */ protected function getCallback() diff --git a/src/Http/ResponseFormat/ResponseFormat.php b/src/Http/ResponseFormat/ResponseFormat.php index f815c76a..87bfaf26 100644 --- a/src/Http/ResponseFormat/ResponseFormat.php +++ b/src/Http/ResponseFormat/ResponseFormat.php @@ -13,7 +13,7 @@ abstract class ResponseFormat /** * Set the request intance. - * + * * @param \Illuminate\Http\Request $request * @return \Dingo\Api\Http\ResponseFormat\ResponseFormat */ diff --git a/src/Routing/Controller.php b/src/Routing/Controller.php index 89882c87..98c33c77 100644 --- a/src/Routing/Controller.php +++ b/src/Routing/Controller.php @@ -25,7 +25,7 @@ abstract class Controller extends IlluminateController /** * API response builder instance. - * + * * @var \Dingo\Api\Http\ResponseBuilder */ protected $response; @@ -144,7 +144,7 @@ public function getScopedMethods() /** * Magically handle calls to the response builder. - * + * * @param string $method * @param array $parameters * @return mixed diff --git a/src/Routing/Router.php b/src/Routing/Router.php index d5acbcde..d090659f 100644 --- a/src/Routing/Router.php +++ b/src/Routing/Router.php @@ -368,7 +368,7 @@ public function getApiRouteCollectionFromRequest(Request $request) /** * Get the default API route collection. - * + * * @return \Dingo\Api\Routing\ApiRouteCollection|null */ public function getDefaultApiRouteCollection()