Filter/StringTrim.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Filter  
Version
$Id: StringTrim.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Filter_StringTrim

Package: Zend\Filter
Implements
\Zend_Filter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring|null $_charList
List of characters provided to the trim() function

If this is null, then trim() is called with no specific character list, and its default behavior will be invoked, trimming whitespace.

Details
Type
string | null

Methods

methodpublic__construct(string | array | \Zend_Config $options = null) : void

Sets filter options

Parameters
NameTypeDescription
$optionsstring | array | \Zend_Config
methodprotected_unicodeTrim(string $value, string $charlist = '\\\\s') : string

Unicode aware trim method Fixes a PHP problem

Parameters
NameTypeDescription
$valuestring
$charliststring
Returns
TypeDescription
string
methodpublicfilter(string $value) : string

Defined by Zend_Filter_Interface

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

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Filter_ExceptionIf filtering $value is impossible
methodpublicgetCharList() : string | null

Returns the charList option

Returns
TypeDescription
string | null
methodpublicsetCharList(string | null $charList) : \Zend_Filter_StringTrim

Sets the charList option

Parameters
NameTypeDescription
$charListstring | null
Returns
TypeDescription
\Zend_Filter_StringTrimProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.