PHP Класс Horde_Prefs_Scope, horde

Автор: Michael Slusarz ([email protected])
Наследование: implements Iterator, implements Serializable
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$init boolean Is the object being initialized?
$scope string The scope name.

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

Свойство Тип Описание
$_dirty array List of dirty prefs.
$_prefs array [l] => (boolean) Locked If not present, pref is not locked. [v] => (string) Current pref value ) For internal storage, if 'l' and 'v' are both not available: [pref_name] => (string) Current pref value

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

Метод Описание
__construct ( string $scope ) Constructor.
current ( )
exists ( $pref ) : boolean Does a preference exist in this scope?
get ( string $pref ) : string Returns the value of a preference.
getDefault ( string $pref ) : string Returns the default value of a preference.
getDirty ( ) : array Get the list of dirty preferences.
isDefault ( string $pref ) : boolean Is a preference's value the default?
isDirty ( mixed $pref = null ) : boolean Is a preference marked dirty?
isLocked ( string $pref ) : boolean Is a preference locked?
key ( )
next ( )
remove ( string $pref ) : boolean Removes a preference entry.
rewind ( )
serialize ( )
set ( string $pref, string $val ) Sets the value for a preference.
setDirty ( string $pref, boolean $dirty ) Set the dirty flag for a preference
setLocked ( string $pref, boolean $locked ) Mark a preference as locked.
unserialize ( $data )
valid ( )

Защищенные методы

Метод Описание
_fromInternal ( $pref )
_toInternal ( $pref, array $value )

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

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

Constructor.
public __construct ( string $scope )
$scope string The scope for this set of preferences.

_fromInternal() защищенный Метод

protected _fromInternal ( $pref )

_toInternal() защищенный Метод

protected _toInternal ( $pref, array $value )
$value array

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

public current ( )

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

Does a preference exist in this scope?
public exists ( $pref ) : boolean
Результат boolean True if the preference exists.

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

Returns the value of a preference.
public get ( string $pref ) : string
$pref string The preference name to retrieve.
Результат string The value of the preference, null if it doesn't exist.

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

Returns the default value of a preference.
public getDefault ( string $pref ) : string
$pref string The preference name.
Результат string The preference's default value.

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

Get the list of dirty preferences.
public getDirty ( ) : array
Результат array The list of dirty preferences.

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

Is a preference's value the default?
public isDefault ( string $pref ) : boolean
$pref string The preference name.
Результат boolean True if the preference contains the default value.

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

Is a preference marked dirty?
public isDirty ( mixed $pref = null ) : boolean
$pref mixed The preference name. If null, will return true if scope contains at least one dirty pref.
Результат boolean True if the preference is marked dirty.

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

Is a preference locked?
public isLocked ( string $pref ) : boolean
$pref string The preference name.
Результат boolean Whether the preference is locked.

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

public key ( )

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

public next ( )

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

Removes a preference entry.
public remove ( string $pref ) : boolean
$pref string The name of the preference to remove.
Результат boolean True if preference was removed.

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

public rewind ( )

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

public serialize ( )

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

Sets the value for a preference.
public set ( string $pref, string $val )
$pref string The preference name.
$val string The preference value.

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

Set the dirty flag for a preference
public setDirty ( string $pref, boolean $dirty )
$pref string The preference name.
$dirty boolean True to mark the pref as dirty.

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

Mark a preference as locked.
public setLocked ( string $pref, boolean $locked )
$pref string The preference name.
$locked boolean Is the preference locked?

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

public unserialize ( $data )

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

public valid ( )

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

$_dirty защищенное свойство

List of dirty prefs.
protected array $_dirty
Результат array

$_prefs защищенное свойство

[l] => (boolean) Locked If not present, pref is not locked. [v] => (string) Current pref value ) For internal storage, if 'l' and 'v' are both not available: [pref_name] => (string) Current pref value
protected array $_prefs
Результат array

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

Is the object being initialized?
public bool $init
Результат boolean

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

The scope name.
public string $scope
Результат string