Elgg\Config Class Reference

Public Member Functions
	__construct ()
	Constructor. More...
	getSiteUrl ($site_guid=0)
	Get the URL for the current (or specified) site. More...
	getPluginsPath ()
	Get the plugin path for this installation. More...
	getDataPath ()
	Get the data directory path for this installation. More...
	getRootPath ()
	Get the root directory path for this installation. More...
	get ($name, $site_guid=0)
	Get an Elgg configuration value. More...
	set ($name, $value)
	Set an Elgg configuration value. More...
	save ($name, $value, $site_guid=0)
	Save a configuration setting. More...

Detailed Description

Definition at line 14 of file Config.php.

Constructor & Destructor Documentation

__construct()

Elgg\Config::__construct

(

)

Constructor.

Definition at line 25 of file Config.php.

Member Function Documentation

get()

Elgg\Config::get	(		$name,
			$site_guid = 0
	)

Get an Elgg configuration value.

Parameters

string	$name	Name of the configuration value
int	$site_guid	null for installation setting, 0 for default site

Returns

mixed Configuration value or null if it does not exist

Definition at line 90 of file Config.php.

getDataPath()

Elgg\Config::getDataPath

(

)

Get the data directory path for this installation.

Returns

string

Definition at line 67 of file Config.php.

getPluginsPath()

Elgg\Config::getPluginsPath

(

)

Get the plugin path for this installation.

Returns

string

Definition at line 57 of file Config.php.

getRootPath()

Elgg\Config::getRootPath

(

)

Get the root directory path for this installation.

Returns

string

Definition at line 77 of file Config.php.

getSiteUrl()

Elgg\Config::getSiteUrl

(

$site_guid = 0

)

Get the URL for the current (or specified) site.

Parameters

int

$site_guid

The GUID of the site whose URL we want to grab

Returns

string

Definition at line 36 of file Config.php.

save()

Elgg\Config::save	(		$name,
			$value,
			$site_guid = 0
	)

Save a configuration setting.

Parameters

string	$name	Configuration name (cannot be greater than 255 characters)
mixed	$value	Configuration value. Should be string for installation setting
int	$site_guid	null for installation setting, 0 for default site

Returns

bool

Definition at line 156 of file Config.php.

set()

Elgg\Config::set	(		$name,
			$value
	)

Set an Elgg configuration value.

Warning

This does not persist the configuration setting. Use elgg_save_config()

Parameters

string	$name	Name of the configuration value
mixed	$value	Value

Returns

void

Definition at line 139 of file Config.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Config.php