Zend_Validate_Regex Class Reference

Inheritance diagram for Zend_Validate_Regex:

Public Member Functions
	__construct ($pattern)
	getPattern ()
	setPattern ($pattern)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()

Data Fields
const	INVALID = 'regexInvalid'
const	NOT_MATCH = 'regexNotMatch'
const	ERROROUS = 'regexErrorous'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_pattern
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 33 of file Regex.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$pattern

)

Sets validator options

Parameters

string | Zend_Config

$pattern

Exceptions

Zend_Validate_Exception

On missing 'pattern' parameter

Definition at line 68 of file Regex.php.

    {
        if ($pattern instanceof Zend_Config) {
            $pattern = $pattern->toArray();
        }

        if (is_array($pattern)) {
            if (array_key_exists('pattern', $pattern)) {
                $pattern = $pattern['pattern'];
            } else {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("Missing option 'pattern'");
            }
        }

        $this->setPattern($pattern);
    }

Member Function Documentation

getPattern()

getPattern

(

)

Returns the pattern option

Returns

string

Definition at line 91 of file Regex.php.

    {
        return $this->_pattern;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if and only if $value matches against the pattern option

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 124 of file Regex.php.

    {
        if (!is_string($value) && !is_int($value) && !is_float($value)) {
            $this->_error(self::INVALID);
            return false;
        }

        $this->_setValue($value);

        $status = @preg_match($this->_pattern, $value);
        if (false === $status) {
            $this->_error(self::ERROROUS);
            return false;
        }

        if (!$status) {
            $this->_error(self::NOT_MATCH);
            return false;
        }

        return true;
    }

setPattern()

setPattern

(

$pattern

)

Sets the pattern option

Parameters

string

$pattern

Exceptions

Zend_Validate_Exception

if there is a fatal error in pattern matching

Returns

Zend_Validate_Regex Provides a fluent interface

Definition at line 103 of file Regex.php.

    {
        $this->_pattern = (string) $pattern;
        $status         = @preg_match($this->_pattern, "Test");

        if (false === $status) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("Internal error while using the pattern '$this->_pattern'");
        }

        return $this;
    }

Field Documentation

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID   => "Invalid type given. String, integer or float expected",
        self::NOT_MATCH => "'%value%' does not match against pattern '%pattern%'",
        self::ERROROUS  => "There was an internal error while using the pattern '%pattern%'",
    )

Definition at line 42 of file Regex.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'pattern' => '_pattern'
    )

Definition at line 51 of file Regex.php.

$_pattern

$_pattern

protected

Definition at line 60 of file Regex.php.

ERROROUS

const ERROROUS = 'regexErrorous'

Definition at line 37 of file Regex.php.

INVALID

const INVALID = 'regexInvalid'

Definition at line 35 of file Regex.php.

NOT_MATCH

const NOT_MATCH = 'regexNotMatch'

Definition at line 36 of file Regex.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/Regex.php