Référence de la classe JFormRuleEquals

Graphe d'héritage de JFormRuleEquals:

Graphe de collaboration de JFormRuleEquals:

Liste de tous les membres

Fonctions membres publiques
	test (SimpleXMLElement $element, $value, $group=null, JRegistry $input=null, JForm $form=null)

Additional Inherited Members
Attributs protégés inherited from JFormRule
	$regex
	$modifiers

---

Description détaillée

Définition à la ligne 19 du fichier equals.php.

---

Documentation des fonctions membres

JFormRuleEquals::test	(	SimpleXMLElement	$element,
			$value,
			$group = null,
		JRegistry	$input = null,
		JForm	$form = null
	)

Method to test if two values are equal. To use this rule, the form XML needs a validate attribute of equals and a field attribute that is equal to the field to test against.

Paramètres:

SimpleXMLElement	$element	The SimpleXMLElement object representing the <field> tag for the form field object.
mixed	$value	The form field value to validate.
string	$group	The field name group control value. This acts as as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
JRegistry	$input	An optional JRegistry object with the entire data set to validate against the entire form.
JForm	$form	The form object for which the field is being tested.

Renvoie:

boolean True if the value is valid, false otherwise.

Depuis:

11.1

Exceptions:

InvalidArgumentException
UnexpectedValueException

Réimplémentée à partir de JFormRule.

Définition à la ligne 40 du fichier equals.php.

        {
                $field = (string) $element['field'];

                // Check that a validation field is set.
                if (!$field)
                {
                        throw new UnexpectedValueException(sprintf('$field empty in %s::test', get_class($this)));
                }

                if (is_null($form))
                {
                        throw new InvalidArgumentException(sprintf('The value for $form must not be null in %s', get_class($this)));
                }

                if (is_null($input))
                {
                        throw new InvalidArgumentException(sprintf('The value for $input must not be null in %s', get_class($this)));
                }

                // Test the two values against each other.
                if ($value == $input->get($field))
                {
                        return true;
                }

                return false;
        }

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/form/rule/equals.php