XG Proyect

Mail extends BaseController
in package

Mail Class

Table of Contents

$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
$game_name  : string
Contains the game name
$send_result  : string
Contains the send email result message
__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
processRequest()  : bool
Process the request
runAction()  : void
Run an action
sendPassEmail()  : bool
Send email with the new password
setUpData()  : void
Set up some data that will be accessed many times

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

$game_name

Contains the game name

private string $game_name = ''

$send_result

Contains the send email result message

private string $send_result = ''

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> —

buildPage()

Build the page

private buildPage() : void
Return values
void —

processRequest()

Process the request

private processRequest(string $email) : bool
Parameters
$email : string
Return values
bool —

runAction()

Run an action

private runAction() : void
Return values
void —

sendPassEmail()

Send email with the new password

private sendPassEmail(string $email, string $new_password) : bool
Parameters
$email : string
$new_password : string
Return values
bool —

setUpData()

Set up some data that will be accessed many times

private setUpData() : void
Return values
void —

Search results