XG Proyect

Fleetshortcuts extends BaseController
in package

Fleetshortcuts Class

Table of Contents

MODULE_ID  = 8
REDIRECT_TARGET  = 'game.php?page=shortcuts'
$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
$_clean_data  : array<string|int, mixed>
$_shortcuts  : Shortcuts
$_shortcuts_count  : int
__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
addShortcut()  : void
Create a shortcut
buildEdit()  : void
Build the edit view
buildPage()  : void
Build the page
buildShortcuts()  : array<string|int, mixed>
Build the shortcuts list
deleteShortcut()  : void
Delete a shortcut
editShortcut()  : void
Edit a shortcut
runAction()  : void
Run an action
setData()  : void
Set and save the post data if valid
setUpShortcuts()  : void
Creates a new shortcut object that will handle all the shortcuts creation methods and actions

Constants

REDIRECT_TARGET

public string REDIRECT_TARGET = 'game.php?page=shortcuts'

Properties

$planet

Contains the current planet data

protected array<string|int, mixed> $planet = []

$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
throws
Exception
Return values
void

getObjects()

Will be removed

protected getObjects() : array<string|int, mixed>
Tags
deprecated

since 3.2.0 will be removed on 4.0.0

Return values
array<string|int, mixed>

getPlanetData()

Will be removed

protected getPlanetData() : array<string|int, mixed>
Tags
deprecated

since 3.2.0 will be removed on 4.0.0

Return values
array<string|int, mixed>

getTemplate()

Will be removed

protected getTemplate() : array<string|int, mixed>
Tags
deprecated

since 3.2.0 will be removed on 4.0.0

Return values
array<string|int, mixed>

getUserData()

Will be removed

protected getUserData() : array<string|int, mixed>
Tags
deprecated

since 3.2.0 will be removed on 4.0.0

Return values
array<string|int, mixed>

addShortcut()

Create a shortcut

private addShortcut() : void
Return values
void

buildEdit()

Build the edit view

private buildEdit(array<string|int, mixed> $page) : void
Parameters
$page : array<string|int, mixed>

Page Data

Return values
void

buildPage()

Build the page

private buildPage() : void
Return values
void

buildShortcuts()

Build the shortcuts list

private buildShortcuts() : array<string|int, mixed>
Return values
array<string|int, mixed>

deleteShortcut()

Delete a shortcut

private deleteShortcut() : void
Return values
void

editShortcut()

Edit a shortcut

private editShortcut() : void
Return values
void

runAction()

Run an action

private runAction() : void
Return values
void

setData()

Set and save the post data if valid

private setData() : void
Return values
void

setUpShortcuts()

Creates a new shortcut object that will handle all the shortcuts creation methods and actions

private setUpShortcuts() : void
Return values
void

Search results