Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Trigger_Action_Purge_Squid_Cache Class Reference
Inheritance diagram for Trigger_Action_Purge_Squid_Cache:
Trigger_Action Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 

Static Public Member Functions

static execute ($settings, &$state)
 
static getInterface ($settings, $prefix, $write_access=FALSE)
 
static processInterface (&$settings, $request_data)
 
- Static Public Member Functions inherited from Trigger_Action
static execute ($settings, $state)
 
static getInterface ($settings, $prefix, $write_access=FALSE)
 
static processInterface (&$settings, $request_data)
 
static getLocks ($settings, &$state)
 

Additional Inherited Members

- Data Fields inherited from Asset
 $id = 0
 
 $version = ''
 
 $name = ''
 
 $short_name = ''
 
 $status
 
 $languages = ''
 
 $charset = ''
 
 $force_secure = '0'
 
 $created
 
 $created_userid
 
 $updated
 
 $updated_userid
 
 $published
 
 $published_userid
 
 $status_changed
 
 $status_changed_userid
 
 $_is_cacheable = FALSE
 
 $vars = Array()
 
 $_available_keywords = Array()
 
 $data_path_suffix = ''
 
 $data_path = ''
 
 $data_path_public = ''
 
 $_ser_attrs = FALSE
 
- Protected Member Functions inherited from Asset
 _preCreateCheck (Array &$link)
 
 _createAdditional (Array &$link)
 
 _abortCreate ($trigger_level_changed=FALSE, $linkid=0)
 
 _loadVars ()
 
 _getName ($short_name=FALSE, $contextid=NULL)
 
 _getKeywordReplacement ($keyword)
 
 _checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)
 
 makeAndSaveInitialWebPath ($path, $parent_link=NULL)
 

Detailed Description

Definition at line 32 of file trigger_action_purge_squid_cache.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Added for consistency. However, this is only ever called statically, so the constructor will never actually be called.

Parameters
string$assetidThe ID of this asset

Definition at line 45 of file trigger_action_purge_squid_cache.inc.

Member Function Documentation

static execute (   $settings,
$state 
)
static

Execute this action Returns an array of data about what it did, or FALSE on error

Parameters
array$settingsthe stored settings for this action
array&$statethe state that describes the asset the action is executing on
Returns
mixed array|boolean public

Definition at line 62 of file trigger_action_purge_squid_cache.inc.

static getInterface (   $settings,
  $prefix,
  $write_access = FALSE 
)
static

Get the HTML editing interface for this action. Returns the string instead of printing it

Parameters
array$settingssettings that this condition saves in processInterface()
string$prefixunique prefix
boolean$write_accessdetermines whether the interface is editable
Returns
boolean public

Definition at line 91 of file trigger_action_purge_squid_cache.inc.

static processInterface ( $settings,
  $request_data 
)
static

Function that handles the conversion of interface to settings together with settings it is expected to populate the hash object

Parameters
array&$settingsa container for any data the action might want to save
string$request_dataarray of data corresponding to this action as specified by the $prefix in getInterface.
Returns
boolean public

Definition at line 125 of file trigger_action_purge_squid_cache.inc.


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