Page
in package
Page Class
Table of Contents
- $current_planet : array<string|int, mixed>
- $current_user : array<string|int, mixed>
- $current_year : int
- $langs : Language
- $objects : Objects
- $template : Template
- __construct() : mixed
- Constructor
- display() : void
- display
- displayAdmin() : void
- Display the admin page
- displayInstall() : void
- Display the installation page
- jsReady() : string
- Removes speacial chars like tabs, new lines and carriage return.
- adminFooter() : string
- Set the admin footer
- adminNavigation() : string
- Set the admin navigation
- adminPage() : string
- Set the admin page
- adminSidebar() : string
- Set the admin sidebar
- adminSimpleFooter() : string
- Set admin simple footer
- adminSimpleHeader() : string
- Set the admin meta header
- buildOfficersBlock() : array<string|int, mixed>
- Build the officers block for the game topnav
- buildPlanetList() : void
- Build the list of planet
- gameHeader() : string
- gameHeader
- gameMenu() : string
- gameMenu
- gameNavbar() : string
- gameNavbar
- installHeader() : string
- installHeader
- installMenu() : string
- installMenu
- installNavbar() : string
- installNavbar
- setLanguage() : void
- Set language object
- setObjects() : void
- Set objects object
- setTemplate() : void
- Set template object
- sortPlanets() : void
- Sort planets
Properties
$current_planet
private
array<string|int, mixed>
$current_planet
$current_user
private
array<string|int, mixed>
$current_user
$current_year
private
int
$current_year
$langs
private
Language
$langs
$objects
private
Objects
$objects
$template
private
Template
$template
Methods
__construct()
Constructor
public
__construct(object $users) : mixed
Parameters
- $users : object
Return values
mixed —display()
display
public
display(string $current_page[, bool $topnav = true ][, string $metatags = '' ][, bool $menu = true ]) : void
Parameters
- $current_page : string
-
Current page
- $topnav : bool = true
-
Show topnav
- $metatags : string = ''
-
Meta tags
- $menu : bool = true
-
Show menu
Return values
void —displayAdmin()
Display the admin page
public
displayAdmin(string $current_page[, bool $sidebar = true ][, bool $navigation = true ][, bool $footer = true ]) : void
Parameters
- $current_page : string
- $sidebar : bool = true
- $navigation : bool = true
- $footer : bool = true
Return values
void —displayInstall()
Display the installation page
public
displayInstall(string $current_page, array<string|int, mixed> $langs) : void
Parameters
- $current_page : string
- $langs : array<string|int, mixed>
Return values
void —jsReady()
Removes speacial chars like tabs, new lines and carriage return.
public
jsReady([string $template = '' ]) : string
Parameters
- $template : string = ''
-
Template
Return values
string —adminFooter()
Set the admin footer
private
adminFooter() : string
Return values
string —adminNavigation()
Set the admin navigation
private
adminNavigation() : string
Return values
string —adminPage()
Set the admin page
private
adminPage(string $page, array<string|int, mixed> $parse, bool $full) : string
Parameters
- $page : string
- $parse : array<string|int, mixed>
- $full : bool
Return values
string —adminSidebar()
Set the admin sidebar
private
adminSidebar() : string
Return values
string —adminSimpleFooter()
Set admin simple footer
private
adminSimpleFooter() : string
Return values
string —adminSimpleHeader()
Set the admin meta header
private
adminSimpleHeader() : string
Return values
string —buildOfficersBlock()
Build the officers block for the game topnav
private
buildOfficersBlock(array<string|int, mixed> $lang) : array<string|int, mixed>
Parameters
- $lang : array<string|int, mixed>
Return values
array<string|int, mixed> —buildPlanetList()
Build the list of planet
private
buildPlanetList() : void
Return values
void —gameHeader()
gameHeader
private
gameHeader([string $metatags = '' ]) : string
Parameters
- $metatags : string = ''
-
Meta tags
Return values
string —gameMenu()
gameMenu
private
gameMenu() : string
Return values
string —gameNavbar()
gameNavbar
private
gameNavbar() : string
Return values
string —installHeader()
installHeader
private
installHeader() : string
Return values
string —installMenu()
installMenu
private
installMenu(mixed $langs) : string
Parameters
- $langs : mixed
Return values
string —installNavbar()
installNavbar
private
installNavbar(mixed $langs) : string
Parameters
- $langs : mixed
Return values
string —setLanguage()
Set language object
private
setLanguage() : void
Return values
void —setObjects()
Set objects object
private
setObjects() : void
Return values
void —setTemplate()
Set template object
private
setTemplate() : void
Return values
void —sortPlanets()
Sort planets
private
sortPlanets() : void