CRM_Case_XMLProcessor_Settings
extends CRM_Case_XMLProcessor
in package
Tags
Table of Contents
Properties
- $_settings : mixed
Methods
- allRelationshipTypes() : array<string|int, mixed>
- Get all relationship type display labels (not machine names)
- flushStaticCaches() : mixed
- FIXME: This should not exist
- mungeCaseType() : string
- 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).
- retrieve() : false|SimpleXMLElement
- run() : array<string|int, mixed>
- Run.
Properties
$_settings
private
mixed
$_settings
= []
Methods
allRelationshipTypes()
Get all relationship type display labels (not machine names)
public
& allRelationshipTypes([bool $fromXML = FALSE ]) : array<string|int, mixed>
Parameters
- $fromXML : bool = FALSE
-
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 values
array<string|int, mixed>flushStaticCaches()
FIXME: This should not exist
public
static flushStaticCaches() : mixed
mungeCaseType()
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).
public
static mungeCaseType(string $caseType) : string
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
- $caseType : string
Tags
Return values
stringretrieve()
public
retrieve(mixed $caseType) : false|SimpleXMLElement
Parameters
- $caseType : mixed
Return values
false|SimpleXMLElementrun()
Run.
public
run([string $filename = 'settings' ]) : array<string|int, mixed>
Parameters
- $filename : string = 'settings'
-
The base filename without the .xml extension
Return values
array<string|int, mixed> —An array of settings.