Class: HTML_QuickForm2_Rule_Required

Source Location: /HTML_QuickForm2-0.2.0/QuickForm2/Rule/Required.php

Class Overview

HTML_QuickForm2_Rule
   |
   --HTML_QuickForm2_Rule_Nonempty
      |
      --HTML_QuickForm2_Rule_Required

Rule for required elements

Author(s):

Bertrand Mansion <golgote at mamasam.com>
Alexey Borzov <avb at php.net>

Version:

Release: 0.2.0

Inherited Variables

Class: HTML_QuickForm2_Rule

HTML_QuickForm2_Rule::$chainedRules
HTML_QuickForm2_Rule::$message
HTML_QuickForm2_Rule::$options
HTML_QuickForm2_Rule::$owner
HTML_QuickForm2_Rule::$registeredType

Inherited Methods

Class: HTML_QuickForm2_Rule_Nonempty

HTML_QuickForm2_Rule_Nonempty::checkValue()

Class: HTML_QuickForm2_Rule

HTML_QuickForm2_Rule::__construct(): Class constructor
HTML_QuickForm2_Rule::and_(): Adds a rule to the chain with an "and" operator
HTML_QuickForm2_Rule::checkValue(): Validates the element's value
HTML_QuickForm2_Rule::getMessage(): Returns the error message output by the rule
HTML_QuickForm2_Rule::getOptions(): Returns the rule's configuration data
HTML_QuickForm2_Rule::or_(): Adds a rule to the chain with an "or" operator
HTML_QuickForm2_Rule::setMessage(): Sets the error message output by the rule
HTML_QuickForm2_Rule::setOptions(): Sets additional configuration data for the rule
HTML_QuickForm2_Rule::setOwner(): Sets the element that will be validated by this rule
HTML_QuickForm2_Rule::validate(): Performs validation

Class Details

[line 67]
Rule for required elements

The main difference from "nonempty" Rule is that

elements to which this Rule is attached will be considered required (HTML_QuickForm2_Node::isRequired() will return true for them) and marked accordingly when outputting the form
this Rule can only be added directly to the element and other Rules can only be added to it via and_() method

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 0.2.0

[ Top ]

Method Detail

or_ [line 81]

void or_(
HTML_QuickForm2_Rule
$next)

Disallows adding a rule to the chain with an "or" operator

Required rules are different from all others because they affect the visual representation of an element ("* denotes required field"). Therefore we cannot allow chaining other rules to these via or_(), since this will effectively mean that the field is not required anymore and the visual difference is bogus.

Throws: HTML_QuickForm2_Exception
Access: public

Overrides HTML_QuickForm2_Rule::or_() (Adds a rule to the chain with an "or" operator)

Parameters:

HTML_QuickForm2_Rule $next —

[ Top ]