maintenanceMode
in package
Maintenance mode utility class based on the former site_upgrade plugin
Tags
Table of Contents
- getButtonDefinition() : array<string|int, mixed>
- Gets the utility button definition
- getPlaceholderHTML() : string
- Gets the placeholder HTML page
- getPlaceHolderRSS() : string
- Gets the placeholder RSS feed
- getState() : string
- Gets the site state
- getStateNote() : string
- Gets the site state note
- getUtilityLinkHTML() : mixed
- Gets a link element with a link to the utiltiy if the current user has admin rights
- loadPlaceholderPage() : mixed
- Loads the placeholder page if the site is in test mode
- printStateNotice() : mixed
- Prins the site state notice on the backend
- restorePlaceholderFiles() : mixed
- Restores the placeholder files
- setState() : mixed
- Updates the site state
Methods
getButtonDefinition()
Gets the utility button definition
public
static getButtonDefinition() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPlaceholderHTML()
Gets the placeholder HTML page
public
static getPlaceholderHTML([mixed $corecss = false ]) : string
Parameters
- $corecss : mixed = false
Return values
string —getPlaceHolderRSS()
Gets the placeholder RSS feed
public
static getPlaceHolderRSS() : string
Return values
string —getState()
Gets the site state
public
static getState() : string
Tags
Return values
string —getStateNote()
Gets the site state note
public
static getStateNote([string $which = null ]) : string
Parameters
- $which : string = null
-
Default null to get the note to the current status, 'open", 'closed" or "closed_for_test' to get the note on demand
Return values
string —getUtilityLinkHTML()
Gets a link element with a link to the utiltiy if the current user has admin rights
public
static getUtilityLinkHTML() : mixed
Return values
mixed —loadPlaceholderPage()
Loads the placeholder page if the site is in test mode
public
static loadPlaceholderPage() : mixed
Tags
Return values
mixed —printStateNotice()
Prins the site state notice on the backend
public
static printStateNotice() : mixed
Return values
mixed —restorePlaceholderFiles()
Restores the placeholder files
public
static restorePlaceholderFiles() : mixed
Tags
Return values
mixed —setState()
Updates the site state
public
static setState(string $state[, obj $mutexobj = null ]) : mixed
Parameters
- $state : string
-
'open', 'closed', 'closed_for_test'
- $mutexobj : obj = null
-
A mutex object either from zpMutex or setupMutex classes