EasyBlogMaintenance
in package
Table of Contents
Properties
- $error : string
- Variable to hold error set by scripts
Methods
- cleanup() : mixed
- debug() : mixed
- factory() : mixed
- getError() : string
- General get error function that returns error set by executing the script
- getInstance() : mixed
- getScriptClassName() : string
- Get the script class name
- getScriptDescription() : string
- Get the script description
- getScriptFiles() : array<string|int, mixed>
- Get the available script files and return the file path in an array
- getScripts() : array<string|int, mixed>
- Get the available scripts and returns the script object in an array
- getScriptTitle() : string
- Get the script title
- hasError() : bool
- Checks if there are any error generated by executing the script
- runScript() : bool
- Wraooer function to execute the script
- setError() : mixed
- General set error function for the wrapper execute function
Properties
$error
Variable to hold error set by scripts
public
string
$error
Methods
cleanup()
public
cleanup() : mixed
debug()
public
debug() : mixed
factory()
public
static factory() : mixed
getError()
General get error function that returns error set by executing the script
public
getError() : string
Tags
Return values
string —The error message
getInstance()
public
static getInstance() : mixed
getScriptClassName()
Get the script class name
public
getScriptClassName(string $file) : string
Parameters
- $file : string
-
The path of the script
Tags
Return values
string —The class name of the script
getScriptDescription()
Get the script description
public
getScriptDescription(string $file) : string
Parameters
- $file : string
-
The path of the script
Tags
Return values
string —The description of the script
getScriptFiles()
Get the available script files and return the file path in an array
public
getScriptFiles([string $from = null ][, mixed $operator = '>' ]) : array<string|int, mixed>
Parameters
- $from : string = null
-
The version to pull from
- $operator : mixed = '>'
Tags
Return values
array<string|int, mixed> —Array of script paths
getScripts()
Get the available scripts and returns the script object in an array
public
getScripts([string $from = null ]) : array<string|int, mixed>
Parameters
- $from : string = null
-
The version to pull from
Tags
Return values
array<string|int, mixed> —Array of script objects
getScriptTitle()
Get the script title
public
getScriptTitle(string $file) : string
Parameters
- $file : string
-
The path of the script
Tags
Return values
string —The title of the script
hasError()
Checks if there are any error generated by executing the script
public
hasError() : bool
Tags
Return values
bool —True if there is an error
runScript()
Wraooer function to execute the script
public
runScript(string $file) : bool
Parameters
- $file : string
-
The path of the script or the script object
Tags
Return values
bool —State of the script execution result
setError()
General set error function for the wrapper execute function
public
setError(string $msg) : mixed
Parameters
- $msg : string
-
The error message