PHP Класс rcrowe\Hippy\Facade

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$client Client
$queue Queue

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

Метод Описание
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.

Описание методов

add() публичный статический Метод

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
Результат void

addHtml() публичный статический Метод

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
Результат void

go() публичный статический Метод

Send all messages in the queue.
public static go ( ) : void
Результат void

html() публичный статический Метод

Send a html message.
public static html ( string $msg, boolean $notify = false, string $background = Message::BACKGROUND_YELLOW ) : void
$msg string
$notify boolean
$background string
Результат void

init() публичный статический Метод

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

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
Результат void

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

$client защищенное статическое свойство

protected static Client,rcrowe\Hippy $client
Результат Client

$queue защищенное статическое свойство

protected static Queue,rcrowe\Hippy $queue
Результат Queue