PHP Class rcrowe\Hippy\Facade

Afficher le fichier Open project: rcrowe/hippy Class Usage Examples

Protected Properties

Свойство Type Description
$client Client
$queue Queue

Méthodes publiques

Méthode Description
add ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void Add a plain text message to the queue.
addHtml ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void Add a html message to the queue.
go ( ) : void Send all messages in the queue.
html ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void Send a html message.
init ( string $token, string | integer $room, string $from, rcrowe\Hippy\Transport\TransportInterface $transport = null ) Initialise the facade. Must be called first.
text ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void Send a plain text message.

Method Details

add() public static méthode

Add a plain text message to the queue.
public static add ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void
$msg string
$notify boolean
$background string
Résultat void

addHtml() public static méthode

Add a html message to the queue.
public static addHtml ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void
$msg string
$notify boolean
$background string
Résultat void

go() public static méthode

Send all messages in the queue.
public static go ( ) : void
Résultat void

html() public static méthode

Send a html message.
public static html ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void
$msg string
$notify boolean
$background string
Résultat void

init() public static méthode

Initialise the facade. Must be called first.
public static init ( string $token, string | integer $room, string $from, rcrowe\Hippy\Transport\TransportInterface $transport = null )
$token string API token.
$room string | integer Room to send message to.
$from string Who the message is from.
$transport rcrowe\Hippy\Transport\TransportInterface

text() public static méthode

Send a plain text message.
public static text ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void
$msg string
$notify boolean
$background string
Résultat void

Property Details

$client protected_oe static_oe property

protected static Client,rcrowe\Hippy $client
Résultat Client

$queue protected_oe static_oe property

protected static Queue,rcrowe\Hippy $queue
Résultat Queue