Bitrix API

Source1C extends Base

Table of Contents

Methods

__construct()  : mixed
activateEntity()  : Result
connect()  : Result
Connects to external source
getData()  : array<string|int, mixed>
getDescription()  : array<string|int, mixed>
getEntityList()  : array<string|int, mixed>
getFirstNData()  : array<string|int, mixed>
initDatasetFields()  : void

Methods

__construct()

public __construct(int|null $sourceId) : mixed
Parameters
$sourceId : int|null

activateEntity()

public activateEntity(string $tableCode) : Result
Parameters
$tableCode : string

Table code with # - like Catalog#BankAccounts.

Return values
Result

connect()

Connects to external source

public connect(string $host, string $username, string $password) : Result
Parameters
$host : string
$username : string
$password : string
Return values
Result

getData()

public getData(string $tableName, array<string|int, mixed> $query) : array<string|int, mixed>
Parameters
$tableName : string

Table name with _ - like Catalog_BankAccounts.

$query : array<string|int, mixed>

Array of query params - select, filter, limit.

Return values
array<string|int, mixed>

Elements are arrays like [fieldName => fieldValue].

getDescription()

public getDescription(string $entityName) : array<string|int, mixed>
Parameters
$entityName : string

Table name with _ - like Catalog_BankAccounts.

Return values
array<string|int, mixed>

getEntityList()

public getEntityList([string|null $searchString = null ]) : array<string|int, mixed>
Parameters
$searchString : string|null = null

Search query.

Return values
array<string|int, mixed>

Array with tables.

ID - table code like "Catalog#BankAccounts"
TITLE - readable name of table like "(Dictionary) Bank Accounts"
DESCRIPTION - table name like "Catalog_BankAccounts"

getFirstNData()

public getFirstNData(string $entityName, int $n) : array<string|int, mixed>
Parameters
$entityName : string

Table name with _ - like Catalog_BankAccounts.

$n : int

Amount of rows.

Return values
array<string|int, mixed>

initDatasetFields()

public initDatasetFields(string $datasetName) : void
Parameters
$datasetName : string

        
On this page

Search results