Zend_Filter_StringToLower Class Reference

Inheritance diagram for Zend_Filter_StringToLower:

Public Member Functions
	__construct ($options=null)
	getEncoding ()
	setEncoding ($encoding=null)
	filter ($value)

Protected Attributes
	$_encoding = null

Detailed Description

Definition at line 33 of file StringToLower.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

string | array | Zend_Config

$options

OPTIONAL

Definition at line 47 of file StringToLower.php.

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

        if (!array_key_exists('encoding', $options) && function_exists('mb_internal_encoding')) {
            $options['encoding'] = mb_internal_encoding();
        }

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

Member Function Documentation

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns the string $value, converting characters to lowercase as necessary

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 113 of file StringToLower.php.

    {
        if ($this->_encoding !== null) {
            return mb_strtolower((string) $value, $this->_encoding);
        }

        return strtolower((string) $value);
    }

getEncoding()

getEncoding

(

)

Returns the set encoding

Returns

string

Definition at line 74 of file StringToLower.php.

    {
        return $this->_encoding;
    }

setEncoding()

setEncoding

(

$encoding = null

)

Set the input encoding for the given string

Parameters

string

$encoding

Returns

Zend_Filter_StringToLower Provides a fluent interface

Exceptions

Zend_Filter_Exception

Definition at line 86 of file StringToLower.php.

    {
        if ($encoding !== null) {
            if (!function_exists('mb_strtolower')) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception('mbstring is required for this feature');
            }

            $encoding = (string) $encoding;
            if (!in_array(strtolower($encoding), array_map('strtolower', mb_list_encodings()))) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception("The given encoding '$encoding' is not supported by mbstring");
            }
        }

        $this->_encoding = $encoding;
        return $this;
    }

Field Documentation

$_encoding

$_encoding = null

protected

Definition at line 40 of file StringToLower.php.

---

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

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