PHP Class MessageController, vanilla

Author: Vasiliy Pedak ([email protected])
Inheritance: extends RestController
Afficher le fichier Open project: vanilla/vanilla Class Usage Examples

Méthodes publiques

Свойство Type Description
$Uses Objects to prep.

Méthodes publiques

Méthode Description
add ( ) Form to create a new message.
delete ( integer | string $MessageID = '' ) Delete a message.
disable ( $messageID )
dismiss ( integer | string $MessageID = '', mixed $TransientKey = false ) Dismiss a message (per user).
edit ( integer | string $MessageID = '' ) Form to edit an existing message.
enable ( $messageID )
index ( ) Main page. Show all messages.
initialize ( ) Always triggers first. Highlight path.

Méthodes protégées

Méthode Description
_getAssetData ( ) : array Get descriptions of asset locations on page.
_getLocationData ( ) : array Get descriptions of asset locations across site.
setEnabled ( $messageID, $enabled )

Method Details

_getAssetData() protected méthode

Get descriptions of asset locations on page.
Since: 2.0.0
protected _getAssetData ( ) : array
Résultat array

_getLocationData() protected méthode

Get descriptions of asset locations across site.
Since: 2.0.0
protected _getLocationData ( ) : array
Résultat array

add() public méthode

Form to create a new message.
Since: 2.0.0
public add ( )

delete() public méthode

Delete a message.
Since: 2.0.0
public delete ( integer | string $MessageID = '' )
$MessageID integer | string

disable() public méthode

public disable ( $messageID )

dismiss() public méthode

Dismiss a message (per user).
Since: 2.0.0
public dismiss ( integer | string $MessageID = '', mixed $TransientKey = false )
$MessageID integer | string
$TransientKey mixed

edit() public méthode

Form to edit an existing message.
Since: 2.0.0
public edit ( integer | string $MessageID = '' )
$MessageID integer | string

enable() public méthode

public enable ( $messageID )

index() public méthode

Main page. Show all messages.
Since: 2.0.0
public index ( )

initialize() public méthode

Always triggers first. Highlight path.
Since: 2.0.0
public initialize ( )

setEnabled() protected méthode

protected setEnabled ( $messageID, $enabled )

Property Details

$Uses public_oe property

Objects to prep.
public $Uses