class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor

Constants

REL_TYPE_CNAME

Relationship-types have four name fields (name_a_b, name_b_a, label_a_b, label_b_a), but CiviCase XML refers to reltypes by a single name.

REL_TYPE_CNAME identifies the canonical name field as used by CiviCase XML.

This appears to be "label_b_a", but IMHO "name_b_a" would be more sensible.

Properties

static array|null $activityTypes FIXME: This does NOT belong in a static property, but we're too late in the 4.5-cycle to do the necessary cleanup. from CRM_Case_XMLProcessor
static array|null $relationshipTypes FIXME: This does NOT belong in a static property, but we're too late in the 4.5-cycle to do the necessary cleanup. from CRM_Case_XMLProcessor

Methods

retrieve($caseType)

No description

static string
mungeCaseType(string $caseType) deprecated

This function was previously used to convert a case-type's machine-name to a file-name. However, it's mind-boggling that the file-name might be a munged version of the machine-name (which is itself a munged version of the display-name), and naming is now a more visible issue (since the overhaul of CaseType admin UI).

array
allActivityTypes(bool $indexName = TRUE, bool $all = FALSE)

No description

array
allRelationshipTypes()

No description

static 
flushStaticCaches()

FIXME: This should not exist

array
run(string $filename = 'settings')

Run.

Details

in CRM_Case_XMLProcessor at line 66
FALSE|SimpleXMLElement retrieve($caseType)

Parameters

$caseType

Return Value

FALSE|SimpleXMLElement

in CRM_Case_XMLProcessor at line 89
static string mungeCaseType(string $caseType) deprecated

deprecated

This function was previously used to convert a case-type's machine-name to a file-name. However, it's mind-boggling that the file-name might be a munged version of the machine-name (which is itself a munged version of the display-name), and naming is now a more visible issue (since the overhaul of CaseType admin UI).

Usage note: This is called externally by civix stubs as a sort of side-ways validation of the case-type's name (validation which was needed because of the unintuitive double-munge). We should update civix templates and then remove this function in Civi 4.6 or 5.0.

Parameters

string $caseType

Return Value

string

See also

CRM_Case_BAO_CaseType::isValidName

in CRM_Case_XMLProcessor at line 102
array allActivityTypes(bool $indexName = TRUE, bool $all = FALSE)

Parameters

bool $indexName
bool $all

Return Value

array

in CRM_Case_XMLProcessor at line 112
array allRelationshipTypes()

Return Value

array

in CRM_Case_XMLProcessor at line 128
static flushStaticCaches()

FIXME: This should not exist

at line 46
array run(string $filename = 'settings')

Run.

Parameters

string $filename The base filename without the .xml extension

Return Value

array An array of settings.