Messages
extends BaseController
in package
Messages Class
Table of Contents
- MODULE_ID = 18
- $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
- $message_type : array<string|int, mixed>
- __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
- buildPage() : void
- Build the page
- doDeleteAction() : void
- Execute a delete action
- getAllinaceAddressBook() : array<string|int, mixed>
- Build the alliance members block to display
- getCurrentSection() : string
- Determine the current page and validate it
- getDefaultSection() : string
- Build the default messages section
- getExtraBlocksDisplay() : array<string|int, mixed>
- Get extra blocks
- getFriendsAddressBook() : array<string|int, mixed>
- Build the friends block to display
- getMessagesList() : array<string|int, mixed>
- Return an array with a list of messages
- getMessagesTypesList() : array<string|int, mixed>
- Build the list of message types
- getNotesList() : array<string|int, mixed>
- Build the notes block to display
- getOperatorsAddressBook() : array<string|int, mixed>
- Return an array with a list of operators
- getPremiumSection() : string
- Build the premium messages section
- runAction() : void
- Run an action
- setMessageReply() : string
- Set the message reply icon
Constants
MODULE_ID
public
mixed
MODULE_ID
= 18
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
$message_type
private
array<string|int, mixed>
$message_type
= [AppcoreenumeratorsMessagesEnumerator::ESPIO => ['type_name' => 'espioopen'], AppcoreenumeratorsMessagesEnumerator::COMBAT => ['type_name' => 'combatopen'], AppcoreenumeratorsMessagesEnumerator::EXP => ['type_name' => 'expopen'], AppcoreenumeratorsMessagesEnumerator::ALLY => ['type_name' => 'allyopen'], AppcoreenumeratorsMessagesEnumerator::USER => ['type_name' => 'useropen'], AppcoreenumeratorsMessagesEnumerator::GENERAL => ['type_name' => 'generalopen']]
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> —buildPage()
Build the page
private
buildPage() : void
Return values
void —doDeleteAction()
Execute a delete action
private
doDeleteAction() : void
Return values
void —getAllinaceAddressBook()
Build the alliance members block to display
private
getAllinaceAddressBook() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCurrentSection()
Determine the current page and validate it
private
getCurrentSection() : string
Return values
string —getDefaultSection()
Build the default messages section
private
getDefaultSection() : string
Return values
string —getExtraBlocksDisplay()
Get extra blocks
private
getExtraBlocksDisplay() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFriendsAddressBook()
Build the friends block to display
private
getFriendsAddressBook() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMessagesList()
Return an array with a list of messages
private
getMessagesList(string $messages) : array<string|int, mixed>
Parameters
- $messages : string
-
The messages
Return values
array<string|int, mixed> —getMessagesTypesList()
Build the list of message types
private
getMessagesTypesList(array<string|int, mixed> $active) : array<string|int, mixed>
Parameters
- $active : array<string|int, mixed>
Return values
array<string|int, mixed> —getNotesList()
Build the notes block to display
private
getNotesList() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOperatorsAddressBook()
Return an array with a list of operators
private
getOperatorsAddressBook() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPremiumSection()
Build the premium messages section
private
getPremiumSection() : string
Return values
string —runAction()
Run an action
private
runAction() : void
Return values
void —setMessageReply()
Set the message reply icon
private
setMessageReply(int $from) : string
Parameters
- $from : int