Zend_Filter_Alnum Class Reference

Inheritance diagram for Zend_Filter_Alnum:

Public Member Functions
	__construct ($allowWhiteSpace=false)
	getAllowWhiteSpace ()
	setAllowWhiteSpace ($allowWhiteSpace)
	filter ($value)

Data Fields
	$allowWhiteSpace

Protected Attributes
	$_locale

Static Protected Attributes
static	$_unicodeEnabled
static	$_meansEnglishAlphabet

Detailed Description

Definition at line 37 of file Alnum.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$allowWhiteSpace = false

)

Sets default option values for this instance

Parameters

boolean

$allowWhiteSpace

Returns

void

Definition at line 74 of file Alnum.php.

    {
        if ($allowWhiteSpace instanceof Zend_Config) {
            $allowWhiteSpace = $allowWhiteSpace->toArray();
        } else if (is_array($allowWhiteSpace)) {
            if (array_key_exists('allowwhitespace', $allowWhiteSpace)) {
                $allowWhiteSpace = $allowWhiteSpace['allowwhitespace'];
            } else {
                $allowWhiteSpace = false;
            }
        }

        $this->allowWhiteSpace = (boolean) $allowWhiteSpace;
        if (null === self::$_unicodeEnabled) {
            self::$_unicodeEnabled = (@preg_match('/\pL/u', 'a')) ? true : false;
        }

        if (null === self::$_meansEnglishAlphabet) {
            $this->_locale = new Zend_Locale('auto');
            self::$_meansEnglishAlphabet = in_array($this->_locale->getLanguage(),
                                                    array('ja', 'ko', 'zh')
                                                    );
        }

    }

Member Function Documentation

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns the string $value, removing all but alphabetic and digit characters

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 130 of file Alnum.php.

    {
        $whiteSpace = $this->allowWhiteSpace ? '\s' : '';
        if (!self::$_unicodeEnabled) {
            // POSIX named classes are not supported, use alternative a-zA-Z0-9 match
            $pattern = '/[^a-zA-Z0-9' . $whiteSpace . ']/';
        } else if (self::$_meansEnglishAlphabet) {
            //The Alphabet means english alphabet.
            $pattern = '/[^a-zA-Z0-9'  . $whiteSpace . ']/u';
        } else {
            //The Alphabet means each language's alphabet.
            $pattern = '/[^\p{L}\p{N}' . $whiteSpace . ']/u';
        }

        return preg_replace($pattern, '', (string) $value);
    }

getAllowWhiteSpace()

getAllowWhiteSpace

(

)

Returns the allowWhiteSpace option

Returns

boolean

Definition at line 105 of file Alnum.php.

    {
        return $this->allowWhiteSpace;
    }

setAllowWhiteSpace()

setAllowWhiteSpace

(

$allowWhiteSpace

)

Sets the allowWhiteSpace option

Parameters

boolean

$allowWhiteSpace

Returns

Zend_Filter_Alnum Provides a fluent interface

Definition at line 116 of file Alnum.php.

    {
        $this->allowWhiteSpace = (boolean) $allowWhiteSpace;
        return $this;
    }

Field Documentation

$_locale

$_locale

protected

Definition at line 59 of file Alnum.php.

$_meansEnglishAlphabet

$_meansEnglishAlphabet

staticprotected

Definition at line 66 of file Alnum.php.

$_unicodeEnabled

$_unicodeEnabled

staticprotected

Definition at line 52 of file Alnum.php.

$allowWhiteSpace

$allowWhiteSpace

Definition at line 45 of file Alnum.php.

---

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

• vendor/magento/zendframework1/library/Zend/Filter/Alnum.php