Documentation

Config
in package

Table of Contents

Properties

$_objTpl  : mixed
$strErrMessage  : mixed
$strOkMessage  : mixed
$strPageTitle  : mixed
$configFile  : mixed
$configlist  : array<string|int, mixed>
List of base configurations Used for automatic (re-)initialization
$sections  : array<string|int, mixed>
List of backend configuration sections
$act  : mixed
$writable  : mixed

Methods

__construct()  : mixed
_smtpDefaultAccount()  : mixed
_smtpDeleteAccount()  : mixed
_smtpModify()  : mixed
_smtpOverview()  : mixed
checkAccessibility()  : bool
Checks whether the currently configured domain url is accessible
editThumbnails()  : mixed
fetchConfigFromSettingsFile()  : array<string|int, mixed>
Load a settings.php file and return its configuration ($_CONFIG) as array
generateThumbnails()  : mixed
Regenerate the thumbnails
getBackendLanguages()  : string
Shows all backend languages
getCaptchaOptions()  : string
Returns captcha options
getClientSideScriptUploadOptions()  : string
Returns client side script upload options
getDomains()  : string
Shows the all domains page
getLocales()  : string
Shows all locales
getPage()  : void
Perform the requested function depending on $_REQUEST['act']
getPortOptions()  : string
Returns port options
getReverseProxyTypes()  : string
Gets the list of reverse proxy types
getSettingsFile()  : string
get the settings file path
getSsiOutputModes()  : string
Gets the list of ESI/SSI output modes
getSsiTypes()  : string
Gets the list of supported system types for external ESI/SSI processing
getTimezoneOptions()  : string
Returns all available timezones
getUserGroups()  : string
Returns user groups
image()  : bool
Shows the image settings page
init()  : mixed
Initializes basic config of Cloudrexx
isANumber()  : bool
Check whether the given string is a number or not.
isWritable()  : mixed
showSettings()  : mixed
Set the cms system settings
smtp()  : mixed
updatePhpCache()  : mixed
Write all settings to the config file
debuggingFlagArrayFromFlags()  : array<string|int, mixed>
Analyzes an int as passed to DBG::activate() and yields an array containing information about the flags.
debuggingFlagsFromFlagArray()  : int
Calculates a flag value as passed to DBG::activate() from an array.
generateThumbnail()  : mixed
Regenerate the thumbnails
initConfigList()  : mixed
Load base configuration options into member variable $this->configlist
initSections()  : void
Initialize backend sections
isGroupProcessingSatisfied()  : bool
Checks if the dependencies of a group setting are satisfied.
setDebuggingVariables()  : mixed
Sets debugging related template variables according to session state.
showExternalGroup()  : bool
Checks if $definition['external'] contains data and if so it does inject an exteranl settings section using {@see \Cx\Core\Setting\Controller\Setting::show_external} into the template instance $template.
showPdf()  : mixed
Show PDF
showWysiwyg()  : mixed
stringIfTrue()  : mixed
returns $str if $check is true, else ''
updateDebugSettings()  : mixed
updateThumbnailGenerationProgress()  : mixed
checkWritePermissions()  : mixed
setNavigation()  : mixed

Properties

$configlist

List of base configurations Used for automatic (re-)initialization

protected static array<string|int, mixed> $configlist = array()

Associative array

Tags
TODO:

Cleanup this list (move to components)

$sections

List of backend configuration sections

protected array<string|int, mixed> $sections = []

This list is populated by Config::initSections(). Each section is registered using its URL modifier act as the key.

Methods

_smtpDefaultAccount()

public _smtpDefaultAccount() : mixed

_smtpDeleteAccount()

public _smtpDeleteAccount() : mixed

checkAccessibility()

Checks whether the currently configured domain url is accessible

public static checkAccessibility([string $protocol = 'http' ][, mixed $domain = '' ]) : bool
Parameters
$protocol : string = 'http'

the protocol to check for access

$domain : mixed = ''
Return values
bool —

true if the domain is accessable

editThumbnails()

public editThumbnails(mixed $post) : mixed
Parameters
$post : mixed

fetchConfigFromSettingsFile()

Load a settings.php file and return its configuration ($_CONFIG) as array

public static fetchConfigFromSettingsFile(string $file) : array<string|int, mixed>
Parameters
$file : string

The path to the settings.php file to load the $_CONFIG from

Return values
array<string|int, mixed> —

Returns an array containing the loaded $_CONFIG from $file. If $file does not exists or on error, it returns an empty array

generateThumbnails()

Regenerate the thumbnails

public static generateThumbnails([mixed $cli = false ][, mixed $mediaSource = null ][, mixed $force = false ]) : mixed
Parameters
$cli : mixed = false
$mediaSource : mixed = null
$force : mixed = false

getBackendLanguages()

Shows all backend languages

public static getBackendLanguages() : string
Tags
access

public

Return values
string

getCaptchaOptions()

Returns captcha options

public static getCaptchaOptions() : string
Return values
string —

captcha options as string

getClientSideScriptUploadOptions()

Returns client side script upload options

public static getClientSideScriptUploadOptions() : string
Return values
string —

client side script upload options

getDomains()

Shows the all domains page

public static getDomains() : string
Tags
access

private

Return values
string

getLocales()

Shows all locales

public static getLocales() : string
Tags
access

public

Return values
string

getPage()

Perform the requested function depending on $_REQUEST['act']

public getPage() : void
Tags
global

array Core language

global

\Cx\Core\Html\Sigma

getPortOptions()

Returns port options

public static getPortOptions() : string
Return values
string —

port options as string

getReverseProxyTypes()

Gets the list of reverse proxy types

public static getReverseProxyTypes() : string
Return values
string —

Comma separated list of reverse proxy types

getSettingsFile()

get the settings file path

public static getSettingsFile() : string
Return values
string

getSsiOutputModes()

Gets the list of ESI/SSI output modes

public static getSsiOutputModes() : string
Return values
string —

Comma separated list of ESI/SSI output modes

getSsiTypes()

Gets the list of supported system types for external ESI/SSI processing

public static getSsiTypes() : string

This is important in order to drop invalid cache objects!

Return values
string —

Comma separated list of supported system types for external ESI/SSI processing

getTimezoneOptions()

Returns all available timezones

public static getTimezoneOptions() : string
Tags
access

private

Return values
string —

$timezoneOptions available timezones as HTML

getUserGroups()

Returns user groups

public static getUserGroups() : string
Return values
string —

user groups as string

image()

Shows the image settings page

public image(mixed $arrData) : bool
Parameters
$arrData : mixed
Tags
access

public

throws
Exception
Return values
bool —

true on success, false otherwise

init()

Initializes basic config of Cloudrexx

public static init([string $configPath = null ][, bool $forceMigration = false ][, bool $reset = false ]) : mixed

$forceMigration forces the migration of configurations in settings.php to the configuration repository.

Parameters
$configPath : string = null

(optional) Absolute directory path to the location where the configuration files are stored. Defaults to Cx::getWebsiteConfigPath().

$forceMigration : bool = false

(optional) Default false

$reset : bool = false

(optional) Set to TRUE to reset the repository to its default state.

Tags
throws
ConfigException

If a config cannot be initialized

isANumber()

Check whether the given string is a number or not.

public static isANumber(string $value) : bool

Integers with leading zero results in 0, this method prevents that.

Parameters
$value : string

The value to check

Return values
bool —

true if the string is a number, false if not

showSettings()

Set the cms system settings

public showSettings() : mixed
Tags
global

ADONewConnection

global

array Core language

global

\Cx\Core\Html\Sigma

updatePhpCache()

Write all settings to the config file

public static updatePhpCache() : mixed

debuggingFlagArrayFromFlags()

Analyzes an int as passed to DBG::activate() and yields an array containing information about the flags.

protected debuggingFlagArrayFromFlags(int $flags) : array<string|int, mixed>
Parameters
$flags : int
Return values
array<string|int, mixed> —

flags array('php' => bool, 'db' => bool, 'db_error' => bool)

debuggingFlagsFromFlagArray()

Calculates a flag value as passed to DBG::activate() from an array.

protected debuggingFlagsFromFlagArray(mixed $flags) : int
Parameters
$flags : mixed
Return values
int —

an int with the flags set.

generateThumbnail()

Regenerate the thumbnails

protected generateThumbnail(array<string|int, mixed> $post) : mixed
Parameters
$post : array<string|int, mixed>

$_POST values

initConfigList()

Load base configuration options into member variable $this->configlist

protected static initConfigList() : mixed

initSections()

Initialize backend sections

protected initSections() : void
Tags
todo

Instead of including the sections of other components directly here, we should implement an event that other components can listen to and use to register their configuration sections.

isGroupProcessingSatisfied()

Checks if the dependencies of a group setting are satisfied.

protected isGroupProcessingSatisfied(array<string|int, mixed> $definition) : bool

The check is done by verifiing that each listed component in array $definition['dependencies'] is a licensed component.

Parameters
$definition : array<string|int, mixed>
Return values
bool

setDebuggingVariables()

Sets debugging related template variables according to session state.

protected setDebuggingVariables(mixed $template) : mixed
Parameters
$template : mixed

showExternalGroup()

Checks if $definition['external'] contains data and if so it does inject an exteranl settings section using {@see \Cx\Core\Setting\Controller\Setting::show_external} into the template instance $template.

protected showExternalGroup(Sigma $template, array<string|int, mixed> $definition) : bool
Parameters
$template : Sigma
$definition : array<string|int, mixed>
Return values
bool —

TRUE if external settings section has been injected.

stringIfTrue()

returns $str if $check is true, else ''

protected stringIfTrue(mixed $check, mixed $str) : mixed
Parameters
$check : mixed
$str : mixed

updateDebugSettings()

protected updateDebugSettings(mixed $settings) : mixed
Parameters
$settings : mixed

updateThumbnailGenerationProgress()

protected static updateThumbnailGenerationProgress(mixed $path, mixed $data) : mixed
Parameters
$path : mixed
$data : mixed

checkWritePermissions()

private checkWritePermissions() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results