Zend_Filter_StringTrim Class Reference

Inheritance diagram for Zend_Filter_StringTrim:

Public Member Functions
	__construct ($options=null)
	getCharList ()
	setCharList ($charList)
	filter ($value)

Protected Member Functions
	_unicodeTrim ($value, $charlist='\\\\s')

Protected Attributes
	$_charList

Detailed Description

Definition at line 33 of file StringTrim.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Sets filter options

Parameters

string | array | Zend_Config

$options

Returns

void

Definition at line 51 of file StringTrim.php.

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

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

Member Function Documentation

_unicodeTrim()

_unicodeTrim (   $value,   $charlist = '\\\\s'  )

protected

Unicode aware trim method Fixes a PHP problem

Parameters

string	$value
string	$charlist

Returns

string

Definition at line 113 of file StringTrim.php.

    {
        $chars = preg_replace(
            array( '/[\^\-\]\\\]/S', '/\\\{4}/S', '/\//'),
            array( '\\\\\\0', '\\', '\/' ),
            $charlist
        );

        $pattern = '^[' . $chars . ']*|[' . $chars . ']*$';
        return preg_replace("/$pattern/sSD", '', $value);
    }

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns the string $value with characters stripped from the beginning and end

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 96 of file StringTrim.php.

    {
        if (null === $this->_charList) {
            return $this->_unicodeTrim((string) $value);
        } else {
            return $this->_unicodeTrim((string) $value, $this->_charList);
        }
    }

getCharList()

getCharList

(

)

Returns the charList option

Returns

string|null

Definition at line 71 of file StringTrim.php.

    {
        return $this->_charList;
    }

setCharList()

setCharList

(

$charList

)

Sets the charList option

Parameters

string | null

$charList

Returns

Zend_Filter_StringTrim Provides a fluent interface

Definition at line 82 of file StringTrim.php.

    {
        $this->_charList = $charList;
        return $this;
    }

Field Documentation

$_charList

$_charList

protected

Definition at line 43 of file StringTrim.php.

---

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

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