HIPO_Config Class Reference

Inheritance diagram for HIPO_Config:

Public Member Functions
	__construct ()
	_loadJobConfigVars ()
	save ($vars, $backup_existing=FALSE)
	canAcquireLock ()
	writeAccess ()
	paintBackend (&$o)
	paintJobsBackends (&$o, $class)
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

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

Detailed Description

Definition at line 31 of file hipo_config.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 49 of file hipo_config.inc.

Member Function Documentation

_loadJobConfigVars

(

)

Attempts to load the extra config vars that the jobs have into our config_vars array Doesn't do anything if the config_file doesn't exist

Returns

void private

Definition at line 65 of file hipo_config.inc.

canAcquireLock

(

)

Whether the current user can acquire the lock

Returns

boolean public

See Also

MySource::acquireLock()

Definition at line 151 of file hipo_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

Backend_Outputter, reference to the backend outputter

Returns

void public

See Also

processBackend()

Definition at line 190 of file hipo_config.inc.

paintJobsBackends	(	&	$o,
			$class
	)

One crazy function which calls paintBackend function of each job

Parameters

object	&$o	Backend_Outputter, reference to the backend outputter
string	$class	The name of the job class

Returns

void private

Definition at line 249 of file hipo_config.inc.

save	(		$vars,
			$backup_existing = FALSE
	)

Rewrites the conf file with current variables. It returns the boolean value indicating whether the file was written

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

Returns

boolean public

Definition at line 122 of file hipo_config.inc.

writeAccess

(

)

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

Returns

boolean public

Definition at line 165 of file hipo_config.inc.

Field Documentation

$config_vars

Initial value:

= Array(
                        'SQ_HIPO_USE_SERVER'                    => Array('editable' => 1, 'default' => FALSE),
                        'SQ_HIPO_SERVER_STATUS_CHECK_THRESHOLD' => Array('editable' => 1, 'default' => 30),
                        'SQ_HIPO_TOTAL_THRESHOLD'               => Array('editable' => 1, 'default' => 80),
                       )

Definition at line 38 of file hipo_config.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/hipo/hipo_config.inc