API - XOOPS 2.5.11 Beta 2
By monxoops.fr
HTMLPurifier_PropertyList Class Reference

Public Member Functions

 __construct ($parent=null)
 
 get ($name)
 
 set ($name, $value)
 
 has ($name)
 
 reset ($name=null)
 
 squash ($force=false)
 
 getParent ()
 
 setParent ($plist)
 

Protected Attributes

 $data = array()
 
 $parent
 
 $cache
 

Detailed Description

Generic property list implementation

Constructor & Destructor Documentation

◆ __construct()

__construct (   $parent = null)
Parameters
HTMLPurifier_PropertyList$parentParent plist

Member Function Documentation

◆ get()

get (   $name)

Recursively retrieves the value for a key

Parameters
string$name
Exceptions
HTMLPurifier_Exception
Here is the call graph for this function:

◆ getParent()

getParent ( )

Returns the parent plist.

Returns
HTMLPurifier_PropertyList

◆ has()

has (   $name)

Returns true if a given key exists

Parameters
string$name
Returns
bool
Here is the caller graph for this function:

◆ reset()

reset (   $name = null)

Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.

Parameters
string$name

◆ set()

set (   $name,
  $value 
)

Sets the value of a key, for this plist

Parameters
string$name
mixed$value

◆ setParent()

setParent (   $plist)

Sets the parent plist.

Parameters
HTMLPurifier_PropertyList$plistParent plist

◆ squash()

squash (   $force = false)

Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.

Parameters
bool$forceIf true, ignores the cache and regenerates the array.
Returns
array

Field Documentation

◆ $cache

$cache
protected

Cache. @type array

◆ $data

$data = array()
protected

Internal data-structure for properties. @type array

◆ $parent

$parent
protected

Parent plist. @type HTMLPurifier_PropertyList


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