Bitrix API

QueryHelper

Table of Contents

Methods

prepareFolderTreeQuery()  : string
Gets SQL query code for folder tree structure.
prepareGroupBy()  : string
Gets group by fields as SQL code.
prepareInsert()  : string
Gets fields to insert as SQL code.
prepareOrder()  : string
Gets sort order fields as SQL code.
prepareSelect()  : string
Gets select fields as SQL code.
prepareUpdateOnSelect()  : array<string|int, mixed>
Gets fields for UPDATE query based on SELECT as SQL code.
prepareWhere()  : string
Get filter parameters as SQL code.

Methods

prepareFolderTreeQuery()

Gets SQL query code for folder tree structure.

public static prepareFolderTreeQuery(int $parentId) : string
Parameters
$parentId : int

Top parent folder.

Return values
string

prepareGroupBy()

Gets group by fields as SQL code.

public static prepareGroupBy(array<string|int, mixed> $groupByFields) : string
Parameters
$groupByFields : array<string|int, mixed>

Group by fields.

Return values
string

prepareInsert()

Gets fields to insert as SQL code.

public static prepareInsert(array<string|int, string> $columns[, array<string|int, mixed> $selectFields = [] ]) : string
Parameters
$columns : array<string|int, string>

Insert fields.

$selectFields : array<string|int, mixed> = []

Selected fields.

Return values
string

prepareOrder()

Gets sort order fields as SQL code.

public static prepareOrder(array<string|int, string> $orderFields[, array<string|int, string> $fieldAlias = [] ]) : string
Parameters
$orderFields : array<string|int, string>

Order fields set.

$fieldAlias : array<string|int, string> = []

Aliases for the order fields.

Return values
string

prepareSelect()

Gets select fields as SQL code.

public static prepareSelect(array<string|int, mixed> $selectFields) : string
Parameters
$selectFields : array<string|int, mixed>

Selected fields.

Return values
string

prepareUpdateOnSelect()

Gets fields for UPDATE query based on SELECT as SQL code.

public static prepareUpdateOnSelect(array<string|int, string> $columns, array<string|int, mixed> $selectFields[, string $tableAlias = 'dest' ][, string $selectAlias = 'src' ]) : array<string|int, mixed>
Parameters
$columns : array<string|int, string>

Update fields.

$selectFields : array<string|int, mixed>

Selected fields.

$tableAlias : string = 'dest'

Destination table alias.

$selectAlias : string = 'src'

Source query alias.

Return values
array<string|int, mixed>

prepareWhere()

Get filter parameters as SQL code.

public static prepareWhere(array<string|int, mixed> $filterFields[, array<string|int, mixed> $filterAlias = [] ]) : string
Parameters
$filterFields : array<string|int, mixed>

Gets filter parameters.

$filterAlias : array<string|int, mixed> = []

Aliases for the filter fields.

Return values
string

        
On this page

Search results