Zend_Validate_Date Class Reference

Inheritance diagram for Zend_Validate_Date:

Public Member Functions
	__construct ($options=array())
	getLocale ()
	setLocale ($locale=null)
	getFormat ()
	setFormat ($format=null)
	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 = 'dateInvalid'
const	INVALID_DATE = 'dateInvalidDate'
const	FALSEFORMAT = 'dateFalseFormat'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_format
	$_locale
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 Date.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Sets validator options

Parameters

string | array | Zend_Config

$options

OPTIONAL

Definition at line 76 of file Date.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            $options = func_get_args();
            $temp['format'] = array_shift($options);
            if (!empty($options)) {
                $temp['locale'] = array_shift($options);
            }

            $options = $temp;
        }

        if (array_key_exists('format', $options)) {
            $this->setFormat($options['format']);
        }

        if (!array_key_exists('locale', $options)) {
            #require_once 'Zend/Registry.php';
            if (Zend_Registry::isRegistered('Zend_Locale')) {
                $options['locale'] = Zend_Registry::get('Zend_Locale');
            }
        }

        if (array_key_exists('locale', $options)) {
            $this->setLocale($options['locale']);
        }
    }

Member Function Documentation

getFormat()

getFormat

(

)

Returns the locale option

Returns

string|null

Definition at line 134 of file Date.php.

    {
        return $this->_format;
    }

getLocale()

getLocale

(

)

Returns the locale option

Returns

string|Zend_Locale|null

Definition at line 111 of file Date.php.

    {
        return $this->_locale;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if $value is a valid date of the format YYYY-MM-DD If optional $format or $locale is set the date format is checked according to Zend_Date, see Zend_Date::isDate()

Parameters

string | array | Zend_Date

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 161 of file Date.php.

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

        $this->_setValue($value);

        if (($this->_format !== null) || ($this->_locale !== null) || is_array($value) ||
             $value instanceof Zend_Date) {
            #require_once 'Zend/Date.php';
            if (!Zend_Date::isDate($value, $this->_format, $this->_locale)) {
                if ($this->_checkFormat($value) === false) {
                    $this->_error(self::FALSEFORMAT);
                } else {
                    $this->_error(self::INVALID_DATE);
                }
                return false;
            }
        } else {
            if (!preg_match('/^\d{4}-\d{2}-\d{2}$/', $value)) {
                $this->_format = 'yyyy-MM-dd';
                $this->_error(self::FALSEFORMAT);
                $this->_format = null;
                return false;
            }

            list($year, $month, $day) = sscanf($value, '%d-%d-%d');

            if (!checkdate($month, $day, $year)) {
                $this->_error(self::INVALID_DATE);
                return false;
            }
        }

        return true;
    }

setFormat()

setFormat

(

$format = null

)

Sets the format option

Parameters

string

$format

Returns

Zend_Validate_Date provides a fluent interface

Definition at line 145 of file Date.php.

    {
        $this->_format = $format;
        return $this;
    }

setLocale()

setLocale

(

$locale = null

)

Sets the locale option

Parameters

string | Zend_Locale

$locale

Returns

Zend_Validate_Date provides a fluent interface

Definition at line 122 of file Date.php.

    {
        #require_once 'Zend/Locale.php';
        $this->_locale = Zend_Locale::findLocale($locale);
        return $this;
    }

Field Documentation

$_format

$_format

protected

Definition at line 62 of file Date.php.

$_locale

$_locale

protected

Definition at line 69 of file Date.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID        => "Invalid type given. String, integer, array or Zend_Date expected",
        self::INVALID_DATE   => "'%value%' does not appear to be a valid date",
        self::FALSEFORMAT    => "'%value%' does not fit the date format '%format%'",
    )

Definition at line 44 of file Date.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'format'  => '_format'
    )

Definition at line 53 of file Date.php.

FALSEFORMAT

const FALSEFORMAT = 'dateFalseFormat'

Definition at line 37 of file Date.php.

INVALID

const INVALID = 'dateInvalid'

Definition at line 35 of file Date.php.

INVALID_DATE

const INVALID_DATE = 'dateInvalidDate'

Definition at line 36 of file Date.php.

---

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

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