Filter Class Reference

Basic filter class. More...

List of all members.

Public Member Functions
	init ()
	Default initializer for the Filter.
	filter ($value)
	The filter() method should perform a transformation on the passed parameter and return its result.

---

Detailed Description

Basic filter class.

Definition at line 27 of file filter.lib.php.

---

Member Function Documentation

Filter::init

(

)

Default initializer for the Filter.

This is a do-nothing stub that is used as a fallback for Filters not specifying a init() method of their own.

Definition at line 33 of file filter.lib.php.

Filter::filter

(

$

value

)

The filter() method should perform a transformation on the passed parameter and return its result.

This methods throws an exception and should be overridden in classes extending Filter.

Parameters:

$value

The value to filter.

Returns:

The filtered value.

Reimplemented in FirstUpperCaseFilter, LowercaseFilter, MaxLengthFilter, PregFilter, StripWhitespaceFilter, and UppercaseFilter.

Definition at line 46 of file filter.lib.php.

---

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

• filter.lib.php