CRM_Case_XMLRepository

class CRM_Case_XMLRepository

Properties

protected array $xml
protected array|null $hookCache
protected array|null $allCaseTypes Symbolic names of case-types.

Methods

static CRM_Case_XMLRepository
singleton(bool $fresh = FALSE)

No description

flush()

No description

__construct(array $allCaseTypes = NULL, array $xml = [])

Class constructor.

FALSE|SimpleXMLElement
retrieve(string $caseType)

Retrieve case.

SimpleXMLElement|FALSE
retrieveFile(string $caseType)

Retrieve file.

null|string
findXmlFile(string $caseType)

Find xml file.

array
getCaseTypesViaHook()

No description

array
getAllCaseTypes()

No description

array
getAllDeclaredActivityTypes()

No description

array
getAllDeclaredRelationshipTypes()

Relationships are straight from XML, described from perspective of non-client

int
getActivityReferenceCount(string $activityType)

Determine the number of times a particular activity-type is referenced in CiviCase XML.

int
getRelationshipReferenceCount(string $relationshipTypeName)

Determine the number of times a particular activity-type is referenced in CiviCase XML.

Details

at line 61
static CRM_Case_XMLRepository singleton(bool $fresh = FALSE)

Parameters

bool $fresh

Return Value

CRM_Case_XMLRepository

at line 68
flush()

at line 81
__construct(array $allCaseTypes = NULL, array $xml = [])

Class constructor.

Parameters

array $allCaseTypes
array $xml

at line 94
FALSE|SimpleXMLElement retrieve(string $caseType)

Retrieve case.

Parameters

string $caseType

Return Value

FALSE|SimpleXMLElement

Exceptions

CRM_Core_Exception

at line 130
SimpleXMLElement|FALSE retrieveFile(string $caseType)

Retrieve file.

Parameters

string $caseType

Return Value

SimpleXMLElement|FALSE

at line 165
null|string findXmlFile(string $caseType)

Find xml file.

Parameters

string $caseType

Return Value

null|string file path

at line 225
array getCaseTypesViaHook()

Return Value

array

See also

CRM_Utils_Hook::caseTypes

at line 236
array getAllCaseTypes()

Return Value

array symbolic names of case-types

at line 246
array getAllDeclaredActivityTypes()

Return Value

array symbolic-names of activity-types

at line 265
array getAllDeclaredRelationshipTypes()

Relationships are straight from XML, described from perspective of non-client

Return Value

array symbolic-names of relationship-types

at line 287
int getActivityReferenceCount(string $activityType)

Determine the number of times a particular activity-type is referenced in CiviCase XML.

Parameters

string $activityType Symbolic-name of an activity type.

Return Value

int

at line 307
int getRelationshipReferenceCount(string $relationshipTypeName)

Determine the number of times a particular activity-type is referenced in CiviCase XML.

Parameters

string $relationshipTypeName Symbolic-name of a relationship-type.

Return Value

int