Class: KFilterTidy

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

Class Overview

KObject
   |
   --KFilterAbstract
      |
      --KFilterTidy

Tidy filter.

Author(s):

Johan Janssens <johan@nooku.org>

Variables

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 20]
Tidy filter.

This filter will correct and escape a HTML fragment. It will also cleanup HTML generated by Microsoft Office products.

Tags:

author:	Johan Janssens <johan@nooku.org>
see:	http://tidy.sourceforge.net/docs/quickref.html

[ Top ]

Class Variables

$_config = array()

[line 41]

The tidy configuration

Tags:

access:

protected

Type:

array

[ Top ]

$_encoding = 'utf8'

[line 34]

The input/output encoding

Tags:

access:

protected

Type:

string

[ Top ]

$_tidy = null

[line 27]

A tidy object

Tags:

access:

protected

Type:

object

[ Top ]

Class Methods

constructor __construct [line 48]

KFilterTidy __construct(

$config)

Constructor

Tags:

access:

public

Overrides KFilterAbstract::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

method getTidy [line 117]

void getTidy(
string
$string)

Gets a Tidy object

Tags:

access:

public

Parameters:

string

$string

The data to be parsed.

[ Top ]

method _initialize [line 64]

void _initialize(

$config)

Initializes the config for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overrides KObject::_initialize() (Initializes the options for the object)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

method _sanitize [line 99]

string _sanitize(
scalar
$value)

Sanitize a variable

Tags:

access:

protected

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

Parameters:

scalar

$value

Value to be sanitized

[ Top ]

method _validate [line 88]

bool _validate(
scalar
$value)

Validate a variable

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 Wed, 22 May 2013 03:02:47 +0200 by phpDocumentor 1.4.3