Contentserv PHP API

CSRuleApiAction
in package

Tags

Table of Contents

CANCEL_FOLLOWING_ACTIONS  = 'CancelFollowingActions'
Defines the identifier name to cancel following actions.
TYPE_FAILURE  = 0
Defines the different types of an action.
TYPE_SUCCESS  = 1
TYPE_WARNING  = 2
__construct()  : mixed
The CSRuleApiAction constructor.
execute()  : bool|mixed
Executes the configured action accordingly to the selected action plugin.
getId()  : mixed
getLabel()  : mixed
getMessagesForUI()  : mixed
getModifyFlag()  : mixed
getName()  : mixed
getPlugin()  : CSRuleActionPlugin
Returns the stored plugin of the current action.
getPluginName()  : mixed
getRule()  : mixed
getRuleId()  : mixed
getSortOrder()  : mixed
getType()  : mixed
getValue()  : mixed
getValues()  : mixed
removeValue()  : mixed
removeValues()  : mixed
setLabel()  : mixed
setModifyFlag()  : mixed
setName()  : mixed
setPluginName()  : mixed
setSortOrder()  : mixed
setType()  : mixed
setValue()  : mixed
setValues()  : mixed
shouldBeExecutedForEachLanguage()  : bool
Defines if the action should be executed for each configured language in the rule configuration.
shouldCancelFollowingActions()  : bool
This method is called to check, whether the following actions should be canceled.

Constants

CANCEL_FOLLOWING_ACTIONS

Defines the identifier name to cancel following actions.

public string CANCEL_FOLLOWING_ACTIONS = 'CancelFollowingActions'
Tags

TYPE_FAILURE

Defines the different types of an action.

public int TYPE_FAILURE = 0
Tags

Methods

__construct()

The CSRuleApiAction constructor.

public __construct([int $iActionId = null ][, CSRuleApiRule|int $mRule = null ]) : mixed
Parameters
$iActionId : int = null
$mRule : CSRuleApiRule|int = null
Tags
Return values
mixed —

execute()

Executes the configured action accordingly to the selected action plugin.

public execute(CSRuleContext $oContext[, mixed $mValueFromPreviousAction = null ][, int $iLanguageId = null ]) : bool|mixed
Parameters
$oContext : CSRuleContext
$mValueFromPreviousAction : mixed = null
$iLanguageId : int = null
Tags
Return values
bool|mixed —

getMessagesForUI()

public getMessagesForUI() : mixed
Tags
Return values
mixed —

getModifyFlag()

public getModifyFlag() : mixed
Tags
Return values
mixed —

getPluginName()

public getPluginName() : mixed
Tags
Return values
mixed —

getRuleId()

public getRuleId() : mixed
Tags
Return values
mixed —

getSortOrder()

public getSortOrder() : mixed
Tags
Return values
mixed —

getValue()

public getValue(mixed $mKey) : mixed
Parameters
$mKey : mixed
Tags
Return values
mixed —

getValues()

public getValues() : mixed
Tags
Return values
mixed —

removeValue()

public removeValue(mixed $mKey) : mixed
Parameters
$mKey : mixed
Tags
Return values
mixed —

removeValues()

public removeValues() : mixed
Tags
Return values
mixed —

setLabel()

public setLabel(mixed $sLabel) : mixed
Parameters
$sLabel : mixed
Tags
Return values
mixed —

setModifyFlag()

public setModifyFlag(mixed $iModifyFlag) : mixed
Parameters
$iModifyFlag : mixed
Tags
Return values
mixed —

setName()

public setName(mixed $sName) : mixed
Parameters
$sName : mixed
Tags
Return values
mixed —

setPluginName()

public setPluginName(mixed $sPluginName) : mixed
Parameters
$sPluginName : mixed
Tags
Return values
mixed —

setSortOrder()

public setSortOrder(mixed $iSortOrder) : mixed
Parameters
$iSortOrder : mixed
Tags
Return values
mixed —

setType()

public setType(mixed $iType) : mixed
Parameters
$iType : mixed
Tags
Return values
mixed —

setValue()

public setValue(mixed $mKey, mixed $mValue) : mixed
Parameters
$mKey : mixed
$mValue : mixed
Tags
Return values
mixed —

setValues()

public setValues(mixed $aValues) : mixed
Parameters
$aValues : mixed
Tags
Return values
mixed —

shouldBeExecutedForEachLanguage()

Defines if the action should be executed for each configured language in the rule configuration.

public shouldBeExecutedForEachLanguage() : bool
Tags
Return values
bool —

if the action should be executed for each configured language in the rule configuration.

shouldCancelFollowingActions()

This method is called to check, whether the following actions should be canceled.

public shouldCancelFollowingActions() : bool
Tags
Return values
bool —

whether the following actions should be canceled.


        

        
    




    

    

                

    

        

            
Search results