Empire
extends BaseController
in package
Empire Class
Table of Contents
- MODULE_ID = 2
- The module ID
- $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
- __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
- buildBlocks() : array<string|int, mixed>
- Build all the different blocks
- buildPage() : void
- Build the page
- setCoords() : array<string|int, mixed>
- Set the planet coordinates
- setFields() : array<string|int, mixed>
- Set the planet fields
- setImage() : array<string|int, mixed>
- Set the planet image
- setName() : string
- Set the planet image
- setResources() : array<string|int, mixed>
- Set the planet resources
- setStructureData() : string
- Sets the structure data
Constants
MODULE_ID
The module ID
public
int
MODULE_ID
= 2
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
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> —buildBlocks()
Build all the different blocks
private
buildBlocks() : array<string|int, mixed>
Return values
array<string|int, mixed> —buildPage()
Build the page
private
buildPage() : void
Return values
void —setCoords()
Set the planet coordinates
private
setCoords(array<string|int, mixed> $planet) : array<string|int, mixed>
Parameters
- $planet : array<string|int, mixed>
Return values
array<string|int, mixed> —setFields()
Set the planet fields
private
setFields(array<string|int, mixed> $planet) : array<string|int, mixed>
Parameters
- $planet : array<string|int, mixed>
Return values
array<string|int, mixed> —setImage()
Set the planet image
private
setImage(array<string|int, mixed> $planet) : array<string|int, mixed>
Parameters
- $planet : array<string|int, mixed>
Return values
array<string|int, mixed> —setName()
Set the planet image
private
setName(array<string|int, mixed> $planet) : string
Parameters
- $planet : array<string|int, mixed>
Return values
string —setResources()
Set the planet resources
private
setResources(array<string|int, mixed> $planet, string $resource) : array<string|int, mixed>
Parameters
- $planet : array<string|int, mixed>
- $resource : string
Return values
array<string|int, mixed> —setStructureData()
Sets the structure data
private
setStructureData(array<string|int, mixed> $planet, array<string|int, mixed> $source, string $element, int $element_id) : string
Parameters
- $planet : array<string|int, mixed>
- $source : array<string|int, mixed>
- $element : string
- $element_id : int