Class: KFilterTrim

Source Location: /libraries/koowa/filter/trim.php

Class Overview

KObject
   |
   --KFilterAbstract
      |
      --KFilterTrim

Trim filter.

Author(s):

Johan Janssens <johan@nooku.org>

Variables

$_charList

Methods

Inherited Variables

Class: KFilterAbstract

KFilterAbstract::$_chain
KFilterAbstract::$_walk

Class: KObject

KObject::$_mixed_methods
KObject::$__methods
KObject::$__service_container
KObject::$__service_identifier

Inherited Methods

Class: KFilterAbstract

KFilterAbstract::__construct(): Constructor
KFilterAbstract::addFilter(): Add a filter based on priority
KFilterAbstract::execute(): Command handler
KFilterAbstract::getHandle(): Get a handle for this object
KFilterAbstract::getInstance(): Force creation of a singleton
KFilterAbstract::getPriority(): Get the priority of the filter
KFilterAbstract::sanitize(): Sanitize a variable or data collection
KFilterAbstract::validate(): Validate a variable or data collection
KFilterAbstract::_sanitize(): Sanitize a variable only
KFilterAbstract::_validate(): Validate a variable

Class: KObject

KObject::__construct(): Constructor
KObject::get(): Get the object properties
KObject::getHandle(): Get a handle for this object
KObject::getIdentifier(): Gets the service identifier.
KObject::getMethods(): Get a list of all the available methods
KObject::getService(): Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits(): Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin(): Mixin an object
KObject::set(): Set the object properties
KObject::_initialize(): Initializes the options for the object
KObject::__call(): Search the mixin method map and call the method or trigger an error
KObject::__clone(): Preform a deep clone of the object.

Class Details

[line 17]
Trim filter.

Tags:

author:

Johan Janssens <johan@nooku.org>

[ Top ]

Class Variables

$_charList = null

[line 27]

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.

Tags:

access:

protected

Type:

string|null

[ Top ]

Class Methods

constructor __construct [line 34]

KFilterTrim __construct(

$config)

Constructor

Tags:

access:

public

Overrides KFilterAbstract::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

method getCharList [line 49]

string|null getCharList(
)

Returns the charList option

Tags:

access:

public

[ Top ]

method setCharList [line 60]

this setCharList(
string|null
$charList)

Sets the charList option

Tags:

access:

public

Parameters:

string|null

$charList

[ Top ]

method _sanitize [line 85]

string _sanitize(
mixed
$value)

Sanitize a value

Returns the variable with characters stripped from the beginning and end

Tags:

access:

protected

Overrides KFilterAbstract::_sanitize() (Sanitize a variable only)

Parameters:

mixed

$value

Value to be sanitized

[ Top ]

method _validate [line 72]

bool _validate(
scalar
$value)

Validate a value

Tags:

return:	True when the variable is valid
access:	protected

Overrides KFilterAbstract::_validate() (Validate a variable)

Parameters:

scalar

$value

Value to be validated

[ Top ]

Documentation generated on Thu, 20 Jun 2013 03:02:54 +0200 by phpDocumentor 1.4.3