Documentation

Horde_Imap_Client_Base_Alerts
in package
implements SplSubject

Handle IMAP alerts sent from the server.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.24.0

Interfaces, Classes, Traits and Enums

SplSubject

Table of Contents

$_alert  : object
Alert data.
$_observers  : array<string|int, mixed>
Observers.
add()  : mixed
Add an alert.
attach()  : mixed
detach()  : mixed
getLast()  : object
Returns the last alert received.
notify()  : mixed
Notification is triggered internally whenever the object's internal data storage is altered.

Properties

$_alert

Alert data.

protected object $_alert

$_observers

Observers.

protected array<string|int, mixed> $_observers = array()

Methods

add()

Add an alert.

public add(string $alert[, string $type = null ]) : mixed
Parameters
$alert : string

The alert string.

$type : string = null

The alert type.

Return values
mixed

attach()

public attach(SplObserver $observer) : mixed
Parameters
$observer : SplObserver
Return values
mixed

detach()

public detach(SplObserver $observer) : mixed
Parameters
$observer : SplObserver
Return values
mixed

getLast()

Returns the last alert received.

public getLast() : object
Return values
object

Alert information. Object with these properties:

  - alert: (string) Alert string.
  - type: (string) [OPTIONAL] Alert type.

notify()

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

public notify() : mixed
Return values
mixed

Search results