Apache_Config Class Reference

Inheritance diagram for Apache_Config:

Public Member Functions
	__construct ()
	save ($vars, $backup_existing=FALSE, $send_message=TRUE)
	canAcquireLock ()
	writeAccess ()
	paintBackend (&$o)
	processBackend (&$o)
	_paintConfigVar ($var_name, $value, $var_export=TRUE)
	_getNewRequestNote ($data)
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
	$request_notes = Array()
Data Fields inherited from Config
	$config_vars = Array()
	$config_file = ''
	$name = ''
Data Fields inherited from MySource_Object
	$_tmp

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

Detailed Description

Definition at line 32 of file apache_config.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 61 of file apache_config.inc.

Member Function Documentation

_getNewRequestNote

(

$data

)

Given an array, attempt to build information for a new request note

Parameters

array

$data

Array to pull request note data from, probably post

Returns

mixed boolean|array private

Definition at line 456 of file apache_config.inc.

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

Paints the code to define a constant

This allows extra things to be added for special cases, and extra checks to be made if necessary on the value

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 private

Definition at line 435 of file apache_config.inc.

canAcquireLock

(

)

Whether the current user can acquire the lock

Returns

boolean public

See Also

MySource::acquireLock()

Definition at line 193 of file apache_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 232 of file apache_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 400 of file apache_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 88 of file apache_config.inc.

writeAccess

(

)

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

Returns

boolean public

Definition at line 207 of file apache_config.inc.

Field Documentation

$config_vars

Initial value:

= Array(
                        'request_notes' => Array('editable' => 1, 'default' => Array()),
                       )

Definition at line 43 of file apache_config.inc.

---

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

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