CRM_Case_XMLProcessor_Report

class CRM_Case_XMLProcessor_Report 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
protected bool $_isRedact The default variable defined.

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
__construct()

No description

mixed
run(int $clientID, int $caseID, string $activitySetName, array $params)

No description

getRedactionRules()

No description

array
caseInfo(int $clientID, int $caseID)

No description

array|bool
getActivityTypes($xml, string $activitySetName)

No description

null|string
getActivitySetLabel($xml, string $activitySetName)

No description

getActivities(int $clientID, int $caseID, $activityTypes, $activities)

No description

mixed
getActivityInfo(int $clientID, int $activityID, bool $anyActivity = FALSE, int $redact = 0)

No description

array
getActivity(int $clientID, $activityDAO, $activityTypeInfo)

No description

array|null
getCustomData(int $clientID, $activityDAO, $activityTypeInfo)

No description

mixed
getActivityTypeCustomSQL(int $activityTypeID, null $dateFormat = NULL, bool $onlyActive = TRUE)

No description

null|string
getCreatedBy(int $activityID)

No description

static mixed
getCaseReport(int $clientID, int $caseID, string $activitySetName, array $params, CRM_Core_Form $form)

No description

static 
printCaseReport()

No description

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 44
__construct()

at line 55
mixed run(int $clientID, int $caseID, string $activitySetName, array $params)

Parameters

int $clientID
int $caseID
string $activitySetName
array $params

Return Value

mixed

at line 66
getRedactionRules()

at line 97
array caseInfo(int $clientID, int $caseID)

Parameters

int $clientID
int $caseID

Return Value

array

at line 145
array|bool getActivityTypes($xml, string $activitySetName)

Parameters

$xml
string $activitySetName

Return Value

array|bool

at line 173
null|string getActivitySetLabel($xml, string $activitySetName)

Parameters

$xml
string $activitySetName

Return Value

null|string

at line 190
getActivities(int $clientID, int $caseID, $activityTypes, $activities)

Parameters

int $clientID
int $caseID
$activityTypes
$activities

at line 236
mixed getActivityInfo(int $clientID, int $activityID, bool $anyActivity = FALSE, int $redact = 0)

Parameters

int $clientID
int $activityID
bool $anyActivity
int $redact

Return Value

mixed

at line 302
array getActivity(int $clientID, $activityDAO, $activityTypeInfo)

Parameters

int $clientID
$activityDAO
$activityTypeInfo

Return Value

array

at line 532
array|null getCustomData(int $clientID, $activityDAO, $activityTypeInfo)

Parameters

int $clientID
$activityDAO
$activityTypeInfo

Return Value

array|null

at line 588
mixed getActivityTypeCustomSQL(int $activityTypeID, null $dateFormat = NULL, bool $onlyActive = TRUE)

Parameters

int $activityTypeID
null $dateFormat
bool $onlyActive

Return Value

mixed

at line 697
null|string getCreatedBy(int $activityID)

Parameters

int $activityID

Return Value

null|string

at line 739
static mixed getCaseReport(int $clientID, int $caseID, string $activitySetName, array $params, CRM_Core_Form $form)

Parameters

int $clientID
int $caseID
string $activitySetName
array $params
CRM_Core_Form $form

Return Value

mixed

at line 802
static printCaseReport()