PHP Класс Horde_Imap_Client_Data_Capability, horde

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

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

Свойство Тип Описание
$_data array Capability data.
$_observers array Observers.

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

Метод Описание
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() публичный Метод

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.

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

public attach ( SplObserver $observer )
$observer SplObserver

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

public detach ( SplObserver $observer )
$observer SplObserver

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

Return the list of parameters for an extension.
public getParams ( string $capability ) : array
$capability string The capability string to query.
Результат array An array of parameters if the extension exists and supports parameters. Otherwise, an empty array.

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

Is the extension enabled?
public isEnabled ( string $capability = null ) : mixed
$capability string The extension (+ parameter) to query. If null, returns all enabled extensions.
Результат mixed If $capability is null, return all enabled extensions. Otherwise, true if the extension (+ parameter) is enabled.

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

Notification is triggered internally whenever the object's internal data storage is altered.
public notify ( )

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

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.
Результат boolean True if the capability (and parameter) exist.

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

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.

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

public serialize ( )

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

Returns the raw data.
Устаревший:
public toArray ( ) : array
Результат array Capability data.

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

public unserialize ( $data )

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

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

Capability data.
protected array $_data
Результат array

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

Observers.
protected array $_observers
Результат array