Zend_Validate_StringLength Class Reference

Inheritance diagram for Zend_Validate_StringLength:

Public Member Functions
	__construct ($options=array())
	getMin ()
	setMin ($min)
	getMax ()
	setMax ($max)
	getEncoding ()
	setEncoding ($encoding=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 = 'stringLengthInvalid'
const	TOO_SHORT = 'stringLengthTooShort'
const	TOO_LONG = 'stringLengthTooLong'

Protected Attributes
	$_messageTemplates
	$_messageVariables
	$_min
	$_max
	$_encoding
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 StringLength.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Sets validator options

Parameters

integer | array | Zend_Config

$options

Definition at line 84 of file StringLength.php.

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

            if (!empty($options)) {
                $temp['encoding'] = array_shift($options);
            }

            $options = $temp;
        }

        if (!array_key_exists('min', $options)) {
            $options['min'] = 0;
        }

        $this->setMin($options['min']);
        if (array_key_exists('max', $options)) {
            $this->setMax($options['max']);
        }

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

Member Function Documentation

getEncoding()

getEncoding

(

)

Returns the actual encoding

Returns

string

Definition at line 187 of file StringLength.php.

    {
        return $this->_encoding;
    }

getMax()

getMax

(

)

Returns the max option

Returns

integer|null

Definition at line 152 of file StringLength.php.

    {
        return $this->_max;
    }

getMin()

getMin

(

)

Returns the min option

Returns

integer

Definition at line 121 of file StringLength.php.

    {
        return $this->_min;
    }

isValid()

isValid

(

$value

)

Defined by Zend_Validate_Interface

Returns true if and only if the string length of $value is at least the min option and no greater than the max option (when the max option is not null).

Parameters

string

$value

Returns

boolean

Implements Zend_Validate_Interface.

Definition at line 239 of file StringLength.php.

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

        $this->_setValue($value);
        if ($this->_encoding !== null) {
            $length = iconv_strlen($value, $this->_encoding);
        } else {
            $length = iconv_strlen($value);
        }

        if ($length < $this->_min) {
            $this->_error(self::TOO_SHORT);
        }

        if (null !== $this->_max && $this->_max < $length) {
            $this->_error(self::TOO_LONG);
        }

        if (count($this->_messages)) {
            return false;
        } else {
            return true;
        }
    }

setEncoding()

setEncoding

(

$encoding = null

)

Sets a new encoding to use

Parameters

string

$encoding

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_StringLength

Definition at line 199 of file StringLength.php.

    {
        if ($encoding !== null) {
            $orig = PHP_VERSION_ID < 50600
                        ? iconv_get_encoding('internal_encoding')
                        : ini_get('default_charset');
            if (PHP_VERSION_ID < 50600) {
                if ($encoding) {
                    $result = iconv_set_encoding('internal_encoding', $encoding);
                } else {
                    $result = false;
                }
            } else {
                ini_set('default_charset', $encoding);
                $result = ini_get('default_charset');
            }
            if ($result === false) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception('Given encoding not supported on this OS!');
            }

            if (PHP_VERSION_ID < 50600) {
                iconv_set_encoding('internal_encoding', $orig);
            } else {
                ini_set('default_charset', $orig);
            }
        }
        $this->_encoding = $encoding;
        return $this;
    }

setMax()

setMax

(

$max

)

Sets the max option

Parameters

integer | null

$max

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_StringLength Provides a fluent interface

See also

Zend_Validate_Exception

Definition at line 164 of file StringLength.php.

    {
        if (null === $max) {
            $this->_max = null;
        } else if ($max < $this->_min) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The maximum must be greater than or equal to the minimum length, but "
                                            . "$max < $this->_min");
        } else {
            $this->_max = (integer) $max;
        }

        return $this;
    }

setMin()

setMin

(

$min

)

Sets the min option

Parameters

integer

$min

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_StringLength Provides a fluent interface

See also

Zend_Validate_Exception

Definition at line 133 of file StringLength.php.

    {
        if (null !== $this->_max && $min > $this->_max) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The minimum must be less than or equal to the maximum length, but $min >"
                                            . " $this->_max");
        }
        $this->_min = max(0, (integer) $min);
        return $this;
    }

Field Documentation

$_encoding

$_encoding

protected

Definition at line 77 of file StringLength.php.

$_max

$_max

protected

Definition at line 70 of file StringLength.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID   => "Invalid type given. String expected",
        self::TOO_SHORT => "'%value%' is less than %min% characters long",
        self::TOO_LONG  => "'%value%' is more than %max% characters long",
    )

Definition at line 42 of file StringLength.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'min' => '_min',
        'max' => '_max'
    )

Definition at line 51 of file StringLength.php.

$_min

$_min

protected

Definition at line 61 of file StringLength.php.

INVALID

const INVALID = 'stringLengthInvalid'

Definition at line 35 of file StringLength.php.

TOO_LONG

const TOO_LONG = 'stringLengthTooLong'

Definition at line 37 of file StringLength.php.

TOO_SHORT

const TOO_SHORT = 'stringLengthTooShort'

Definition at line 36 of file StringLength.php.

---

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

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