Bitrix API

Helper

Class Helper

Table of Contents

Properties

$runtimeByEntity  : mixed

Methods

buildPersonalizeList()  : mixed
createExpressionMultiField()  : ExpressionField
Create Orm expression field for selecting multi field.
getData()  : mixed
getFilterByEntity()  : array<string|int, mixed>
Get filter by entity.
getFilterByFields()  : array<string|int, mixed>
Get filter by fields.
getFilterUserFields()  : array<string|int, mixed>
Get filter user fields.
getPersonalizeFieldsFromConnectors()  : mixed
getPersonalizeList()  : array<string|int, mixed>
Get personalize field list.
getRuntimeByEntity()  : array<string|int, ExpressionField>
Get runtime by entity.
isCrmSaleEnabled()  : mixed
onResultViewDraw()  : void
Callback on draw of result view.
preparePersonalizeList()  : array<string|int, mixed>
prepareQuery()  : Query
Prepare query select.

Properties

$runtimeByEntity

public static mixed $runtimeByEntity = []

Methods

buildPersonalizeList()

public static buildPersonalizeList(mixed $entityType) : mixed
Parameters
$entityType : mixed

createExpressionMultiField()

Create Orm expression field for selecting multi field.

public static createExpressionMultiField(string $entityName, string $multiFieldTypeId) : ExpressionField
Parameters
$entityName : string

Entity name.

$multiFieldTypeId : string

Multi-field type ID.

Return values
ExpressionField

getData()

public static getData(mixed $entityType, mixed $entityIds[, mixed $fields = ['*'] ]) : mixed
Parameters
$entityType : mixed
$entityIds : mixed
$fields : mixed = ['*']

getFilterByEntity()

Get filter by entity.

public static getFilterByEntity([array<string|int, mixed> $fields = array() ][, array<string|int, mixed> $values = array() ][, array<string|int, mixed> $entityTypeNames = array() ]) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed> = array()

Fields.

$values : array<string|int, mixed> = array()

Values.

$entityTypeNames : array<string|int, mixed> = array()

Entity type names.

Return values
array<string|int, mixed>

getFilterByFields()

Get filter by fields.

public static getFilterByFields([array<string|int, mixed> $fields = array() ][, array<string|int, mixed> $values = array() ][, string $entityTypeName = '' ]) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed> = array()

Fields.

$values : array<string|int, mixed> = array()

Values.

$entityTypeName : string = ''

Entity type name.

Return values
array<string|int, mixed>

getFilterUserFields()

Get filter user fields.

public static getFilterUserFields(int $entityTypeId[, bool $checkAccessRights = true ]) : array<string|int, mixed>
Parameters
$entityTypeId : int

Entity type ID.

$checkAccessRights : bool = true
Return values
array<string|int, mixed>

getPersonalizeFieldsFromConnectors()

public static getPersonalizeFieldsFromConnectors([mixed $isTrigger = false ]) : mixed
Parameters
$isTrigger : mixed = false

getPersonalizeList()

Get personalize field list.

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

getRuntimeByEntity()

Get runtime by entity.

public static getRuntimeByEntity([string $entityTypeName = '' ]) : array<string|int, ExpressionField>
Parameters
$entityTypeName : string = ''

Entity type name.

Return values
array<string|int, ExpressionField>

isCrmSaleEnabled()

public static isCrmSaleEnabled() : mixed

onResultViewDraw()

Callback on draw of result view.

public onResultViewDraw(array<string|int, mixed> &$row) : void
Parameters
$row : array<string|int, mixed>

Row.

preparePersonalizeList()

public static preparePersonalizeList(string $entityType, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$entityType : string
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>

prepareQuery()

Prepare query select.

public static prepareQuery(Query $query[, int $dataTypeId = null ][, mixed $entityDbName = null ][, mixed $entityName = null ]) : Query
Parameters
$query : Query

Query.

$dataTypeId : int = null

Data type ID.

$entityDbName : mixed = null
$entityName : mixed = null
Return values
Query

        
On this page

Search results