Documentation

CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor
in package

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Properties

$_redactionRegexRules  : array<string|int, mixed>
$_isRedact  : bool
The default variable defined.
$_redactionStringRules  : array<string|int, mixed>
Redaction Rules.

Methods

__construct()  : mixed
allRelationshipTypes()  : array<string|int, mixed>
Get all relationship type display labels (not machine names)
caseInfo()  : array<string|int, mixed>
flushStaticCaches()  : mixed
FIXME: This should not exist
getActivities()  : mixed
getActivity()  : array<string|int, mixed>
getActivityInfo()  : mixed
getActivitySetLabel()  : null|string
getActivityTypeCustomSQL()  : mixed
getActivityTypes()  : array<string|int, mixed>|bool
getCaseReport()  : mixed
getCreatedBy()  : null|string
getCustomData()  : array<string|int, mixed>|null
getRedactionRules()  : mixed
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).
populateCaseReportTemplate()  : CRM_Core_Smarty
printCaseReport()  : mixed
retrieve()  : false|SimpleXMLElement
redact()  : mixed

Properties

$_redactionRegexRules

public array<string|int, mixed> $_redactionRegexRules

$_isRedact

The default variable defined.

protected bool $_isRedact

$_redactionStringRules

Redaction Rules.

protected array<string|int, mixed> $_redactionStringRules = []

Methods

__construct()

public __construct() : mixed

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>

caseInfo()

public & caseInfo(int $clientID, int $caseID) : array<string|int, mixed>
Parameters
$clientID : int
$caseID : int
Return values
array<string|int, mixed>

flushStaticCaches()

FIXME: This should not exist

public static flushStaticCaches() : mixed

getActivities()

public getActivities(int $clientID, int $caseID, mixed $activityTypes, mixed &$activities) : mixed
Parameters
$clientID : int
$caseID : int
$activityTypes : mixed
$activities : mixed

getActivity()

public & getActivity(int $clientID, mixed $activityDAO, mixed &$activityTypeInfo) : array<string|int, mixed>
Parameters
$clientID : int
$activityDAO : mixed
$activityTypeInfo : mixed
Return values
array<string|int, mixed>

getActivityInfo()

public & getActivityInfo(int $clientID, int $activityID[, bool $anyActivity = FALSE ][, int $redact = 0 ]) : mixed
Parameters
$clientID : int
$activityID : int
$anyActivity : bool = FALSE
$redact : int = 0

getActivitySetLabel()

public getActivitySetLabel(mixed $xml, string $activitySetName) : null|string
Parameters
$xml : mixed
$activitySetName : string
Return values
null|string

getActivityTypeCustomSQL()

public getActivityTypeCustomSQL(int $activityTypeID[, string|null $dateFormat = NULL ][, bool $onlyActive = TRUE ]) : mixed
Parameters
$activityTypeID : int
$dateFormat : string|null = NULL
$onlyActive : bool = TRUE

getActivityTypes()

public getActivityTypes(mixed $xml, string $activitySetName) : array<string|int, mixed>|bool
Parameters
$xml : mixed
$activitySetName : string
Return values
array<string|int, mixed>|bool

getCaseReport()

public static getCaseReport(int $clientID, int $caseID, string $activitySetName, array<string|int, mixed> $params, CRM_Core_Form $form) : mixed
Parameters
$clientID : int
$caseID : int
$activitySetName : string
$params : array<string|int, mixed>
$form : CRM_Core_Form

getCreatedBy()

public getCreatedBy(int $activityID) : null|string
Parameters
$activityID : int
Return values
null|string

getCustomData()

public getCustomData(int $clientID, mixed $activityDAO, mixed &$activityTypeInfo) : array<string|int, mixed>|null
Parameters
$clientID : int
$activityDAO : mixed
$activityTypeInfo : mixed
Return values
array<string|int, mixed>|null

getRedactionRules()

public getRedactionRules() : 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
see
CRM_Case_BAO_CaseType::isValidName
Return values
string

printCaseReport()

public static printCaseReport() : mixed

retrieve()

public retrieve(mixed $caseType) : false|SimpleXMLElement
Parameters
$caseType : mixed
Return values
false|SimpleXMLElement

redact()

private redact(mixed $string[, bool $printReport = FALSE ][, array<string|int, mixed> $replaceString = [] ]) : mixed
Parameters
$string : mixed
$printReport : bool = FALSE
$replaceString : array<string|int, mixed> = [] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results