SequenceListener
in package
implements
CaseChangeListener
The sequence-listener looks for CiviCase XML tags with "<sequence>". If a change is made to any record in case-type which uses "<sequence>", then it attempts to add the next step in the sequence.
Table of Contents
Interfaces
- CaseChangeListener
- Interface CaseChangeListener
Properties
Methods
- createActivity() : mixed
- getSequenceXml() : SimpleXMLElement|null
- Find the ActivitySet which defines the pipeline.
- onCaseChange() : void
- Triggers next case activity in sequence if current activity status is updated to type=COMPLETED(See CRM-21598). The adjoining activity is created according to the sequence configured in case type.
- onCaseChange_static() : mixed
- singleton() : SequenceListener
Properties
$singleton
private
static SequenceListener
$singleton
Methods
createActivity()
public
createActivity(Analyzer $analyzer, SimpleXMLElement $actXML) : mixed
Parameters
- $analyzer : Analyzer
-
The case being analyzed -- to which we want to add an activity.
- $actXML : SimpleXMLElement
-
the <ActivityType> tag which describes the new activity
getSequenceXml()
Find the ActivitySet which defines the pipeline.
public
getSequenceXml(SimpleXMLElement $xml) : SimpleXMLElement|null
Parameters
- $xml : SimpleXMLElement
Return values
SimpleXMLElement|nullonCaseChange()
Triggers next case activity in sequence if current activity status is updated to type=COMPLETED(See CRM-21598). The adjoining activity is created according to the sequence configured in case type.
public
onCaseChange(CaseChangeEvent $event) : void
Parameters
- $event : CaseChangeEvent
Tags
onCaseChange_static()
public
static onCaseChange_static(CaseChangeEvent $event) : mixed
Parameters
- $event : CaseChangeEvent
singleton()
public
static singleton([bool $reset = FALSE ]) : SequenceListener
Parameters
- $reset : bool = FALSE
-
Whether to forcibly rebuild the entire container.