PHP Класс Redaxscript\Messenger

С версии: 3.0.0
Автор: Henry Ruhs
Автор: Balázs Szilágyi
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_actionArray array array of the action
$_optionArray array options of the messenger
$_registry object instance of the registry class

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

Метод Описание
__construct ( Registry $registry ) constructor of the class
doRedirect ( integer $timeout = 2 ) : Messenger do the redirect
error ( mixed $message = null, string $title = null ) : string error message
info ( mixed $message = null, string $title = null ) : string info message
init ( array $optionArray = [] ) : Messenger init the class
render ( string $type = null, mixed $message = null, string $title = null ) : string render
setRoute ( string $text = null, string $route = null ) : Messenger set the relative redirect url
setUrl ( string $text = null, string $url = null ) : Messenger set the absolute redirect url
success ( mixed $message = null, string $title = null ) : string success message
warning ( mixed $message = null, string $title = null ) : string warning message

Защищенные методы

Метод Описание
_renderAction ( string $type = null ) : string render action

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

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

constructor of the class
С версии: 2.4.0
public __construct ( Registry $registry )
$registry Registry instance of the registry class

_renderAction() защищенный Метод

render action
С версии: 3.0.0
protected _renderAction ( string $type = null ) : string
$type string type of the flash
Результат string

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

do the redirect
С версии: 3.0.0
public doRedirect ( integer $timeout = 2 ) : Messenger
$timeout integer timeout of the redirect
Результат Messenger

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

error message
С версии: 3.0.0
public error ( mixed $message = null, string $title = null ) : string
$message mixed message of the error
$title string title of the error
Результат string

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

info message
С версии: 3.0.0
public info ( mixed $message = null, string $title = null ) : string
$message mixed message of the info
$title string title of the info
Результат string

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

init the class
С версии: 3.0.0
public init ( array $optionArray = [] ) : Messenger
$optionArray array options of the messenger
Результат Messenger

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

render
С версии: 3.0.0
public render ( string $type = null, mixed $message = null, string $title = null ) : string
$type string type of the flash
$message mixed message of the flash
$title string title of the flash
Результат string

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

set the relative redirect url
С версии: 3.0.0
public setRoute ( string $text = null, string $route = null ) : Messenger
$text string text of the action
$route string relative route of the action
Результат Messenger

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

set the absolute redirect url
С версии: 3.0.0
public setUrl ( string $text = null, string $url = null ) : Messenger
$text string text of the action
$url string absolute url of the action
Результат Messenger

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

success message
С версии: 3.0.0
public success ( mixed $message = null, string $title = null ) : string
$message mixed message of the success
$title string title of the success
Результат string

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

warning message
С версии: 3.0.0
public warning ( mixed $message = null, string $title = null ) : string
$message mixed message of the warning
$title string message title of the warning
Результат string

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

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

array of the action
protected array $_actionArray
Результат array

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

options of the messenger
protected array $_optionArray
Результат array

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

instance of the registry class
protected object $_registry
Результат object