The Red Matrix: mod/p.php File Reference

+ +

Arbitrary configuration storage. +More...

+ + + + + - - + + + + + + - - + + + + + +

Functions
	load_config ($family)
	Loads the hub's configuration from database to a cached storage. More...

	get_config ($family, $key)
	Get a particular config variable given the category name ($family) and a key. More...

	get_config_from_storage ($family, $key)
	Returns a value directly from the database configuration storage. More...

	set_config ($family, $key, $value)
	Sets a configuration value for the hub. More...

	del_config ($family, $key)
	Deletes the given key from the hub's configuration database. More...

	load_pconfig ($uid, $family= '')

	load_pconfig ($uid)
	Loads all configuration values of a channel into a cached storage. More...

	get_pconfig ($uid, $family, $key, $instore=false)
	Get a particular channel's config variable given the category name ($family) and a key. More...

	set_pconfig ($uid, $family, $key, $value)
	Sets a configuration value for a channel. More...

	del_pconfig ($uid, $family, $key)
	Deletes the given key from the channel's configuration. More...

	load_xconfig ($xchan, $family= '')

	load_xconfig ($xchan)
	Loads a full xchan's configuration into a cached storage. More...

	get_xconfig ($xchan, $family, $key)
	Get a particular observer's config variable given the category name ($family) and a key. More...

	set_xconfig ($xchan, $family, $key, $value)
	Sets a configuration value for an observer. More...

	del_xconfig ($xchan, $family, $key)
	Deletes the given key from the observer's config. More...

Function Documentation

Detailed Description

Arbitrary configuration storage.

Note: Please do not store booleans - convert to 0/1 integer values The get_?config() functions return boolean false for keys that are unset, and this could lead to subtle bugs.

Arrays get stored as serialize strings.

Todo:: There are a few places in the code (such as the admin panel) where boolean configurations need to be fixed as of 10/08/2011.

config is used for hub specific configurations. It overrides the configurations from .htconfig file. The storage is of size TEXT.
pconfig is used for channel specific configurations and takes a channel_id as identifier. It stores for example which features are enabled per channel. The storage is of size MEDIUMTEXT.
$var = get_pconfig(local_user(), 'category', 'key');
+
xconfig is the same as pconfig, except that it uses xchan as an identifier. This is for example for people who do not have a local account. The storage is of size MEDIUMTEXT.
$observer = $a->get_observer_hash();
+
if ($observer) {
+
$var = get_xconfig($observer, 'category', 'key');
+
}
+

get_config() and set_config() can also be done through the command line tool util/config
get_pconfig() and set_pconfig() can also be done through the command line tool util/pconfig and takes a channel_id as first argument.

Function Documentation

@@ -164,6 +199,17 @@ Functions

Deletes the given key from the hub's configuration database.

Removes the configured value from the stored cache in $a->config[$family] and removes it from the database.

Parameters

+ + + +

string	$family	The category of the configuration value
string	$key	The configuration key to delete

Returns: mixed

Referenced by admin_page_site_post(), and FKOAuthDataStore\new_access_token().

@@ -198,6 +244,18 @@ Functions

Deletes the given key from the channel's configuration.

Removes the configured value from the stored cache in $a->config[$uid] and removes it from the database.

Parameters

+ + + + +

string	$uid	The channel_id
string	$family	The category of the configuration value
string	$key	The configuration key to delete

Returns: mixed

Referenced by pdledit_post().

@@ -232,6 +290,18 @@ Functions

Arbitrary configuration storage Note: Please do not store booleans - convert to 0/1 integer values The get_?config() functions return boolean false for keys that are unset, and this could lead to subtle bugs.

There are a few places in the code (such as the admin panel) where boolean configurations need to be fixed as of 10/08/2011.

+ +

Loads the hub's configuration from database to a cached storage.

Retrieve a category ($family) of config variables from database to a cached storage in the global $a->config[$family].

Parameters

+ + +

string $family The category of the configuration value

Referenced by api_statusnet_config(), check_config(), cli_startup(), and get_config().

Sets a configuration value for the hub.

Stores a config value ($value) in the category ($family) under the key ($key).

Please do not store booleans - convert to 0/1 integer values!

Parameters

+ + + + +

string	$family	The category of the configuration value
string	$key	The configuration key to set
mixed	$value	The value to store in the configuration

Returns: mixed Return the set value, or false if the database update failed

Referenced by admin_page_dbsync(), admin_page_logs_post(), admin_page_plugins(), admin_page_site_post(), admin_page_themes(), api_content(), check_config(), check_upstream_directory(), create_account(), create_sys_channel(), find_upstream_directory(), poller_run(), theme_admin_post(), and what_next().

This functions parses the HTTP_ACCEPT_LANGUAGE header sent by the browser and extracts the preferred languages and their priority.

Get the language setting directly from system variables, bypassing get_config() as database may not yet be configured.

Get a list of RedDirectory objects with all the channels where the visitor has view_storage perms.

Member RedChannelList (&$auth)
File config.php: There are a few places in the code (such as the admin panel) where boolean configurations need to be fixed as of 10/08/2011.
Member RedChannelList (&$auth): Is there any reason why this is not inside RedDirectory class?
Member RedCollectionData ($file, &$auth)
Member RedCollectionData ($file, &$auth): Is there any reason why this is not inside RedDirectory class? Seems only to be used there and we could simplify it a bit there.
Member RedDirectory::$ext_path
Member RedDirectory::$ext_path: I think this is not used anywhere, we always strip '/cloud' and only use it in debug
Member RedDirectory::getDir ()
Member RedDirectory::getDir (): add description of what this function does.
Member RedDirectory::setName ($name)
Member RedDirectory::setName ($name): handle duplicate directory name

load_pconfig	(	$uid,
		$family = `''`
$uid	)	)

load_xconfig	(		$xchan,
	$xchan	)		$family = `''`
	)

- p -

- p -

Functions

Function Documentation

Detailed Description

Function Documentation

+Functions

Function Documentation

string	$xchan	The observer's hash
string	$family	The category of the configuration value
string	$key	The configuration key to delete

+Functions
	p_init (&$a)