PHP Класс HTMLPurifier_ConfigSchema, yii

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$defaultPlist The default property list. Do not edit this property list.
$defaults Defaults of the directives and namespaces.
$info The structure of this is: array( 'Namespace' => array( 'Directive' => new stdclass(), ) ) The stdclass may have the following properties: - If isAlias isn't set: - type: Integer type of directive, see HTMLPurifier_VarParser for definitions - allow_null: If set, this directive allows null values - aliases: If set, an associative array of value aliases to real values - allowed: If set, a lookup array of allowed (string) values - If isAlias is set: - namespace: Namespace this directive aliases to - name: Directive name this directive aliases to In certain degenerate cases, stdclass will actually be an integer. In that case, the value is equivalent to an stdclass with the type property set to the integer. If the integer is negative, type is equal to the absolute value of integer, and allow_null is true. This class is friendly with HTMLPurifier_Config. If you need introspection about the schema, you're better of using the ConfigSchema_Interchange, which uses more memory but has much richer information.

Защищенные свойства (Protected)

Свойство Тип Описание
$singleton Application-wide singleton

Открытые методы

Метод Описание
__construct ( )
add ( string $key, mixed $default, string $type, boolean $allow_null ) Defines a directive for configuration
addAlias ( string $key, string $new_key ) Defines a directive alias for backwards compatibility
addAllowedValues ( string $key, array $allowed ) Defines a set of allowed values for a directive.
addValueAliases ( string $key, array $aliases ) Defines a directive value alias.
instance ( HTMLPurifier_ConfigSchema $prototype = null ) : HTMLPurifier_ConfigSchema Retrieves an instance of the application-wide configuration definition.
makeFromSerial ( ) : HTMLPurifier_ConfigSchema Unserializes the default ConfigSchema.
postProcess ( ) Replaces any stdclass that only has the type property with type integer.

Описание методов

__construct() публичный Метод

public __construct ( )

add() публичный Метод

Defines a directive for configuration
public add ( string $key, mixed $default, string $type, boolean $allow_null )
$key string Name of directive
$default mixed Default value of directive
$type string Allowed type of the directive. See HTMLPurifier_DirectiveDef::$type for allowed values
$allow_null boolean Whether or not to allow null values

addAlias() публичный Метод

Defines a directive alias for backwards compatibility
public addAlias ( string $key, string $new_key )
$key string Directive that will be aliased
$new_key string Directive that the alias will be to

addAllowedValues() публичный Метод

Defines a set of allowed values for a directive.
public addAllowedValues ( string $key, array $allowed )
$key string Name of directive
$allowed array Lookup array of allowed values

addValueAliases() публичный Метод

Directive value aliases are convenient for developers because it lets them set a directive to several values and get the same result.
public addValueAliases ( string $key, array $aliases )
$key string Name of Directive
$aliases array Hash of aliased values to the real alias

instance() публичный статический Метод

Retrieves an instance of the application-wide configuration definition.
public static instance ( HTMLPurifier_ConfigSchema $prototype = null ) : HTMLPurifier_ConfigSchema
$prototype HTMLPurifier_ConfigSchema
Результат HTMLPurifier_ConfigSchema

makeFromSerial() публичный статический Метод

Unserializes the default ConfigSchema.
public static makeFromSerial ( ) : HTMLPurifier_ConfigSchema
Результат HTMLPurifier_ConfigSchema

postProcess() публичный Метод

Replaces any stdclass that only has the type property with type integer.
public postProcess ( )

Описание свойств

$defaultPlist публичное свойство

The default property list. Do not edit this property list.
public $defaultPlist

$defaults публичное свойство

Defaults of the directives and namespaces.
public $defaults

$info публичное свойство

The structure of this is: array( 'Namespace' => array( 'Directive' => new stdclass(), ) ) The stdclass may have the following properties: - If isAlias isn't set: - type: Integer type of directive, see HTMLPurifier_VarParser for definitions - allow_null: If set, this directive allows null values - aliases: If set, an associative array of value aliases to real values - allowed: If set, a lookup array of allowed (string) values - If isAlias is set: - namespace: Namespace this directive aliases to - name: Directive name this directive aliases to In certain degenerate cases, stdclass will actually be an integer. In that case, the value is equivalent to an stdclass with the type property set to the integer. If the integer is negative, type is equal to the absolute value of integer, and allow_null is true. This class is friendly with HTMLPurifier_Config. If you need introspection about the schema, you're better of using the ConfigSchema_Interchange, which uses more memory but has much richer information.
public $info

$singleton защищенное статическое свойство

Application-wide singleton
protected static $singleton