Messages
extends BaseController
in package
Messages Class
Table of Contents
- $objects : Objects
- Contains the whole set of objects by request
- $page : Page
- Contains the Page object
- $planet : array<string|int, mixed>
- Contains the current planet data
- $template : Template
- Contains the Template object
- $user : array<string|int, mixed>
- Contains the current user data
- $userLibrary : User
- Contains the User object
- $alert : string
- Contains the alert string
- $results : array<string|int, mixed>
- Contains a list of results
- __construct() : mixed
- Constructor
- index() : void
- Users land here
- loadLang() : void
- Load a language file using CI Library
- loadModel() : void
- Load the provided model, support a dir path
- getObjects() : array<string|int, mixed>
- Will be removed
- getPlanetData() : array<string|int, mixed>
- Will be removed
- getTemplate() : array<string|int, mixed>
- Will be removed
- getUserData() : array<string|int, mixed>
- Will be removed
- buildMessageTypeBlock() : array<string|int, mixed>
- Build the list of message types
- buildPage() : void
- Build the page
- deleteMessage() : void
- Delete a single message
- deleteMessages() : void
- Delete multiple messages
- doSearch() : void
- Execute messages search
- runAction() : void
- Run an action
Properties
$objects
Contains the whole set of objects by request
protected
Objects
$objects
$page
Contains the Page object
protected
Page
$page
= null
$planet
Contains the current planet data
protected
array<string|int, mixed>
$planet
= []
$template
Contains the Template object
protected
Template
$template
= null
$user
Contains the current user data
protected
array<string|int, mixed>
$user
= []
$userLibrary
Contains the User object
protected
User
$userLibrary
= null
$alert
Contains the alert string
private
string
$alert
= ''
$results
Contains a list of results
private
array<string|int, mixed>
$results
= []
Methods
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —index()
Users land here
public
index() : void
Return values
void —loadLang()
Load a language file using CI Library
public
loadLang(string|array<string|int, mixed> $language_file) : void
Parameters
- $language_file : string|array<string|int, mixed>
Return values
void —loadModel()
Load the provided model, support a dir path
public
loadModel(string $class) : void
Parameters
- $class : string
-
Mandatory field, if not will throw an exception
Tags
Return values
void —getObjects()
Will be removed
protected
getObjects() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getPlanetData()
Will be removed
protected
getPlanetData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getTemplate()
Will be removed
protected
getTemplate() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getUserData()
Will be removed
protected
getUserData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —buildMessageTypeBlock()
Build the list of message types
private
buildMessageTypeBlock() : array<string|int, mixed>
Return values
array<string|int, mixed> —buildPage()
Build the page
private
buildPage() : void
Return values
void —deleteMessage()
Delete a single message
private
deleteMessage(int $message_id) : void
Parameters
- $message_id : int
Return values
void —deleteMessages()
Delete multiple messages
private
deleteMessages(array<string|int, mixed> $messages) : void
Parameters
- $messages : array<string|int, mixed>
Return values
void —doSearch()
Execute messages search
private
doSearch(array<string|int, mixed> $to_search) : void
Parameters
- $to_search : array<string|int, mixed>
Return values
void —runAction()
Run an action
private
runAction() : void