System_Config Class Reference

Inheritance diagram for System_Config:

Public Member Functions
	__construct ()
	save ($vars, $backup_existing=FALSE, $send_message=TRUE)
	canAcquireLock ()
	writeAccess ()
	paintBackend (&$o)
	processBackend (&$o)
	configureRoleTables ($enable_roles_system=TRUE, $enable_global_roles=TRUE)
Public Member Functions inherited from Config
	__construct ()
	save ($vars, $backup_existing=FALSE, $send_message=TRUE)
	acquireLock ()
	canAcquireLock ()
	releaseLock ()
	updateLock ()
	getLockInfo ()
	writeAccess ()
	paintBackend (&$o)
	processBackend (&$o)
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Data Fields
	$config_vars
Data Fields inherited from Config
	$config_vars = Array()
	$config_file = ''
	$name = ''
Data Fields inherited from MySource_Object
	$_tmp

Protected Member Functions
	_paintConfigVar ($var_name, $value, $var_export=TRUE)
Protected Member Functions inherited from Config
	_paintConfigVar ($var_name, $value, $var_export=TRUE)

Detailed Description

Definition at line 30 of file system_config.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Returns

object public

Definition at line 139 of file system_config.inc.

Member Function Documentation

_paintConfigVar (   $var_name,   $value,   $var_export = TRUE  )

protected

Paints out the code for the config file for the passed config This allows extra things to be added for special cases

Parameters

string	$var_name	the config var name
mixed	$value	the value that the config var has
boolean	$var_export	whether to run the value through var_export or not

Returns

boolean

Definition at line 231 of file system_config.inc.

canAcquireLock

(

)

Whether the current user can acquire the lock

Returns

boolean public

See Also

MySource::acquireLock()

Definition at line 326 of file system_config.inc.

configureRoleTables	(		$enable_roles_system = TRUE,
			$enable_global_roles = TRUE
	)

Configures the Permissions and Roles database views to reflect the specified roles state

Parameters

boolean	$enable_roles_system	whether to enable or disable the Roles system completely
boolean	$enable_global_roles	whether to enable or disable Global Roles

Returns

boolean public

Definition at line 1162 of file system_config.inc.

paintBackend

(

&

$o

)

Paints the interface for our config options.

If you (as a sub-class) put your config vars so that when they are submitted appear in $_POST[get_class($this)] then you probably won't need to override processBackend()

Parameters

object

&$o

reference to the backend outputter

Returns

void public

See Also

processBackend()

Definition at line 366 of file system_config.inc.

processBackend

(

&

$o

)

Saves the config settings that were submitted

Parameters

object

&$o

reference to the backend outputter

Returns

boolean public

See Also

paintBackend()

Definition at line 1105 of file system_config.inc.

save	(		$vars,
			$backup_existing = FALSE,
			$send_message = TRUE
	)

Rewrites the conf file with current variables

Parameters

array	$vars	the array with any new values (that are allowed to be edited) Array('[config_var_name]' => [scalar value])
boolean	$backup_existing	whether we should backup the existing config file first
boolean	$send_message	whether to send a message using the messaging system

Returns

boolean public

Definition at line 158 of file system_config.inc.

writeAccess

(

)

Does the current user have writeAccess() to this config ?

Returns

boolean public

Definition at line 340 of file system_config.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/include/system_config.inc