Bitrix API

Tools

Class Tools Provides various useful methods for data.

Table of Contents

Methods

checkExistKeys()  : bool
Check existing keys in array.
clearNullFields()  : bool
Callback for array_filter - clear null fields.
getMissingKeys()  : array<string|int, mixed>
Return missing key list.
prepareKeys()  : array<string|int, mixed>|bool
Return keys status in fields.

Methods

checkExistKeys()

Check existing keys in array.

public static checkExistKeys(array<string|int, mixed> $fields, array<string|int, mixed> $keyList[, bool $checkNull = false ]) : bool
Parameters
$fields : array<string|int, mixed>

Source array.

$keyList : array<string|int, mixed>

Key list for search.

$checkNull : bool = false

Checked null values.

Return values
bool

clearNullFields()

Callback for array_filter - clear null fields.

public static clearNullFields(mixed $value) : bool
Parameters
$value : mixed

Clear value.

Return values
bool

getMissingKeys()

Return missing key list.

public static getMissingKeys(array<string|int, mixed> $fields, array<string|int, mixed> $keyList[, bool $checkNull = false ]) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>

Source array.

$keyList : array<string|int, mixed>

Key list for search.

$checkNull : bool = false

Checked null values.

Return values
array<string|int, mixed>

prepareKeys()

Return keys status in fields.

public static prepareKeys(array<string|int, mixed> $fields, array<string|int, mixed> $keyList[, bool $checkNull = false ]) : array<string|int, mixed>|bool
Parameters
$fields : array<string|int, mixed>

Source array.

$keyList : array<string|int, mixed>

Key list for search.

$checkNull : bool = false

Checked null values.

Return values
array<string|int, mixed>|bool

        
On this page

Search results