Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
External_Tools_Config Class Reference
Inheritance diagram for External_Tools_Config:
Config MySource_Object

Public Member Functions

 __construct ()
 
 save ($vars, $backup_existing=FALSE, $send_message=TRUE)
 
 canAcquireLock ()
 
 writeAccess ()
 
 paintBackend (&$o)
 
- 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 32 of file external_tools_config.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 86 of file external_tools_config.inc.

Member Function Documentation

canAcquireLock ( )

Whether the current user can acquire the lock

Returns
boolean public
See Also
MySource::acquireLock()

Definition at line 132 of file external_tools_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&$oreference to the backend outputter
Returns
void public
See Also
processBackend()

Definition at line 172 of file external_tools_config.inc.

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

Rewrites the conf file with current variables

return value indicates whether the file was written

Parameters
array$varsthe array with any new values (that are allowed to be edited) Array('[config_var_name]' => [scalar value])
boolean$backup_existingwhether we should backup the existing config file first
boolean$send_messagewhether to send a message using the messaging system
Returns
boolean public

Definition at line 107 of file external_tools_config.inc.

writeAccess ( )

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

Returns
boolean public

Definition at line 146 of file external_tools_config.inc.


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