Documentation

Analyzer
in package

Class Analyzer

Table of Contents

Properties

$activities  : array<string|int, mixed>
List of activities, formatted per APIv3.
$case  : array<string|int, mixed>
The "Case" data, formatted per APIv3.
$caseId  : int
$caseType  : string
$indices  : array<string|int, mixed>
A list of activity indices, which sort the various activities by some set of keys.
$xml  : SimpleXMLElement

Methods

__construct()  : mixed
flush()  : mixed
Flush any cached information.
getActivities()  : array<string|int, mixed>
Get a list of all activities in the case.
getActivityIndex()  : array<string|int, mixed>
Get a list of all activities in the case (indexed by some property/properties)
getCase()  : mixed
getCaseId()  : int
getCaseType()  : string
getSingleActivity()  : mixed
Get a single activity record by type.
getXml()  : SimpleXMLElement|null
hasActivity()  : bool
Determine if case includes an activity of given type/status

Properties

$activities

List of activities, formatted per APIv3.

private array<string|int, mixed> $activities

$case

The "Case" data, formatted per APIv3.

private array<string|int, mixed> $case

$indices

A list of activity indices, which sort the various activities by some set of keys.

private array<string|int, mixed> $indices

Each index is identified by its key-set - e.g. "activity_type_id;source_contact_id" would be a two-dimensional index listing activities by their type ID and their source.

Methods

__construct()

public __construct(mixed $caseId) : mixed
Parameters
$caseId : mixed

flush()

Flush any cached information.

public flush() : mixed

getActivities()

Get a list of all activities in the case.

public getActivities() : array<string|int, mixed>
Return values
array<string|int, mixed> —

list of activity records (api/v3 format)

getActivityIndex()

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

public getActivityIndex(array<string|int, mixed> $keys) : array<string|int, mixed>
Parameters
$keys : array<string|int, mixed>

List of properties by which to index activities.

Return values
array<string|int, mixed> —

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

getCase()

public getCase() : mixed
Tags
@return

array, Case record (api/v3 format)

getCaseId()

public getCaseId() : int
Return values
int

getSingleActivity()

Get a single activity record by type.

public getSingleActivity(string $type) : mixed

This function is only used by SequenceListenerTest

Parameters
$type : string
Tags
throws
MultipleActivityException
@return

array|NULL, activity record (api/v3)

getXml()

public getXml() : SimpleXMLElement|null
Return values
SimpleXMLElement|null

hasActivity()

Determine if case includes an activity of given type/status

public hasActivity(string $type[, string $status = NULL ]) : bool
Parameters
$type : string

Eg "Phone Call", "Interview Prospect", "Background Check".

$status : string = NULL

Eg "Scheduled", "Completed".

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results