Skip to content

Commit e6d9ded

Browse files
committed
docs: update doc comments
1 parent 8f0e20d commit e6d9ded

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

system/Filters/Filters.php

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
class Filters
3030
{
3131
/**
32-
* The original config file
32+
* The Config\Filters instance
3333
*
3434
* @var FiltersConfig
3535
*/
@@ -50,15 +50,14 @@ class Filters
5050
protected $response;
5151

5252
/**
53-
* Handle to the modules config.
53+
* The Config\Modules instance
5454
*
5555
* @var Modules
5656
*/
5757
protected $modules;
5858

5959
/**
60-
* Whether we've done initial processing
61-
* on the filter lists.
60+
* Whether we've done initial processing on the filter lists.
6261
*
6362
* @var bool
6463
*/
@@ -94,8 +93,8 @@ class Filters
9493
];
9594

9695
/**
97-
* The collection of filter class names and its arguments to execute for the
98-
* current request (URI path).
96+
* The collection of filter classnames and their arguments to execute for
97+
* the current request (URI path).
9998
*
10099
* This does not include "Required Filters".
101100
*
@@ -163,10 +162,10 @@ public function __construct($config, RequestInterface $request, ResponseInterfac
163162

164163
/**
165164
* If discoverFilters is enabled in Config then system will try to
166-
* auto-discover custom filters files in Namespaces and allow access to
167-
* the config object via the variable $filters as with the routes file
165+
* auto-discover custom filters files in namespaces and allow access to
166+
* the config object via the variable $filters as with the routes file.
168167
*
169-
* Sample :
168+
* Sample:
170169
* $filters->aliases['custom-auth'] = \Acme\Blob\Filters\BlobAuth::class;
171170
*
172171
* @deprecated 4.4.2 Use Registrar instead.
@@ -204,8 +203,8 @@ public function setResponse(ResponseInterface $response)
204203
}
205204

206205
/**
207-
* Runs through all of the filters for the specified
208-
* uri and position.
206+
* Runs through all the filters (except "Required Filters") for the specified
207+
* URI and position.
209208
*
210209
* @param string $uri URI path relative to baseURL
211210
* @phpstan-param 'before'|'after' $position

0 commit comments

Comments
 (0)