CRM_Case_Audit_AuditConfig

class CRM_Case_Audit_AuditConfig

Class CRM_Case_Audit_AuditConfig

Methods

__construct(string $filename)

No description

string
getCompletionValue()

No description

string
getCompletionLabel()

No description

array
getSortByLabels()

No description

array
getIfBlanks()

No description

loadConfig()

No description

bool
inRegion($n, $r)

Check if label $n is explicitly listed in region $r in the config.

bool
includeInRegion($n, $r)

Should field $n be included in region $r, taking into account exclusion rules.

bool
includeTime($n, $r)

Should the time component of field $n in region $r be displayed?

array
getRegions()

Return a list of all the regions in the config file.

sort($f, $r)

Sort a group of fields for a given region according to the order in the config.

int
compareFields($a, $b)

This is intended to be called as a sort callback function, returning whether a field in a region comes before or after another one.

Details

at line 19
__construct(string $filename)

Parameters

string $filename

at line 34
string getCompletionValue()

Return Value

string

at line 41
string getCompletionLabel()

Return Value

string

at line 48
array getSortByLabels()

Return Value

array

at line 55
array getIfBlanks()

Return Value

array

at line 59
loadConfig()

at line 144
bool inRegion($n, $r)

Check if label $n is explicitly listed in region $r in the config.

Parameters

$n
$r

Return Value

bool

at line 161
bool includeInRegion($n, $r)

Should field $n be included in region $r, taking into account exclusion rules.

Parameters

$n
$r

Return Value

bool

at line 183
bool includeTime($n, $r)

Should the time component of field $n in region $r be displayed?

Parameters

$n
$r

Return Value

bool

at line 211
array getRegions()

Return a list of all the regions in the config file.

Return Value

array

at line 222
sort($f, $r)

Sort a group of fields for a given region according to the order in the config.

The array to be sorted should have elements that have a member with a key of 'label', and the value should be the field label.

Parameters

$f
$r

at line 241
int compareFields($a, $b)

This is intended to be called as a sort callback function, returning whether a field in a region comes before or after another one.

See also PHP's usort().

Parameters

$a
$b

Return Value

int