Skip to content

Commit

Permalink
Improve documented types for filter() and correct language in doc-b…
Browse files Browse the repository at this point in the history
…lock descriptions

Signed-off-by: George Steel <[email protected]>
  • Loading branch information
gsteel committed Nov 2, 2023
1 parent c42f7a7 commit 1f56f4e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/AllowList.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function getStrict()
}

/**
* Set the list of items to white-list.
* Set the list of items to allow
*
* @param array|Traversable $list
*/
Expand All @@ -71,7 +71,7 @@ public function setList($list = []): void
}

/**
* Get the list of items to white-list
* Get the list of items to allow
*
* @return array
*/
Expand All @@ -83,7 +83,11 @@ public function getList()
/**
* {@inheritDoc}
*
* Will return $value if its present in the white-list. If $value is rejected then it will return null.
* Will return $value if its present in the allow-list. If $value is rejected then it will return null.
*
* @template T
* @param T $value
* @return T|null
*/
public function filter(mixed $value): mixed
{
Expand Down

0 comments on commit 1f56f4e

Please sign in to comment.