PHP Class Horde_Imap_Client_Data_Capability, horde

Since: 2.24.0

Author: Michael Slusarz ([email protected])

Inheritance: implements Serializable, implements SplSubject

Protected Properties

Property	Type	Description
$_data	array	Capability data.
$_observers	array	Observers.

Method	Description
add ( string $capability, mixed $params = null )	Add a capability (and optional parameters).
attach ( SplObserver $observer )
detach ( SplObserver $observer )
getParams ( string $capability ) : array	Return the list of parameters for an extension.
isEnabled ( string $capability = null ) : mixed	Is the extension enabled?
notify ( )	Notification is triggered internally whenever the object's internal data storage is altered.
query ( string $capability, string $parameter = null ) : boolean	Returns whether the server supports the given capability.
remove ( string $capability, string $params = null )	Remove a capability.
serialize ( )
toArray ( ) : array	Returns the raw data.
unserialize ( $data )

Add a capability (and optional parameters).

public add ( string $capability, mixed $params = null )
$capability	string	The capability to add.
$params	mixed	A parameter (or array of parameters) to add.

public attach ( SplObserver $observer )
$observer	SplObserver

public detach ( SplObserver $observer )
$observer	SplObserver

Return the list of parameters for an extension.

public getParams ( string $capability ) : array
$capability	string	The capability string to query.
return	array	An array of parameters if the extension exists and supports parameters. Otherwise, an empty array.

Is the extension enabled?

public isEnabled ( string $capability = null ) : mixed
$capability	string	The extension (+ parameter) to query. If null, returns all enabled extensions.
return	mixed	If $capability is null, return all enabled extensions. Otherwise, true if the extension (+ parameter) is enabled.

Notification is triggered internally whenever the object's internal data storage is altered.

public notify ( )

Returns whether the server supports the given capability.

public query ( string $capability, string $parameter = null ) : boolean
$capability	string	The capability string to query.
$parameter	string	If set, require the parameter to exist.
return	boolean	True if the capability (and parameter) exist.

Remove a capability.

public remove ( string $capability, string $params = null )
$capability	string	The capability to remove.
$params	string	A parameter (or array of parameters) to remove from the capability.

public serialize ( )

Returns the raw data.

Deprecation:

public toArray ( ) : array
return	array	Capability data.

public unserialize ( $data )

Capability data.

protected array $_data
return	array

Observers.

protected array $_observers
return	array