Checks if the field value is a valid IP address. More...
#include <Cutelyst/Plugins/Utils/validatorip.h>
Inheritance diagram for Cutelyst::ValidatorIp:
Public Types | |
| enum | Constraint { NoConstraint , IPv4Only , IPv6Only , NoPrivateRange , NoReservedRange , NoMultiCast , PublicOnly } |
| Acceptable address ranges. More... | |
Public Member Functions | |
| ValidatorIp (const QString &field, Constraints constraints=NoConstraint, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString()) | |
| Constructs a new ip validator. More... | |
| ~ValidatorIp () override | |
| Deconstructs the ip validator. | |
 Public Member Functions inherited from Cutelyst::ValidatorRule | |
| ValidatorRule (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString(), QByteArrayView validatorName=nullptr) | |
| Constructs a new ValidatorRule with the given parameters. More... | |
| virtual | ~ValidatorRule () |
| Deconstructs the ValidatorRule. | |
Static Public Member Functions | |
| static bool | validate (const QString &value, Constraints constraints=NoConstraint) |
Returns true if value is a valid IP address within the constraints. More... | |
Protected Member Functions | |
| QString | genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override |
| Returns a generic error message if validation failed. More... | |
| ValidatorReturnType | validate (Context *c, const ParamsMultiMap ¶ms) const override |
| Performs the validation and returns the result. More... | |
| Protected Member Functions inherited from Cutelyst::ValidatorRule | |
| ValidatorRule (ValidatorRulePrivate &dd) | |
| Constructs a new ValidatorRule object with the given private class. More... | |
| QString | debugString (Context *c) const |
| Returns a string that can be used for debug output if validation fails. More... | |
| void | defaultValue (Context *c, ValidatorReturnType *result) const |
| I a defValKey has been set in the constructor, this will try to get the default value from the stash and put it into the result. More... | |
| QString | field () const noexcept |
| Returns the name of the field to validate. More... | |
| virtual QString | genericParsingError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a generic error message if an error occures while parsing input. More... | |
| virtual QString | genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a generic error message if any validation data is missing or invalid. More... | |
| virtual QString | genericValidationError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a generic error mesage if validation failed. More... | |
| QString | label (Context *c) const |
| Returns the human readable field label used for generic error messages. More... | |
| QString | parsingError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns an error message if an error occurred while parsing input. More... | |
| bool | trimBefore () const noexcept |
| Returns true if the field value should be trimmed before validation. More... | |
| virtual ValidatorReturnType | validate (Context *c, const ParamsMultiMap ¶ms) const =0 |
| Starts the validation and returns the result. More... | |
| QString | validationDataError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns an error message if any validation data is missing or invalid. More... | |
| QString | validationError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a descriptive error message if validation failed. More... | |
| QString | value (const ParamsMultiMap ¶ms) const |
| Returns the value of the field from the input params. More... | |
Detailed Description
This uses QHostAddress internally to check if the field contains a valid IP address. You can use the constraints flags to limit the validator to specific address ranges.
- Note
- Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. If the field's value is empty or if the field is missing in the input data, the validation will succeed without performing the validation itself. Use one of the required validators to require the field to be present and not empty.
- See also
- Validator for general usage of validators.
Definition at line 33 of file validatorip.h.
Member Enumeration Documentation
◆ Constraint
Definition at line 39 of file validatorip.h.
Constructor & Destructor Documentation
◆ ValidatorIp()
| ValidatorIp::ValidatorIp | ( | const QString & | field, |
| Constraints | constraints = NoConstraint, |
||
| const ValidatorMessages & | messages = ValidatorMessages(), |
||
| const QString & | defValKey = QString() |
||
| ) |
- Parameters
-
field Name of the input field to validate. constraints Optional validation constraints. messages Custom error message if validation fails. defValKey Stash key containing a default value if input field is empty. This value will NOT be validated.
Definition at line 17 of file validatorip.cpp.
Member Function Documentation
◆ genericValidationError()
|
overrideprotectedvirtual |
Reimplemented from Cutelyst::ValidatorRule.
Definition at line 256 of file validatorip.cpp.
References Cutelyst::ValidatorRule::label(), and Cutelyst::Context::translate().
◆ validate()
|
overrideprotectedvirtual |
If validation succeeded, ValidatorReturnType::value will contain the input paramter value as QString.
Implements Cutelyst::ValidatorRule.
Definition at line 27 of file validatorip.cpp.
References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, validate(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().
