Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 75662da

Browse files
committed
Remove dupicated declarations in phpdocs
1 parent 9fe1331 commit 75662da

23 files changed

+0
-182
lines changed

src/AppFactory.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ final class AppFactory
4141
* instance
4242
* @param null|Router\RouterInterface $router Router implementation to use;
4343
* defaults to the FastRoute router bridge.
44-
* @return Application
4544
* @throws Exception\MissingDependencyException if the container was not
4645
* provided and the ServiceManager class is not present.
4746
* @throws Exception\MissingDependencyException if the router was not

src/Application.php

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,9 @@ class Application extends MiddlewarePipe
8181
private $responsePrototype;
8282

8383
/**
84-
* Constructor
85-
*
8684
* Calls on the parent constructor, and then uses the provided arguments
8785
* to set internal properties.
8886
*
89-
* @param Router\RouterInterface $router
9087
* @param null|ContainerInterface $container IoC container from which to pull services, if any.
9188
* @param null|RequestHandlerInterface $defaultDelegate Default delegate
9289
* to use when $out is not provided on invocation / run() is invoked.
@@ -109,65 +106,53 @@ public function __construct(
109106
}
110107

111108
/**
112-
* @param string|Router\Route $path
113109
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
114110
* @param null|string $name The name of the route.
115-
* @return Router\Route
116111
*/
117112
public function get($path, $middleware, string $name = null) : Router\Route
118113
{
119114
return $this->route($path, $middleware, ['GET'], $name);
120115
}
121116

122117
/**
123-
* @param string|Router\Route $path
124118
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
125119
* @param null|string $name The name of the route.
126-
* @return Router\Route
127120
*/
128121
public function post($path, $middleware, $name = null) : Router\Route
129122
{
130123
return $this->route($path, $middleware, ['POST'], $name);
131124
}
132125

133126
/**
134-
* @param string|Router\Route $path
135127
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
136128
* @param null|string $name The name of the route.
137-
* @return Router\Route
138129
*/
139130
public function put($path, $middleware, string $name = null) : Router\Route
140131
{
141132
return $this->route($path, $middleware, ['PUT'], $name);
142133
}
143134

144135
/**
145-
* @param string|Router\Route $path
146136
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
147137
* @param null|string $name The name of the route.
148-
* @return Router\Route
149138
*/
150139
public function patch($path, $middleware, string $name = null) : Router\Route
151140
{
152141
return $this->route($path, $middleware, ['PATCH'], $name);
153142
}
154143

155144
/**
156-
* @param string|Router\Route $path
157145
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
158146
* @param null|string $name The name of the route.
159-
* @return Router\Route
160147
*/
161148
public function delete($path, $middleware, string $name = null) : Router\Route
162149
{
163150
return $this->route($path, $middleware, ['DELETE'], $name);
164151
}
165152

166153
/**
167-
* @param string|Router\Route $path
168154
* @param callable|string $middleware Middleware (or middleware service name) to associate with route.
169155
* @param null|string $name The name of the route.
170-
* @return Router\Route
171156
*/
172157
public function any($path, $middleware, string $name = null) : Router\Route
173158
{
@@ -206,7 +191,6 @@ public function any($path, $middleware, string $name = null) : Router\Route
206191
*
207192
* @param string|array|callable $path Either a URI path prefix, or middleware.
208193
* @param null|string|array|callable $middleware Middleware
209-
* @return self
210194
*/
211195
public function pipe($path, $middleware = null) : parent
212196
{
@@ -254,8 +238,6 @@ public function pipe($path, $middleware = null) : parent
254238

255239
/**
256240
* Register the routing middleware in the middleware pipeline.
257-
*
258-
* @return void
259241
*/
260242
public function pipeRoutingMiddleware() : void
261243
{
@@ -267,8 +249,6 @@ public function pipeRoutingMiddleware() : void
267249

268250
/**
269251
* Register the dispatch middleware in the middleware pipeline.
270-
*
271-
* @return void
272252
*/
273253
public function pipeDispatchMiddleware() : void
274254
{
@@ -334,10 +314,6 @@ public function getRoutes() : iterable
334314
*
335315
* Once it has processed itself, it emits the returned response using the
336316
* composed emitter.
337-
*
338-
* @param null|ServerRequestInterface $request
339-
* @param null|ResponseInterface $response
340-
* @return void
341317
*/
342318
public function run(ServerRequestInterface $request = null, ResponseInterface $response = null) : void
343319
{
@@ -364,7 +340,6 @@ public function run(ServerRequestInterface $request = null, ResponseInterface $r
364340
*
365341
* If no IoC container is registered, we raise an exception.
366342
*
367-
* @return ContainerInterface
368343
* @throws Exception\ContainerNotRegisteredException
369344
*/
370345
public function getContainer() : ContainerInterface
@@ -384,8 +359,6 @@ public function getContainer() : ContainerInterface
384359
* service, pulls that service, assigns it, and returns it.
385360
* - If no container is composed, creates an instance of Delegate\NotFoundDelegate
386361
* using the current response prototype only (i.e., no templating).
387-
*
388-
* @return RequestHandlerInterface
389362
*/
390363
public function getDefaultDelegate() : RequestHandlerInterface
391364
{
@@ -413,8 +386,6 @@ public function getDefaultDelegate() : RequestHandlerInterface
413386
*
414387
* If none was registered during instantiation, this will lazy-load an
415388
* EmitterStack composing an SapiEmitter instance.
416-
*
417-
* @return EmitterInterface
418389
*/
419390
public function getEmitter() : EmitterInterface
420391
{
@@ -432,8 +403,6 @@ public function getEmitter() : EmitterInterface
432403
* if so, and it responds to any of the $methods indicated, raises
433404
* a DuplicateRouteException indicating a duplicate route.
434405
*
435-
* @param string $path
436-
* @param null|array $methods
437406
* @throws Exception\DuplicateRouteException on duplicate route detection.
438407
*/
439408
private function checkForDuplicateRoute(string $path, array $methods = null) : void
@@ -463,10 +432,6 @@ private function checkForDuplicateRoute(string $path, array $methods = null) : v
463432
}
464433
}
465434

466-
/**
467-
* @param Throwable $exception
468-
* @return void
469-
*/
470435
private function emitMarshalServerRequestException(Throwable $exception) : void
471436
{
472437
if ($this->container && $this->container->has(Middleware\ErrorResponseGenerator::class)) {

src/ApplicationConfigInjectionTrait.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ trait ApplicationConfigInjectionTrait
6767
*
6868
* @param null|array $config If null, attempts to pull the 'config' service
6969
* from the composed container.
70-
* @return void
7170
*/
7271
public function injectPipelineFromConfig(array $config = null) : void
7372
{
@@ -136,7 +135,6 @@ public function injectPipelineFromConfig(array $config = null) : void
136135
*
137136
* @param null|array $config If null, attempts to pull the 'config' service
138137
* from the composed container.
139-
* @return void
140138
* @throws Exception\InvalidArgumentException
141139
*/
142140
public function injectRoutesFromConfig(array $config = null) : void
@@ -202,7 +200,6 @@ public function injectRoutesFromConfig(array $config = null) : void
202200
* If the 'middleware' value is missing, or not viable as middleware, it
203201
* raises an exception, to ensure the pipeline is built correctly.
204202
*
205-
* @return callable
206203
* @throws Exception\InvalidArgumentException
207204
*/
208205
private function createCollectionMapper() : callable
@@ -240,8 +237,6 @@ private function createCollectionMapper() : callable
240237
*
241238
* The function is useful to reduce an array of pipeline middleware to a
242239
* priority queue.
243-
*
244-
* @return callable
245240
*/
246241
private function createPriorityQueueReducer()
247242
{

src/Container/ApplicationFactory.php

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ class ApplicationFactory
5454
*
5555
* See the class level docblock for information on what services this
5656
* factory will optionally consume.
57-
*
58-
* @param ContainerInterface $container
59-
* @return Application
6057
*/
6158
public function __invoke(ContainerInterface $container) : Application
6259
{
@@ -86,10 +83,6 @@ public function __invoke(ContainerInterface $container) : Application
8683

8784
/**
8885
* Injects routes and the middleware pipeline into the application.
89-
*
90-
* @param Application $app
91-
* @param array $config
92-
* @return void
9386
*/
9487
private function injectRoutesAndPipeline(Application $app, array $config) : void
9588
{

src/Container/ErrorHandlerFactory.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@
1616

1717
class ErrorHandlerFactory
1818
{
19-
/**
20-
* @param ContainerInterface $container
21-
* @return ErrorHandler
22-
*/
2319
public function __invoke(ContainerInterface $container) : ErrorHandler
2420
{
2521
$generator = $container->has(ErrorResponseGenerator::class)

src/Container/ErrorResponseGeneratorFactory.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@
1515

1616
class ErrorResponseGeneratorFactory
1717
{
18-
/**
19-
* @param ContainerInterface $container
20-
* @return ErrorResponseGenerator
21-
*/
2218
public function __invoke(ContainerInterface $container) : ErrorResponseGenerator
2319
{
2420
$config = $container->has('config') ? $container->get('config') : [];

src/Container/NotFoundDelegateFactory.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@
1616

1717
class NotFoundDelegateFactory
1818
{
19-
/**
20-
* @param ContainerInterface $container
21-
* @return NotFoundDelegate
22-
*/
2319
public function __invoke(ContainerInterface $container) : NotFoundDelegate
2420
{
2521
$config = $container->has('config') ? $container->get('config') : [];

src/Container/NotFoundHandlerFactory.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@
1515

1616
class NotFoundHandlerFactory
1717
{
18-
/**
19-
* @param ContainerInterface $container
20-
* @return NotFoundHandler
21-
*/
2218
public function __invoke(ContainerInterface $container) : NotFoundHandler
2319
{
2420
return new NotFoundHandler($container->get(NotFoundDelegate::class));

src/Container/WhoopsErrorResponseGeneratorFactory.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@
1414

1515
class WhoopsErrorResponseGeneratorFactory
1616
{
17-
/**
18-
* @param ContainerInterface $container
19-
* @return WhoopsErrorResponseGenerator
20-
*/
2117
public function __invoke(ContainerInterface $container) : WhoopsErrorResponseGenerator
2218
{
2319
return new WhoopsErrorResponseGenerator(

src/Container/WhoopsFactory.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@ class WhoopsFactory
4444
{
4545
/**
4646
* Create and return an instance of the Whoops runner.
47-
*
48-
* @param ContainerInterface $container
49-
* @return Whoops
5047
*/
5148
public function __invoke(ContainerInterface $container) : Whoops
5249
{

0 commit comments

Comments
 (0)