Cutelyst  1.5.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorRequiredWith Class Reference

The field under validation must be present and not empty only if any of the other specified fields are present. More...

#include <validatorrequiredwith.h>

Inheritance diagram for Cutelyst::ValidatorRequiredWith:
Inheritance graph
[legend]

Public Member Functions

 ValidatorRequiredWith (const QString &field, const QStringList &otherFields, const QString &label=QString(), const QString &customError=QString())
 Constructs a new required with validator. More...
 
 ~ValidatorRequiredWith ()
 Deconstructs the required with validator.
 
void setOtherFields (const QStringList &otherFields)
 Sets the list of other fields.
 
QString validate () const override
 Performs the validation and returns an empty QString on success, otherwise an error message.
 
- Public Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (const QString &field, const QString &label=QString(), const QString &customError=QString())
 Constructs a new ValidatorRule with given parameters and parent. More...
 
 ~ValidatorRule ()
 Deconstructs the ValidatorRule.
 
QString field () const
 Returns the name of the field to validate. More...
 
QString label () const
 Returns the human readable field label used for generic error messages. More...
 
ParamsMultiMap parameters () const
 Returns the parameters to validate. More...
 
void setCustomError (const QString &customError)
 Sets a cutom error returned with errorMessage() More...
 
void setCustomParsingError (const QString &custom)
 Sets a custom error message that is shown if parsing of input data fails. More...
 
void setCustomValidationDataError (const QString &custom)
 Sets a custom error message if validation data is invalid or missing. More...
 
void setField (const QString &field)
 Sets the name of the field to validate. More...
 
void setLabel (const QString &label)
 Sets human readable field label for generic error messages. More...
 
void setParameters (const ParamsMultiMap &params)
 Sets the request parameters to validate. More...
 
void setTrimBefore (bool trimBefore)
 Set to false to not trim input value before validation. More...
 
bool trimBefore () const
 Returns true if field value should be trimmed before validation. More...
 
QString value () const
 Returns the field value.
 

Protected Member Functions

 ValidatorRequiredWith (ValidatorRequiredWithPrivate &dd)
 
QString genericValidationError () const override
 Returns a generic error message.
 
- Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
 
virtual QString genericParsingError () const
 Returns a generic error message if an error occures while parsing input. More...
 
virtual QString genericValidationDataError () const
 Returns a generic error message if any validation data is missing or invalid. More...
 
QString parsingError () const
 Returns an error message if an error occured while parsing input. More...
 
QString validationDataError () const
 Returns an error message if any validation data is missing or invalid. More...
 
QString validationError () const
 Returns a descriptive error message if validation failed. More...
 

Additional Inherited Members

- Protected Attributes inherited from Cutelyst::ValidatorRule
const QScopedPointer< ValidatorRulePrivate > d_ptr
 

Detailed Description

If any of the fields defined in the otherFields list is present in the input data, the field under validation must be present and not empty. For the other fields only their presence in the input data will be checked, not their content.

If ValidatorRule::trimBefore() is set to true (the default), whitespaces will be removed from the beginning and the end of the input value before validation. So, fields that only contain whitespaces will be treated as empty.

See Validator for general usage of validators.

See also
ValidatorRequired, ValidatorRequiredIf, ValidatorRequiredUnless, ValidatorRequiredWithAll, ValidatorRequiredWithout, ValidatorRequiredWithoutAll

Definition at line 45 of file validatorrequiredwith.h.

Constructor & Destructor Documentation

Cutelyst::ValidatorRequiredWith::ValidatorRequiredWith ( const QString &  field,
const QStringList &  otherFields,
const QString &  label = QString(),
const QString &  customError = QString() 
)
Parameters
fieldName of the input field to validate.
otherFieldsList of other fields from which one must be present in the input data to require the field.
labelHuman readable input field label, used for generic error messages.
customErrorCustom error message if validation fails.