PHP Class MessageController, vanilla

Author: Vasiliy Pedak ([email protected])

Inheritance: extends RestController

Show file Open project: vanilla/vanilla Class Usage Examples

Public Properties

Property	Type	Description
$Uses		Objects to prep.

Public Methods

Method	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.

Protected Methods

Method	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 method

Get descriptions of asset locations on page.

Since: 2.0.0

protected _getAssetData ( ) : array
return	array

_getLocationData() protected method

Get descriptions of asset locations across site.

Since: 2.0.0

protected _getLocationData ( ) : array
return	array

add() public method

Form to create a new message.

Since: 2.0.0

public add ( )

delete() public method

Delete a message.

Since: 2.0.0

public delete ( integer \| string $MessageID = '' )
$MessageID	integer \| string

disable() public method

public disable ( $messageID )

dismiss() public method

Dismiss a message (per user).

Since: 2.0.0

public dismiss ( integer \| string $MessageID = '', mixed $TransientKey = false )
$MessageID	integer \| string
$TransientKey	mixed

edit() public method

Form to edit an existing message.

Since: 2.0.0

public edit ( integer \| string $MessageID = '' )
$MessageID	integer \| string

enable() public method

public enable ( $messageID )

index() public method

Main page. Show all messages.

Since: 2.0.0

public index ( )

initialize() public method

Always triggers first. Highlight path.

Since: 2.0.0

public initialize ( )

setEnabled() protected method

protected setEnabled ( $messageID, $enabled )

Property Details

$Uses public property

Objects to prep.

public $Uses