Backup
extends BaseController
in package
Backup Class
Table of Contents
- BACKUP_SETTINGS = ['auto_backup' => FILTER_SANITIZE_STRING]
- $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
- __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
- doDeleteAction() : void
- Delete the provided file
- doDownloadAction() : void
- Download the provided file
- formatFileName() : string
- Format the file name to get the current date as name
- getBackupList() : void
- Build the list of available backups
- getBackupSettings() : void
- Get new user registration settings
- isValidFile() : bool
- Check whether if it's a valid file, returns an empty string if it's not
- runAction() : void
- Run an action
- setChecked() : array<string|int, mixed>
- Coverts the setting value from an int to a "checked"
Constants
BACKUP_SETTINGS
public
mixed
BACKUP_SETTINGS
= ['auto_backup' => FILTER_SANITIZE_STRING]
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
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> —buildPage()
Build the page
private
buildPage() : void
Return values
void —doDeleteAction()
Delete the provided file
private
doDeleteAction(string $file_name) : void
Parameters
- $file_name : string
Return values
void —doDownloadAction()
Download the provided file
private
doDownloadAction(string $file_name) : void
Parameters
- $file_name : string
Return values
void —formatFileName()
Format the file name to get the current date as name
private
formatFileName(string $file_name) : string
Parameters
- $file_name : string
Return values
string —getBackupList()
Build the list of available backups
private
getBackupList() : void
Return values
void —getBackupSettings()
Get new user registration settings
private
getBackupSettings() : void
Return values
void —isValidFile()
Check whether if it's a valid file, returns an empty string if it's not
private
isValidFile(string $file_name) : bool
Parameters
- $file_name : string
Return values
bool —runAction()
Run an action
private
runAction() : void
Return values
void —setChecked()
Coverts the setting value from an int to a "checked"
private
setChecked(array<string|int, mixed> $settings) : array<string|int, mixed>
Parameters
- $settings : array<string|int, mixed>