API16

API16:JFormRule/test

From Joomla! Documentation

Revision as of 22:51, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Method to test the value. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </spa...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Method to test the value.

[Edit Descripton]

Template:Description:JFormRule/test

Syntax

test(&$field, &$values)
Parameter Name Default Value Description
$field A reference to the form field.
$values The values to test for validiaty.

Returns

boolean True if the value is valid, false otherwise.

Defined in

libraries/joomla/form/formrule.php

Importing

jimport( 'joomla.form.formrule' );

Source Body

public function test(&$field, &$values)
{
        $return = false;
        $name   = (string)$field->attributes()->name;

        // Check for a valid regex.
        if (empty($this->_regex)) {
                throw new JException('Invalid Form Rule :: '.get_class($this));
        }

        // Add unicode property support if available.
        if (JCOMPAT_UNICODE_PROPERTIES) {
                $this->_modifiers = strpos($this->_modifiers, 'u') ? $this->_modifiers : $this->_modifiers.'u';
        }

        // Test the value against the regular expression.
        if (preg_match('#'.$this->_regex.'#'.$this->_modifiers, $values[$name])) {
                $return = true;
        }

        return $return;
}

[Edit See Also] Template:SeeAlso:JFormRule/test

Examples

<CodeExamplesForm />