Dataface/ConfigTool/setConfigParam.function.php File Reference

Go to the source code of this file.

Functions
	Dataface_ConfigTool_setConfigParam ($file, $section, $key, $value, $username=null, $lang=null, $priority=5)

---

Function Documentation

Dataface_ConfigTool_setConfigParam	(	$	file,
		$	section,
		$	key,
		$	value,
		$	username = null,
		$	lang = null,
		$	priority = 5
	)

Sets a configuration parameter in the configuration table. This should not be called directly. It should be called through the Dataface_ConfigTool class as its setConfigParam method.

Parameters:

string	$file	The name of the ini file in which the config value is being set.
string	$section	The name of the section (could be null).
string	$key	The name of the parameter's key (not null)
string	$value	The value to set (not null)
string	$username	The username for which the parameter is being set (null for all users)
string	$lang	The 2-digit language code for which the parameter is being set (null for all languages).
integer	$priority	The priority of this config variable (priority dictates which parameters take priority. Default vallue of 5.

Returns:

true if success or PEAR_Error if failure.

This will create the configuration table if it doesn't already exist.

Author:

Steve Hannah <shannah@sfu.ca> Feb. 26, 2007

Definition at line 22 of file setConfigParam.function.php.