PHP Class HTMLPurifier_PropertyList, yii

显示文件 Open project: yiisoft/yii Class Usage Examples

Protected Properties

Property Type Description
$cache Cache.
$data Internal data-structure for properties.
$parent Parent plist.

Public Methods

Method Description
__construct ( HTMLPurifier_PropertyList $parent = null )
get ( string $name ) Recursively retrieves the value for a key
getParent ( ) : HTMLPurifier_PropertyList Returns the parent plist.
has ( string $name ) : boolean Returns true if a given key exists
reset ( string $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.
set ( string $name, mixed $value ) Sets the value of a key, for this plist
setParent ( HTMLPurifier_PropertyList $plist ) Sets the parent plist.
squash ( boolean $force = false ) : array Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.

Method Details

__construct() public method

public __construct ( HTMLPurifier_PropertyList $parent = null )
$parent HTMLPurifier_PropertyList Parent plist

get() public method

Recursively retrieves the value for a key
public get ( string $name )
$name string

getParent() public method

Returns the parent plist.
public getParent ( ) : HTMLPurifier_PropertyList
return HTMLPurifier_PropertyList

has() public method

Returns true if a given key exists
public has ( string $name ) : boolean
$name string
return boolean

reset() public method

Resets a value to the value of it's parent, usually the default. If no value is specified, the entire plist is reset.
public reset ( string $name = null )
$name string

set() public method

Sets the value of a key, for this plist
public set ( string $name, mixed $value )
$name string
$value mixed

setParent() public method

Sets the parent plist.
public setParent ( HTMLPurifier_PropertyList $plist )
$plist HTMLPurifier_PropertyList Parent plist

squash() public method

Squashes this property list and all of its property lists into a single array, and returns the array. This value is cached by default.
public squash ( boolean $force = false ) : array
$force boolean If true, ignores the cache and regenerates the array.
return array

Property Details

$cache protected_oe property

Cache.
protected $cache

$data protected_oe property

Internal data-structure for properties.
protected $data

$parent protected_oe property

Parent plist.
protected $parent