Notes
extends BaseController
in package
Notes Class
Table of Contents
- MODULE_ID = 19
- REDIRECT_TARGET = 'game.php?page=notes'
- $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
- $notes : Notes
- __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
- buildEditBlock() : array<string|int, mixed>
- Build the edit view
- buildNotesListBlock() : array<string|int, mixed>
- Build list of notes block
- buildPage() : void
- Build the page
- createNewNote() : void
- Create a new note
- deleteNote() : void
- Delete a note or multiple
- editNote() : void
- Edit a note
- getCurrentPage() : array<string|int, mixed>
- Get current page
- runAction() : void
- Run an action
- setUpNotes() : void
- Creates a new notes object that will handle all the notes creation methods and actions
Constants
MODULE_ID
public
int
MODULE_ID
= 19
REDIRECT_TARGET
public
string
REDIRECT_TARGET
= 'game.php?page=notes'
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
$notes
private
Notes
$notes
= 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> —buildEditBlock()
Build the edit view
private
buildEditBlock(int $edit_view) : array<string|int, mixed>
Parameters
- $edit_view : int
Return values
array<string|int, mixed> —buildNotesListBlock()
Build list of notes block
private
buildNotesListBlock() : array<string|int, mixed>
Return values
array<string|int, mixed> —buildPage()
Build the page
private
buildPage() : void
Return values
void —createNewNote()
Create a new note
private
createNewNote(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —deleteNote()
Delete a note or multiple
private
deleteNote(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —editNote()
Edit a note
private
editNote(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —getCurrentPage()
Get current page
private
getCurrentPage() : array<string|int, mixed>
Return values
array<string|int, mixed> —runAction()
Run an action
private
runAction() : void
Return values
void —setUpNotes()
Creates a new notes object that will handle all the notes creation methods and actions
private
setUpNotes() : void