Class: ComDefaultFilterIni

Source Location: /administrator/components/com_default/filters/ini.php

Class Overview

KObject
   |
   --KFilterAbstract
      |
      --ComDefaultFilterIni

INI filter

Author(s):

Stian Didriksen <stian@nooku.org>

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 27]
INI filter

If the value being sanitized is a INI string it will be decoded, otherwise the value will be encoded upon sanitisation.

The format is non-standard, used by JRegistry as seen in JParameter

Tags:

author:	Stian Didriksen <stian@nooku.org>
uses:	JRegistryFormatINI

[ Top ]

Class Methods

constructor __construct [line 34]

ComDefaultFilterIni __construct(

$config)

Constructor

Tags:

access:

public

Overrides KFilterAbstract::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

method _sanitize [line 60]

string _sanitize(
scalar
$value)

Sanitize a value

Tags:

access:

protected

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

Parameters:

scalar

$value

Value to be sanitized

[ Top ]

method _validate [line 48]

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 Sun, 19 May 2013 03:03:50 +0200 by phpDocumentor 1.4.3