TraderResources
extends BaseController
in package
Trader Class
Table of Contents
- MODULE_ID = 5
- The module ID
- PERCENTAGES = [10, 50, 100]
- Contains the refill percentages
- RESOURCES = ['metal', 'crystal', 'deuterium']
- Contains the resources type
- $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
- $error : string
- Contains an error message
- $trader : ResourceMarket
- ResourceMarket 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
- buildPage() : void
- Build the page
- buildResourcesSection() : array<string|int, mixed>
- Build resources section
- getPage() : array<string|int, mixed>
- Get the kind of trader that we are requesting
- refillResource() : void
- Refill resources
- runAction() : void
- Run an action
- setMessageDisplay() : array<string|int, mixed>
- Display the message block
- setRefillOptions() : array<string|int, mixed>
- Set the different refill options
- setUpTrader() : void
- Creates a new trader object that will handle all the trader creation methods and actions
Constants
MODULE_ID
The module ID
public
int
MODULE_ID
= 5
PERCENTAGES
Contains the refill percentages
public
array<string|int, mixed>
PERCENTAGES
= [10, 50, 100]
RESOURCES
Contains the resources type
public
array<string|int, mixed>
RESOURCES
= ['metal', 'crystal', 'deuterium']
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
$error
Contains an error message
private
string
$error
= ''
$trader
ResourceMarket object
private
ResourceMarket
$trader
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 —buildResourcesSection()
Build resources section
private
buildResourcesSection() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPage()
Get the kind of trader that we are requesting
private
getPage() : array<string|int, mixed>
Return values
array<string|int, mixed> —refillResource()
Refill resources
private
refillResource(string $resource, int $percentage) : void
Parameters
- $resource : string
- $percentage : int
Return values
void —runAction()
Run an action
private
runAction() : void
Return values
void —setMessageDisplay()
Display the message block
private
setMessageDisplay() : array<string|int, mixed>
Return values
array<string|int, mixed> —setRefillOptions()
Set the different refill options
private
setRefillOptions(string $resource) : array<string|int, mixed>
Parameters
- $resource : string
Return values
array<string|int, mixed> —setUpTrader()
Creates a new trader object that will handle all the trader creation methods and actions
private
setUpTrader() : void