Documentation

UserRecordsList extends Base
in package

User Records Filtered List class.

Table of Contents

$allowedModules  : array<string|int, mixed>
$default  : string
$name  : string
$params  : mixed
$textParser  : TextParser
$type  : mixed
__construct()  : mixed
Construct.
isActive()  : bool
Check if function is activated.
process()  : string
Process.
addAdvConditions()  : mixed
Add advance conditions.
parseConditions()  : mixed
Parse conditions.

Properties

$allowedModules

public array<string|int, mixed> $allowedModules

Allowed modules

$default

public string $default = '$(custom : UserRecordsList|__MODULE_NAME__|__FIELDS_TO_SHOW__|__CONDITIONS__|__ORDER_BY__|__LIMIT__|__VIEW_ID__|__ADVANCE_CONDITIONS__)$'

Default template Example: $(custom : UserRecordsList|SSalesProcesses|subject:related_to|[[["description","y",""]]]|[["createdtime","ASC"]]|50)$

$name

public string $name = 'LBL_USER_RECORD_FILTERED_LIST'

Class name

$params

public mixed $params

Additional params

Methods

__construct()

Construct.

public __construct(TextParser $textParser[, mixed $params = '' ]) : mixed
Parameters
$textParser : TextParser
$params : mixed = ''
Return values
mixed —

isActive()

Check if function is activated.

public isActive() : bool
Return values
bool —

process()

Process.

public process() : string
Return values
string —

addAdvConditions()

Add advance conditions.

private addAdvConditions(QueryGenerator $queryGenerator, int $relationId, string $operator, array<string|int, mixed>|null $condition, int|null $userId) : mixed
Parameters
$queryGenerator : QueryGenerator
$relationId : int
$operator : string
$condition : array<string|int, mixed>|null
$userId : int|null
Return values
mixed —

parseConditions()

Parse conditions.

private parseConditions(QueryGenerator $queryGenerator, array<string|int, mixed> $searchParams, int|null $userId) : mixed
Parameters
$queryGenerator : QueryGenerator
$searchParams : array<string|int, mixed>
$userId : int|null
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results