Documentation

CRM_Case_Audit_AuditConfig
in package

Class CRM_Case_Audit_AuditConfig

Table of Contents

Properties

$completionLabel  : mixed
$completionValue  : mixed
$filename  : mixed
$ifBlanks  : mixed
$includeRules  : mixed
$regionFieldList  : mixed
$sortByLabels  : mixed
$sortRegion  : mixed

Methods

__construct()  : mixed
compareFields()  : int
This is intended to be called as a sort callback function, returning whether a field in a region comes before or after another one.
getCompletionLabel()  : string
getCompletionValue()  : string
getIfBlanks()  : array<string|int, mixed>
getRegions()  : array<string|int, mixed>
Return a list of all the regions in the config file.
getSortByLabels()  : array<string|int, mixed>
includeInRegion()  : bool
Should field $n be included in region $r, taking into account exclusion rules.
includeTime()  : bool
Should the time component of field $n in region $r be displayed?
inRegion()  : bool
Check if label $n is explicitly listed in region $r in the config.
loadConfig()  : mixed
sort()  : mixed
Sort a group of fields for a given region according to the order in the config.

Properties

Methods

__construct()

public __construct(string $filename) : mixed
Parameters
$filename : string

compareFields()

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

public compareFields(mixed $a, mixed $b) : int

See also PHP's usort().

Parameters
$a : mixed
$b : mixed
Return values
int

getCompletionLabel()

public getCompletionLabel() : string
Return values
string

getCompletionValue()

public getCompletionValue() : string
Return values
string

getIfBlanks()

public getIfBlanks() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRegions()

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

public getRegions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSortByLabels()

public getSortByLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>

includeInRegion()

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

public includeInRegion(mixed $n, mixed $r) : bool
Parameters
$n : mixed
$r : mixed
Return values
bool

includeTime()

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

public includeTime(mixed $n, mixed $r) : bool
Parameters
$n : mixed
$r : mixed
Return values
bool

inRegion()

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

public inRegion(mixed $n, mixed $r) : bool
Parameters
$n : mixed
$r : mixed
Return values
bool

sort()

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

public sort(mixed &$f, mixed $r) : mixed

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 : mixed
$r : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results