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

Analyzer

class Analyzer

Class Analyzer

Methods

__construct($caseId)

No description

bool
hasActivity(string $type, string $status = NULL)

Determine if case includes an activity of given type/status

array
getActivities()

Get a list of all activities in the case.

array|NULL,
getSingleActivity(string $type)

Get a single activity record by type.

int
getCaseId()

No description

array,
getCase()

No description

string
getCaseType()

No description

array
getActivityIndex(array $keys)

Get a list of all activities in the case (indexed by some property/properties)

SimpleXMLElement|NULL
getXml()

No description

flush()

Flush any cached information.

Details

at line 68
__construct($caseId)

Parameters

$caseId

at line 82
bool hasActivity(string $type, string $status = NULL)

Determine if case includes an activity of given type/status

Parameters

string $type Eg "Phone Call", "Interview Prospect", "Background Check".
string $status Eg "Scheduled", "Completed".

Return Value

bool

at line 114
array getActivities()

Get a list of all activities in the case.

Return Value

array list of activity records (api/v3 format)

at line 141
array|NULL, getSingleActivity(string $type)

Get a single activity record by type.

This function is only used by SequenceListenerTest

Parameters

string $type

Return Value

array|NULL, activity record (api/v3)

Exceptions

MultipleActivityException

at line 163
int getCaseId()

Return Value

int

at line 170
array, getCase()

Return Value

array, Case record (api/v3 format)

at line 181
string getCaseType()

Return Value

string

Exceptions

CRM_Core_Exception

at line 201
array getActivityIndex(array $keys)

Get a list of all activities in the case (indexed by some property/properties)

Parameters

array $keys List of properties by which to index activities.

Return Value

array list of activity records (api/v3 format), indexed by $keys

at line 212
SimpleXMLElement|NULL getXml()

Return Value

SimpleXMLElement|NULL

at line 222
flush()

Flush any cached information.