Skip to content

Commit 2b9d83b

Browse files
vinklavinkla
committed
Remove unused uses and cleanup docblocs
1 parent 468b538 commit 2b9d83b

File tree

21 files changed

+78
-53
lines changed

21 files changed

+78
-53
lines changed

‎src/Auth/Provider/JWT.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ public function authenticate(Request $request, Route $route)
5454
*
5555
* @param \Illuminate\Http\Request $request
5656
*
57+
* @throws \Exception
58+
*
5759
* @return string
5860
*/
5961
protected function getToken(Request $request)

‎src/Auth/Provider/OAuth2.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,10 @@ public function __construct(ResourceServer $resource, $httpHeadersOnly = false)
5959
* Authenticate request with the OAuth 2.0 resource server.
6060
*
6161
* @param \Illuminate\Http\Request $request
62-
* @param \Illuminate\Routing\Route $route
62+
* @param \Dingo\Api\Routing\Route $route
6363
*
6464
* @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
65+
* @throws \Exception
6566
*
6667
* @return mixed
6768
*/

‎src/Exception/Handler.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44

55
use Exception;
66
use ReflectionFunction;
7-
use RecursiveArrayIterator;
87
use Dingo\Api\Http\Request;
98
use Illuminate\Http\Response;
10-
use RecursiveIteratorIterator;
119
use Illuminate\Contracts\Debug\ExceptionHandler;
1210
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
1311

‎src/Http/Middleware/Auth.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,32 @@
88

99
class Auth
1010
{
11+
/**
12+
* @var \Dingo\Api\Routing\Router
13+
*/
1114
protected $router;
1215

16+
/**
17+
* @var \Dingo\Api\Auth\Auth
18+
*/
1319
protected $auth;
1420

21+
/**
22+
* @param \Dingo\Api\Routing\Router $router
23+
* @param \Dingo\Api\Auth\Auth $auth
24+
*/
1525
public function __construct(Router $router, Authentication $auth)
1626
{
1727
$this->router = $router;
1828
$this->auth = $auth;
1929
}
2030

31+
/**
32+
* @param \Illuminate\Http\Request $request
33+
* @param \Closure $next
34+
*
35+
* @return mixed
36+
*/
2137
public function handle($request, Closure $next)
2238
{
2339
$route = $this->router->getCurrentRoute();

‎src/Http/Middleware/RateLimit.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
namespace Dingo\Api\Http\Middleware;
44

55
use Closure;
6-
use Dingo\Api\Routing\Route;
76
use Dingo\Api\Http\Response;
87
use Dingo\Api\Routing\Router;
98
use Dingo\Api\Http\RateLimit\Handler;
10-
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
119

1210
class RateLimit
1311
{

‎src/Http/Middleware/Request.php‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
namespace Dingo\Api\Http\Middleware;
44

55
use Closure;
6-
use ReflectionClass;
76
use Dingo\Api\Http\Validator;
87
use Dingo\Api\Routing\Router;
98
use Illuminate\Pipeline\Pipeline;

‎src/Http/Request.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
class Request extends IlluminateRequest
88
{
9+
/**
10+
* @param \Illuminate\Http\Request $old
11+
*
12+
* @return static
13+
*/
914
public static function createFromExisting(IlluminateRequest $old)
1015
{
1116
$new = new static(

‎src/Http/Response.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
use Dingo\Api\Transformer\Binding;
88
use Symfony\Component\HttpFoundation\Cookie;
99
use Illuminate\Http\Response as IlluminateResponse;
10-
use Illuminate\Support\Contracts\ArrayableInterface;
10+
use Illuminate\Contracts\Support\Arrayable;
1111
use Illuminate\Database\Eloquent\Model as EloquentModel;
1212
use Dingo\Api\Transformer\Factory as TransformerFactory;
1313
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
@@ -94,7 +94,7 @@ public function morph($format = 'json')
9494
$content = $formatter->formatEloquentModel($content);
9595
} elseif ($content instanceof EloquentCollection) {
9696
$content = $formatter->formatEloquentCollection($content);
97-
} elseif (is_array($content) || $content instanceof ArrayObject || $content instanceof ArrayableInterface) {
97+
} elseif (is_array($content) || $content instanceof ArrayObject || $content instanceof Arrayable) {
9898
$content = $formatter->formatArray($content);
9999
} else {
100100
$this->headers->set('content-type', $defaultContentType);
@@ -130,7 +130,7 @@ public function setContent($content)
130130
*
131131
* @throws \RuntimeException
132132
*
133-
* @return \Dingo\Api\Http\Format\FormatInterface
133+
* @return \Dingo\Api\Http\Response\Format\Format
134134
*/
135135
public static function getFormatter($format)
136136
{
@@ -168,7 +168,7 @@ public static function setFormatters(array $formatters)
168168
/**
169169
* Set the transformer factory instance.
170170
*
171-
* @param \Dingo\Api\Transformer\TransformerFactory $transformer
171+
* @param \Dingo\Api\Transformer\Factory $transformer
172172
*
173173
* @return void
174174
*/
@@ -180,7 +180,7 @@ public static function setTransformer(TransformerFactory $transformer)
180180
/**
181181
* Get the transformer instance.
182182
*
183-
* @return \Dingo\Api\Transformer\Transformer
183+
* @return \Dingo\Api\Transformer\Factory
184184
*/
185185
public static function getTransformer()
186186
{
@@ -193,7 +193,7 @@ public static function getTransformer()
193193
* @param string $key
194194
* @param mixed $value
195195
*
196-
* @return \Dingo\Api\Http\Response\Builder
196+
* @return \Dingo\Api\Http\Response
197197
*/
198198
public function addMeta($key, $value)
199199
{
@@ -208,7 +208,7 @@ public function addMeta($key, $value)
208208
* @param string $key
209209
* @param mixed $value
210210
*
211-
* @return \Dingo\Api\Http\Response\Builder
211+
* @return \Dingo\Api\Http\Response
212212
*/
213213
public function meta($key, $value)
214214
{
@@ -220,7 +220,7 @@ public function meta($key, $value)
220220
*
221221
* @param array $meta
222222
*
223-
* @return \Dingo\Api\Http\Response\Builder
223+
* @return \Dingo\Api\Http\Response
224224
*/
225225
public function setMeta(array $meta)
226226
{
@@ -244,7 +244,7 @@ public function getMeta()
244244
*
245245
* @param \Symfony\Component\HttpFoundation\Cookie $cookie
246246
*
247-
* @return \Dingo\Api\Http\Response\Builder
247+
* @return \Dingo\Api\Http\Response
248248
*/
249249
public function cookie(Cookie $cookie)
250250
{
@@ -254,11 +254,11 @@ public function cookie(Cookie $cookie)
254254
/**
255255
* Add a header to the response.
256256
*
257-
* @param string $name
257+
* @param string $key
258258
* @param string $value
259259
* @param bool $replace
260260
*
261-
* @return \Dingo\Api\Http\Response\Builder
261+
* @return \Dingo\Api\Http\Response
262262
*/
263263
public function withHeader($key, $value, $replace = true)
264264
{
@@ -270,7 +270,7 @@ public function withHeader($key, $value, $replace = true)
270270
*
271271
* @param int $statusCode
272272
*
273-
* @return \Dingo\Api\Http\Response\Builder
273+
* @return \Dingo\Api\Http\Response
274274
*/
275275
public function statusCode($statusCode)
276276
{

‎src/Http/Response/Factory.php‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function __construct(TransformerFactory $transformer)
3737
*
3838
* @param null|string $location
3939
*
40-
* @return \Dingo\Api\Http\Response\Builder
40+
* @return \Dingo\Api\Http\Response
4141
*/
4242
public function created($location = null)
4343
{
@@ -54,7 +54,7 @@ public function created($location = null)
5454
/**
5555
* Respond with a no content response.
5656
*
57-
* @return \Dingo\Api\Http\Response\Builder
57+
* @return \Dingo\Api\Http\Response
5858
*/
5959
public function noContent()
6060
{
@@ -71,7 +71,7 @@ public function noContent()
7171
* @param array $parameters
7272
* @param \Closure $after
7373
*
74-
* @return \Dingo\Api\Http\Response\Builder
74+
* @return \Dingo\Api\Http\Response
7575
*/
7676
public function collection(Collection $collection, $transformer, array $parameters = [], Closure $after = null)
7777
{
@@ -94,7 +94,7 @@ public function collection(Collection $collection, $transformer, array $paramete
9494
* @param array $parameters
9595
* @param \Closure $after
9696
*
97-
* @return \Dingo\Api\Http\Response\Builder
97+
* @return \Dingo\Api\Http\Response
9898
*/
9999
public function item($item, $transformer, array $parameters = [], Closure $after = null)
100100
{
@@ -113,7 +113,7 @@ public function item($item, $transformer, array $parameters = [], Closure $after
113113
* @param array $parameters
114114
* @param \Closure $after
115115
*
116-
* @return \Dingo\Api\Http\Response\Builder
116+
* @return \Dingo\Api\Http\Response
117117
*/
118118
public function paginator(Paginator $paginator, $transformer, array $parameters = [], Closure $after = null)
119119
{
@@ -134,9 +134,9 @@ public function paginator(Paginator $paginator, $transformer, array $parameters
134134
* @param string $message
135135
* @param int $statusCode
136136
*
137-
* @return void
138-
*
139137
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
138+
*
139+
* @return void
140140
*/
141141
public function error($message, $statusCode)
142142
{
@@ -148,9 +148,9 @@ public function error($message, $statusCode)
148148
*
149149
* @param string $message
150150
*
151-
* @return void
152-
*
153151
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
152+
*
153+
* @return void
154154
*/
155155
public function errorNotFound($message = 'Not Found')
156156
{
@@ -162,9 +162,10 @@ public function errorNotFound($message = 'Not Found')
162162
*
163163
* @param string $message
164164
*
165+
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
166+
*
165167
* @return void
166168
*
167-
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
168169
*/
169170
public function errorBadRequest($message = 'Bad Request')
170171
{
@@ -176,9 +177,9 @@ public function errorBadRequest($message = 'Bad Request')
176177
*
177178
* @param string $message
178179
*
179-
* @return void
180-
*
181180
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
181+
*
182+
* @return void
182183
*/
183184
public function errorForbidden($message = 'Forbidden')
184185
{
@@ -190,9 +191,9 @@ public function errorForbidden($message = 'Forbidden')
190191
*
191192
* @param string $message
192193
*
193-
* @return void
194-
*
195194
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
195+
*
196+
* @return void
196197
*/
197198
public function errorInternal($message = 'Internal Error')
198199
{
@@ -204,9 +205,9 @@ public function errorInternal($message = 'Internal Error')
204205
*
205206
* @param string $message
206207
*
207-
* @return void
208-
*
209208
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
209+
*
210+
* @return void
210211
*/
211212
public function errorUnauthorized($message = 'Unauthorized')
212213
{

‎src/Http/Response/Format/Format.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ abstract class Format
2323
*
2424
* @param \Illuminate\Http\Request $request
2525
*
26-
* @return \Dingo\Api\Http\ResponseFormat\ResponseFormat
26+
* @return \Dingo\Api\Http\Response\Format\Format
2727
*/
2828
public function setRequest($request)
2929
{
@@ -37,7 +37,7 @@ public function setRequest($request)
3737
*
3838
* @param \Illuminate\Http\Response $response
3939
*
40-
* @return \Dingo\Api\Http\ResponseFormat\ResponseFormat
40+
* @return \Dingo\Api\Http\Response\Format\Format
4141
*/
4242
public function setResponse($response)
4343
{
@@ -65,9 +65,9 @@ abstract public function formatEloquentModel($model);
6565
abstract public function formatEloquentCollection($collection);
6666

6767
/**
68-
* Format an array or instance implementing ArrayableInterface.
68+
* Format an array or instance implementing Arrayable.
6969
*
70-
* @param array|\Illuminate\Support\Contracts\ArrayableInterface $content
70+
* @param array|\Illuminate\Contracts\Support\Arrayable $content
7171
*
7272
* @return string
7373
*/

0 commit comments

Comments
 (0)