functions-reconfigure.php
handles reconfiguration when the install signature has changed
Table of Contents
Constants
- PROTOCOL = 'http'
Functions
- reconfigureAction() : mixed
- Executes the configuration change code
- checkSignature() : type
- Checks details of configuration change
- signatureChange() : string
- Notification handler for configuration change
- addReconfigureNote() : mixed
- Adds the reconfigure notification via filters
- printReconfigureNote() : mixed
- prints HTML for the configuration change notification
- getReconfigureNote() : array<string|int, mixed>
- Gets data for the configuration change notification
- printReconfigureError() : mixed
- Prints an error page on the frontend if a mandatory reconfigure issue occurred but the visitor is not loggedin with appropiate rights.
- debuglogReconfigureNote() : mixed
- Adds debuglog entries about the reconfigure note
- ignoreSetupRunRequest() : mixed
- If setup request a run because of a signature change this refreshes the signature on full admin user request so it is ignored until the next signature change.
- isSetupProtected() : array<string|int, mixed>
- Checks if setup files are protected. Returns array of the protected files or empty array
- unprotectSetupFiles() : mixed
- Unprotectes setup files
- protectSetupFiles() : mixed
- Protects setup files
- reconfigureCSS() : mixed
- CSS for the configuration change notification
Constants
PROTOCOL
public
mixed
PROTOCOL
= 'http'
Functions
reconfigureAction()
Executes the configuration change code
reconfigureAction(int $mandatory) : mixed
Parameters
- $mandatory : int
-
0-3 0 means signature change where 1 means setup must autorun assuming a fresh install
checkSignature()
Checks details of configuration change
checkSignature(bool $auto) : type
Parameters
- $auto : bool
Tags
Return values
typesignatureChange()
Notification handler for configuration change
signatureChange([string $tab = NULL ][, string $subtab = NULL ]) : string
Parameters
- $tab : string = NULL
- $subtab : string = NULL
Return values
stringaddReconfigureNote()
Adds the reconfigure notification via filters
addReconfigureNote() : mixed
Tags
printReconfigureNote()
prints HTML for the configuration change notification
printReconfigureNote(array<string|int, mixed> $diff, type $needs, type $mandatory) : mixed
Parameters
- $diff : array<string|int, mixed>
- $needs : type
- $mandatory : type
Tags
getReconfigureNote()
Gets data for the configuration change notification
getReconfigureNote(array<string|int, mixed> $diff, type $needs, type $mandatory) : array<string|int, mixed>
Also adds entries to the debuglog.
Parameters
- $diff : array<string|int, mixed>
- $needs : type
- $mandatory : type
Tags
Return values
array<string|int, mixed>printReconfigureError()
Prints an error page on the frontend if a mandatory reconfigure issue occurred but the visitor is not loggedin with appropiate rights.
printReconfigureError(mixed $mandatory) : mixed
Parameters
- $mandatory : mixed
debuglogReconfigureNote()
Adds debuglog entries about the reconfigure note
debuglogReconfigureNote(array<string|int, mixed> $notice) : mixed
Parameters
- $notice : array<string|int, mixed>
-
reconfigure notice array as returned by getReconfigureNote()
ignoreSetupRunRequest()
If setup request a run because of a signature change this refreshes the signature on full admin user request so it is ignored until the next signature change.
ignoreSetupRunRequest() : mixed
Tags
isSetupProtected()
Checks if setup files are protected. Returns array of the protected files or empty array
isSetupProtected() : array<string|int, mixed>
Return values
array<string|int, mixed>unprotectSetupFiles()
Unprotectes setup files
unprotectSetupFiles() : mixed
protectSetupFiles()
Protects setup files
protectSetupFiles() : mixed
reconfigureCSS()
CSS for the configuration change notification
reconfigureCSS() : mixed