XG Proyect

Installation extends BaseController
in package

Installation 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
$db_host  : mixed
$db_name  : mixed
$db_password  : mixed
$db_prefix  : mixed
$db_user  : mixed
__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
adminExists()  : bool
adminExists
buildPage()  : void
Build the page
createAccount()  : negative
createAccount
generateToken()  : mixed
generateToken
insertDbData()  : bool
insertDbData
isInstalled()  : bool
isInstalled
isWritable()  : bool
isWritable
saveMessage()  : array<string|int, mixed>
saveMessage
serverRequirementes()  : mixed
method server_requirementes param return true if the required server requirements are met
tablesExists()  : bool
tablesExists
tryConnection()  : bool
tryConnection
tryDatabase()  : bool
tryDatabase
validateDbData()  : bool
validateDbData
writeConfigFile()  : bool
writeConfigFile

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>

adminExists()

adminExists

private adminExists() : bool
Return values
bool

buildPage()

Build the page

private buildPage() : void
Return values
void

createAccount()

createAccount

private createAccount() : negative
Return values
negative

value if an error ocurred, or 0 if admin account was successfully created -1: Some field is empty -2: Admin email is invalid

generateToken()

generateToken

private generateToken() : mixed

return string

Return values
mixed

insertDbData()

insertDbData

private insertDbData() : bool
Return values
bool

isInstalled()

isInstalled

private isInstalled() : bool
Return values
bool

isWritable()

isWritable

private isWritable() : bool
Return values
bool

saveMessage()

saveMessage

private saveMessage(string $message[, string $result = 'ok' ]) : array<string|int, mixed>
Parameters
$message : string

Message

$result : string = 'ok'

Result

Return values
array<string|int, mixed>

serverRequirementes()

method server_requirementes param return true if the required server requirements are met

private serverRequirementes() : mixed
Return values
mixed

tablesExists()

tablesExists

private tablesExists() : bool
Return values
bool

tryConnection()

tryConnection

private tryConnection() : bool
Return values
bool

tryDatabase()

tryDatabase

private tryDatabase() : bool
Return values
bool

validateDbData()

validateDbData

private validateDbData() : bool
Return values
bool

writeConfigFile()

writeConfigFile

private writeConfigFile() : bool
Return values
bool

Search results