CRM_Case_XMLProcessor_Settings

class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor

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

Methods

FALSE|SimpleXMLElement
retrieve($caseType)

No description

from CRM_Case_XMLProcessor
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).

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

No description

from CRM_Case_XMLProcessor
array
allRelationshipTypes(bool $fromXML = FALSE)

Get all relationship type display labels (not machine names)

from CRM_Case_XMLProcessor
static 
flushStaticCaches()

FIXME: This should not exist

from CRM_Case_XMLProcessor
array
run(string $filename = 'settings')

Run.

Details

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

Parameters

$caseType

Return Value

FALSE|SimpleXMLElement

in CRM_Case_XMLProcessor at line 73
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 86
array allActivityTypes(bool $indexName = TRUE, bool $all = FALSE)

Parameters

bool $indexName
bool $all

Return Value

array

in CRM_Case_XMLProcessor at line 105
array allRelationshipTypes(bool $fromXML = FALSE)

Get all relationship type display labels (not machine names)

Parameters

bool $fromXML TODO: This parameter is always FALSE now so no longer needed. Is this to be used for lookup of values from XML? Relationships are recorded in XML from the perspective of the non-client while relationships in the UI and everywhere else are from the perspective of the client. Since the XML can't be expected to be switched, the direction needs to be translated.

Return Value

array

in CRM_Case_XMLProcessor at line 137
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.