Trigger_Action_Logout_Ipb Class Reference

Inheritance diagram for Trigger_Action_Logout_Ipb:

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	getLocks ($settings, &$state)
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 33 of file trigger_action_logout_ipb.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

This constructor is included for consistency, but will never actually be called, as trigger actions are always called statically.

Parameters

string

$assetid

The asset ID to load

Definition at line 46 of file trigger_action_logout_ipb.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

The settings used by this action are in the form:

Array(
    'ipbsdk_path'      => string  // path to the file to use
      );

Parameters

array	$settings	the stored settings for this action
array	&$state	the state that describes the asset the action is executing on

Returns

mixed array|boolean public

Definition at line 70 of file trigger_action_logout_ipb.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	$settings	settings that this condition saves in processInterface()
string	$prefix	unique prefix
boolean	$write_access	determines whether the interface is editable

Returns

boolean public

Definition at line 117 of file trigger_action_logout_ipb.inc.

static getLocks (   $settings, &  $state  )

static

Get the list of locks that the action needs to acquire before executing

Parameters

array	$settings	a container for any data the action might want to save
array	&$state	the state that describes the asset the action is executing on

Returns

array public

Definition at line 181 of file trigger_action_logout_ipb.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	&$settings	a container for any data the action might want to save
string	$request_data	array of data corresponding to this action as specified by the $prefix in getInterface.

Returns

boolean public

Definition at line 157 of file trigger_action_logout_ipb.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/ipb/triggers/trigger_action_types/trigger_action_logout_ipb/trigger_action_logout_ipb.inc