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.

보호된 프로퍼티들

프로퍼티	타입	설명
$_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