Movement
extends BaseController
in package
Movement Class
Table of Contents
- MODULE_ID = 8
- REDIRECT_TARGET = 'game.php?page=movement'
- $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
- $fleets : Fleets
- $premium : Premium
- $research : Research
- __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
- buildActionsBlock() : string
- Build the list of actions block
- buildMovements() : array<string|int, mixed>
- Build the list of movements
- buildPage() : void
- Build the page
- buildShipsBlock() : string
- Create the ships tool tip block
- buildTitleBlock() : array<string|int, mixed>
- Build the title block
- buildToolTipBlock() : array<string|int, mixed>
- Build the topltip block
- execFleetReturn() : void
- Execute the fleet return if possible
- runAction() : void
- Run an action
- setUpFleets() : void
- Creates a new ships object that will handle all the ships creation methods and actions
Constants
MODULE_ID
public
int
MODULE_ID
= 8
REDIRECT_TARGET
public
string
REDIRECT_TARGET
= 'game.php?page=movement'
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
$fleets
private
Fleets
$fleets
= null
$premium
private
Premium
$premium
= null
$research
private
Research
$research
= 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> —buildActionsBlock()
Build the list of actions block
private
buildActionsBlock(FleetEntity $fleet) : string
Parameters
- $fleet : FleetEntity
Return values
string —buildMovements()
Build the list of movements
private
buildMovements() : array<string|int, mixed>
Return values
array<string|int, mixed> —buildPage()
Build the page
private
buildPage() : void
Return values
void —buildShipsBlock()
Create the ships tool tip block
private
buildShipsBlock(string $fleet_array) : string
Parameters
- $fleet_array : string
-
Fleet array
Return values
string —buildTitleBlock()
Build the title block
private
buildTitleBlock(int $fleet_mess) : array<string|int, mixed>
Parameters
- $fleet_mess : int
-
Fleet Mess
Return values
array<string|int, mixed> —buildToolTipBlock()
Build the topltip block
private
buildToolTipBlock(int $fleet_mess) : array<string|int, mixed>
Parameters
- $fleet_mess : int
-
Fleet Mess
Return values
array<string|int, mixed> —execFleetReturn()
Execute the fleet return if possible
private
execFleetReturn() : void
Return values
void —runAction()
Run an action
private
runAction() : void
Return values
void —setUpFleets()
Creates a new ships object that will handle all the ships creation methods and actions
private
setUpFleets() : void