API Documentation

Zend/Filter/StringTrim.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

Propertyprotectedstring|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
stringnull

Methods

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

Sets filter options

Parameters
Name Type Description
$options string|array|\Zend_Config
methodprotected_unicodeTrim( string $value, string $charlist = '\\\\s' ) : string

Unicode aware trim method Fixes a PHP problem

Parameters
Name Type Description
$value string
$charlist string
Returns
Type Description
string
methodpublicfilter( string $value ) : string

Defined by Zend_Filter_Interface

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

Parameters
Name Type Description
$value string
Returns
Type Description
string
methodpublicgetCharList( ) : string|null

Returns the charList option

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

Sets the charList option

Parameters
Name Type Description
$charList string|null
Returns
Type Description
\Zend_Filter_StringTrim Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.