Exponent v2.4.3
Back to top  

expSettings

define

"BASE" "../../.."
package

Subsystems

Methods

exdoc Activates a Configuration Profile.

activateProfile(string $profile)
static
node

Subsystems:Config

Arguments

$profile

string

The name of the Profile to activate.

Update/Add a single configuration setting to the current/active site configuration

change( $var,  $val)
static

Arguments

$var

$val

exdoc This function looks through all of the available configuration extensions, and generates a form object consisting of each extension's form part. This can then be used to edit the full site configuration. Returns a form object intended for editing the profile.

configurationForm(string $configname, boolean $database = false) : \form
static
node

Subsystems:Config

Arguments

$configname

string

The name of the configuration profile, for filling in default values.

$database

boolean

Response

\form

exdoc Creates a configuration profile from the current configuration

createProfile(string $profile) : string
static
node

Subsystems:Config

Arguments

$profile

string

The name of the Profile to remove.

Response

string

exdoc Deletes a configuration profile from the framework/conf/profiles directory.

deleteProfile(string $profile)
static
node

Subsystems:Config

Arguments

$profile

string

The name of the Profile to remove.

exdoc Parse Drop Down options from a file.

dropdownData(string $dropdown_name) : array
static
node

Subsystems:Config

Arguments

$dropdown_name

string

The name of the dropdown type. The name of the file will be retrieved by adding .dropdown as a suffix, and searching the framework/conf/data directory.

Response

array

initialize

initialize()
static

exdoc Takes care of setting the appropriate template variables to be used when viewing a profile or set of profiles.

outputConfigurationTemplate(\template $template, string $configname) : \template
static

Returns the initializes template.

node

Subsystems:Config

Arguments

$template

\template

The template object to assign to.

$configname

string

The name of the configuration profile.

Response

\template

exdoc Uses magical regular expressions voodoo to pull the actual define() calls out of a configuration PHP file, and return them in an associative array, for use in viewing and analyzing configs. Returns an associative array of constant names => values

parse(string $configname = '', null $site_root = null) : array
static
node

Subsystems:Config

Arguments

$configname

string

Configuration Profile name

$site_root

null

Response

array

exdoc Looks through the source of a given configuration PHP file, and pulls out (by mysterious regular expressions) the define() calls and returns those values. Returns an associative array of constant names => values

parseFile(string $file) : array
static
node

Subsystems:Config

Arguments

$file

string

The full path to the file to parse.

Response

array

exdoc Looks through the framework/conf/profiles directory, and finds all of the configuration profiles in existence. This function also performs some minor name-mangling, to make the Profile Names more user friendly. Returns an array of Profile names.

profiles() : array
static
node

Subsystems:Config

Response

array

exdoc Processes the POSTed data from the configuration form object generated by self::configurationForm, and writes a bunch of define() statements to the profiles config file.

saveConfiguration(array $values, null $site_root = null)
static
node

Subsystems:Config

Arguments

$values

array

The _POST array to pull configuration data from.

$site_root

null

Saves values to config file

saveValues( $values, string $configname = '')
static

Arguments

$values

$configname

string

writeFile

writeFile( $str,  $configname = '')
static

Arguments

$str

$configname