1. class
  2. Civi
  3. \
  4. CCase
  5. \
  6. SequenceListener

SequenceListener

class SequenceListener implements CaseChangeListener

The sequence-listener looks for CiviCase XML tags with "". If a change is made to any record in case-type which uses "", then it attempts to add the next step in the sequence.

Methods

static SequenceListener
singleton(bool $reset = FALSE)

No description

static 
onCaseChange_static(CaseChangeEvent $event)

No description

mixed
onCaseChange(CaseChangeEvent $event)

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.

SimpleXMLElement|NULL
getSequenceXml(SimpleXMLElement $xml)

Find the ActivitySet which defines the pipeline.

createActivity(Analyzer $analyzer, SimpleXMLElement $actXML)

No description

Details

at line 21
static SequenceListener singleton(bool $reset = FALSE)

Parameters

bool $reset Whether to forcibly rebuild the entire container.

Return Value

SequenceListener

at line 31
static onCaseChange_static(CaseChangeEvent $event)

Parameters

CaseChangeEvent $event

at line 45
mixed onCaseChange(CaseChangeEvent $event)

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.

Parameters

CaseChangeEvent $event

Return Value

mixed

Exceptions

CiviCRM_API3_Exception

at line 94
SimpleXMLElement|NULL getSequenceXml(SimpleXMLElement $xml)

Find the ActivitySet which defines the pipeline.

Parameters

SimpleXMLElement $xml

Return Value

SimpleXMLElement|NULL

at line 116
createActivity(Analyzer $analyzer, SimpleXMLElement $actXML)

Parameters

Analyzer $analyzer The case being analyzed -- to which we want to add an activity.
SimpleXMLElement $actXML the tag which describes the new activity