Wikibase\Repo\Validators\NotEntityIdValidator Class Reference
Validator for checking that a given string is NOT an EntityId. More...
Inheritance diagram for Wikibase\Repo\Validators\NotEntityIdValidator:
Collaboration diagram for Wikibase\Repo\Validators\NotEntityIdValidator:
Public Member Functions | |
| __construct (EntityIdParser $idParser, $errorCode, array $forbiddenTypes=null) | |
| validate ( $value) | |
| setOptions (array $options) | |
Private Attributes | |
| $idParser | |
| $errorCode | |
| $forbiddenTypes | |
Detailed Description
Validator for checking that a given string is NOT an EntityId.
Useful e.g. for preventing property labels that "look like" property IDs.
- Copyright
- GPL-2.0-or-later
Constructor & Destructor Documentation
◆ __construct()
| Wikibase\Repo\Validators\NotEntityIdValidator::__construct | ( | EntityIdParser | $idParser, |
| $errorCode, | |||
| array | $forbiddenTypes = null |
||
| ) |
- Parameters
-
EntityIdParser $idParser The parser to use for testing whether a string is an entity ID. string $errorCode The error code to use when this validator fails. string[] | null $forbiddenTypes A list of entity types who's IDs should be considered invalid values. If null, all valid entity IDs are considered invalid input.
- Exceptions
-
InvalidArgumentException
Member Function Documentation
◆ setOptions()
| Wikibase\Repo\Validators\NotEntityIdValidator::setOptions | ( | array | $options | ) |
- See also
- ValueValidator::setOptions()
- Parameters
-
array $options
◆ validate()
| Wikibase\Repo\Validators\NotEntityIdValidator::validate | ( | $value | ) |
- See also
- ValueValidator::validate()
- Parameters
-
string $value The value to validate
- Returns
- Result
Member Data Documentation
◆ $errorCode
|
private |
◆ $forbiddenTypes
|
private |
◆ $idParser
|
private |
The documentation for this class was generated from the following file:
- repo/includes/Validators/NotEntityIdValidator.php
