Fleet3
extends BaseController
in package
Fleet3 Class
Table of Contents
- MODULE_ID = 8
- REDIRECT_TARGET = 'game.php?page=fleet1'
- $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
- $_allowed_missions : array<string|int, mixed>
- $_current_mission : int
- $_research : Fleets
- __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
- buildFleetBlock() : array<string|int, mixed>
- Build the fleet inputs block
- buildMissionBlock() : string
- Build the missions block
- buildPage() : void
- Build the page
- buildStayBlock() : string
- Build the stay time block
- buildTitleBlock() : string
- Build the title block
- getAllowedMissions() : array<string|int, mixed>
- Get allowed missions per ship and option
- getSessionShips() : array<string|int, mixed>
- Get the ships that were set in the session
- isCurrentPlanet() : bool
- Check if it is the current planet
- isFriendly() : bool
- Check if it is a friendly target
- setInputsData() : array<string|int, mixed>
- Set inputs data
- 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=fleet1'
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
$_allowed_missions
private
array<string|int, mixed>
$_allowed_missions
= []
$_current_mission
private
int
$_current_mission
= 0
$_research
private
Fleets
$_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> —buildFleetBlock()
Build the fleet inputs block
private
buildFleetBlock() : array<string|int, mixed>
Return values
array<string|int, mixed> —buildMissionBlock()
Build the missions block
private
buildMissionBlock() : string
Return values
string —buildPage()
Build the page
private
buildPage() : void
Return values
void —buildStayBlock()
Build the stay time block
private
buildStayBlock() : string
Return values
string —buildTitleBlock()
Build the title block
private
buildTitleBlock() : string
Return values
string —getAllowedMissions()
Get allowed missions per ship and option
private
getAllowedMissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSessionShips()
Get the ships that were set in the session
private
getSessionShips() : array<string|int, mixed>
Return values
array<string|int, mixed> —isCurrentPlanet()
Check if it is the current planet
private
isCurrentPlanet(array<string|int, mixed> $target) : bool
Parameters
- $target : array<string|int, mixed>
Return values
bool —isFriendly()
Check if it is a friendly target
private
isFriendly(array<string|int, mixed> $target_planet) : bool
Parameters
- $target_planet : array<string|int, mixed>
Return values
bool —setInputsData()
Set inputs data
private
setInputsData() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUpFleets()
Creates a new ships object that will handle all the ships creation methods and actions
private
setUpFleets() : void