CRM_Case_XMLProcessor_Report

class CRM_Case_XMLProcessor_Report 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
protected boolean $_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()

No description

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)

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)

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 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 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 156
array|bool getActivityTypes($xml, string $activitySetName)

Parameters

$xml
string $activitySetName

Return Value

array|bool

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

Parameters

$xml
string $activitySetName

Return Value

null|string

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

Parameters

int $clientID
int $caseID
$activityTypes
$activities

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

Parameters

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

Return Value

mixed

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

Parameters

int $clientID
$activityDAO
$activityTypeInfo

Return Value

array

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

Parameters

int $clientID
$activityDAO
$activityTypeInfo

Return Value

array|null

at line 604
mixed getActivityTypeCustomSQL(int $activityTypeID, null $dateFormat = NULL)

Parameters

int $activityTypeID
null $dateFormat

Return Value

mixed

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

Parameters

int $activityID

Return Value

null|string

at line 752
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 815
static printCaseReport()