Class: Structures_Form_Rule_Required

Source Location: /Structures_Form-0.8.0devel/Form/Rule/Required.php

Structures_Form_Rule_Base
   |
   --Structures_Form_Rule_Required

Structures_Form_Rule_Base::__construct(): Constructor.
Structures_Form_Rule_Base::addSubstitution(): Adds a new subsitution to the substitution array.
Structures_Form_Rule_Base::generateErrorString(): Generates an error string based on the class' error string and the class' substitution array.
Structures_Form_Rule_Base::removeSubstitution(): Removes a subsitution from the substitution array.
Structures_Form_Rule_Base::setErrorMessage(): Sets the error message to be used when a value fails to validate.
Structures_Form_Rule_Base::setSubstitutions(): Sets the array of error message substitutions.

[line 19]

[ Top ]

[line 30]

The error message to be returned if the element does not validate.

The values in {curly braces} will be substituted for values from the substitiution array.

Type:	string
Overrides:	Array

[ Top ]

void __construct(
[string
$errorMessage = null], [array
$substitutions = null])

Constructor. Just calls the parent constructor.

This rule does not require any additional arguments, but may accept two optional arguments.

string	`$errorMessage`	—	Optional error message.
array	`$substitutions`	—	Optional substitution array.

[ Top ]

mixed validate(
Structures_Form_ElementInterface
$element)

Validates the given element.

object $element — A Structures_Form element.

[ Top ]