setup
in package
setup support class
Table of Contents
- acknowledge() : mixed
- charsetSelector() : mixed
- drop-down for character set selection
- checkMark() : int
- Prints an icon for success of failure of an action (it also returns the check level!)
- checkPermissions() : mixed
- checkPreviousVersion() : array<string|int, mixed>
- Checks if we are updating from an earlier version or reinstalling and returns an array with various info for the checkmark box
- checkServerSoftware() : bool
- Checks if the server software is Apache or Nginx
- checkUnique() : mixed
- closeSite() : mixed
- if site was closed, keep it that way.
- configMod() : mixed
- defaultOptionsRequest() : mixed
- fnmatch() : bool
- pattern match function in case it is not included in PHP
- folderCheck() : mixed
- checks presence and permissions of folders
- folderPermissions() : mixed
- getFileList() : mixed
- Returns a <ul> list with list entry containing <code> enclosed text
- getResidentZPFiles() : mixed
- enumerates the files in folder(s)
- getServerSoftware() : string
- Returns either "apache" or "nginx" for supported server software or the full $_SERVER['SERVER_SOFTWARE'] info
- getVersions() : array<string|int, mixed>
- Returns am array with all release versions since 1.2
- getXSRFToken() : string
- Generates an XSRFtoken
- glob() : mixed
- file lister for setup
- isMac() : mixed
- Returns true if we are running on a Macintosh
- isWin() : bool
- Returns true if we are running on a Windows server
- languageSelector() : mixed
- prints the language selector
- locale() : mixed
- log() : mixed
- mkdir_r() : mixed
- permissionsSelector() : string
- primeMark() : mixed
- printFooter() : mixed
- sanitize() : type
- sanitize_string() : type
- secureServer() : bool
- Checks to see if access was through a secure protocol
- siteClosed() : mixed
- updateConfigfile() : mixed
- userAuthorized() : mixed
- versionCheck() : mixed
- compares versions for required, desired version levels
- XSRFDefender() : mixed
- Validates an XSRFtoken
Methods
acknowledge()
public
static acknowledge(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —charsetSelector()
drop-down for character set selection
public
static charsetSelector( $select) : mixed
Parameters
Return values
mixed —checkMark()
Prints an icon for success of failure of an action (it also returns the check level!)
public
static checkMark(int $check, type $text, type $text2, type $msg[, bool $stopAutorun = true ][, mixed $display_success = false ]) : int
Parameters
- $check : int
-
0 = fail, -1,-3 = warning, 1 or -2 = pass
- $text : type
-
Success text
- $text2 : type
-
Warning text
- $msg : type
-
Detailed message
- $stopAutorun : bool = true
-
True if a show (setup) stopping issue
- $display_success : mixed = false
Tags
Return values
int —checkPermissions()
public
static checkPermissions(mixed $actual, mixed $expected) : mixed
Parameters
- $actual : mixed
- $expected : mixed
Return values
mixed —checkPreviousVersion()
Checks if we are updating from an earlier version or reinstalling and returns an array with various info for the checkmark box
public
static checkPreviousVersion() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —checkServerSoftware()
Checks if the server software is Apache or Nginx
public
static checkServerSoftware() : bool
Tags
Return values
bool —checkUnique()
public
static checkUnique(mixed $table, mixed $unique) : mixed
Parameters
- $table : mixed
- $unique : mixed
Return values
mixed —closeSite()
if site was closed, keep it that way.
public
static closeSite(mixed $nht) : mixed
...
Parameters
- $nht : mixed
Return values
mixed —configMod()
public
static configMod() : mixed
Return values
mixed —defaultOptionsRequest()
public
static defaultOptionsRequest(mixed $name[, mixed $type = 'plugin' ]) : mixed
Parameters
- $name : mixed
- $type : mixed = 'plugin'
Return values
mixed —fnmatch()
pattern match function in case it is not included in PHP
public
static fnmatch(string $pattern, string $string) : bool
Parameters
- $pattern : string
-
pattern
- $string : string
-
haystack
Return values
bool —folderCheck()
checks presence and permissions of folders
public
static folderCheck( $which, $path, $class, $subfolders, mixed $recurse, mixed $chmod, mixed $updatechmod) : mixed
Parameters
Return values
mixed —folderPermissions()
public
static folderPermissions(mixed $folder) : mixed
Parameters
- $folder : mixed
Return values
mixed —getFileList()
Returns a <ul> list with list entry containing <code> enclosed text
public
static getFileList(array<string|int, mixed> $array) : mixed
Parameters
- $array : array<string|int, mixed>
-
One dimensional array
Return values
mixed —getResidentZPFiles()
enumerates the files in folder(s)
public
static getResidentZPFiles( $folder[, mixed $lcFilesystem = false ]) : mixed
Parameters
Return values
mixed —getServerSoftware()
Returns either "apache" or "nginx" for supported server software or the full $_SERVER['SERVER_SOFTWARE'] info
public
static getServerSoftware() : string
Tags
Return values
string —getVersions()
Returns am array with all release versions since 1.2
public
static getVersions() : array<string|int, mixed>
Note: THis needs to be kept current and updated with the previous version with every release
Tags
Return values
array<string|int, mixed> —getXSRFToken()
Generates an XSRFtoken
public
static getXSRFToken() : string
Tags
Return values
string —glob()
file lister for setup
public
static glob( $pattern, $flags) : mixed
Parameters
Return values
mixed —isMac()
Returns true if we are running on a Macintosh
public
static isMac() : mixed
Return values
mixed —isWin()
Returns true if we are running on a Windows server
public
static isWin() : bool
Return values
bool —languageSelector()
prints the language selector
public
static languageSelector() : mixed
Return values
mixed —locale()
public
static locale(mixed $locale) : mixed
Parameters
- $locale : mixed
Return values
mixed —log()
public
static log(type $message[, type $anyway = false ][, type $reset = false ]) : mixed
Parameters
- $message : type
- $anyway : type = false
- $reset : type = false
Tags
Return values
mixed —mkdir_r()
public
static mkdir_r(mixed $pathname, mixed $mode) : mixed
Parameters
- $pathname : mixed
- $mode : mixed
Return values
mixed —permissionsSelector()
public
static permissionsSelector(type $permission_names, type $select) : string
Parameters
- $permission_names : type
- $select : type
Tags
Return values
string —primeMark()
public
static primeMark(type $text) : mixed
Parameters
- $text : type
Tags
Return values
mixed —printFooter()
public
static printFooter() : mixed
Return values
mixed —sanitize()
public
static sanitize(type $input_string[, type $sanitize_level = 3 ]) : type
Parameters
- $input_string : type
- $sanitize_level : type = 3
Return values
type —sanitize_string()
public
static sanitize_string(type $input_string, type $sanitize_level) : type
Parameters
- $input_string : type
- $sanitize_level : type
Return values
type —secureServer()
Checks to see if access was through a secure protocol
public
static secureServer() : bool
Tags
Return values
bool —siteClosed()
public
static siteClosed(mixed $ht) : mixed
Parameters
- $ht : mixed
Return values
mixed —updateConfigfile()
public
static updateConfigfile(mixed $zp_cfg) : mixed
Parameters
- $zp_cfg : mixed
Return values
mixed —userAuthorized()
public
static userAuthorized() : mixed
Return values
mixed —versionCheck()
compares versions for required, desired version levels
public
static versionCheck( $required, $desired, $found) : mixed
Parameters
Return values
mixed —XSRFDefender()
Validates an XSRFtoken
public
static XSRFDefender() : mixed