Cutelyst
2.13.0
|
Checks if the field value is a valid IP address. More...
#include <Cutelyst/Plugins/Utils/validatorip.h>
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()) | |
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. | |
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... | |
void | defaultValue (Context *c, ValidatorReturnType *result, const char *validatorName) 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 |
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... | |
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 occured while parsing input. More... | |
bool | trimBefore () const |
Returns true if the field value should be trimmed before validation. 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. | |
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.
Definition at line 44 of file validatorip.h.
Definition at line 50 of file validatorip.h.
ValidatorIp::ValidatorIp | ( | const QString & | field, |
Constraints | constraints = NoConstraint , |
||
const ValidatorMessages & | messages = ValidatorMessages() , |
||
const QString & | defValKey = QString() |
||
) |
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 26 of file validatorip.cpp.
|
overrideprotectedvirtual |
If validation succeeded, ValidatorReturnType::value will contain the input paramter value as QString.
Implements Cutelyst::ValidatorRule.
Definition at line 35 of file validatorip.cpp.
References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), validate(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().