Bitrix API

DataSet extends Dictionary

Table of Contents

Methods

__construct()  : mixed
DataSet constructor.
__unserialize()  : void
clear()  : mixed
createByArray()  : mixed
createByIterator()  : mixed
filterByCallback()  : mixed
filterByFields()  : mixed
get()  : string|array<string|int, mixed>|null
Returns any variable by its name. Null if variable is not set.
getById()  : mixed
getFirst()  : mixed
getValues()  : array<string|int, mixed>
isEmpty()  : bool
Returns true if the dictionary is empty.
isExists()  : mixed
jsonSerialize()  : array<string|int, mixed>
JsonSerializable::jsonSerialize — Specify data which should be serialized to JSON
set()  : mixed
setValues()  : mixed
sortByColumn()  : mixed
toArray()  : array<string|int, mixed>
Returns the values as an array.

Methods

__construct()

DataSet constructor.

public __construct(array<string|int, mixed>|Traversable $items) : mixed
Parameters
$items : array<string|int, mixed>|Traversable

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

createByArray()

public static createByArray(array<string|int, mixed> $items) : mixed
Parameters
$items : array<string|int, mixed>

createByIterator()

public static createByIterator(Traversable $iterator) : mixed
Parameters
$iterator : Traversable

filterByCallback()

public filterByCallback(mixed $callback) : mixed
Parameters
$callback : mixed

filterByFields()

public filterByFields(array<string|int, mixed> $necessaryFields) : mixed
Parameters
$necessaryFields : array<string|int, mixed>

get()

Returns any variable by its name. Null if variable is not set.

public get(string $name) : string|array<string|int, mixed>|null
Parameters
$name : string
Return values
string|array<string|int, mixed>|null

getById()

public getById(mixed $id) : mixed
Parameters
$id : mixed

getFirst()

public getFirst() : mixed

getValues()

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

isEmpty()

Returns true if the dictionary is empty.

public isEmpty() : bool
Return values
bool

isExists()

public isExists(array<string|int, mixed> $necessaryFields) : mixed
Parameters
$necessaryFields : array<string|int, mixed>

jsonSerialize()

JsonSerializable::jsonSerialize — Specify data which should be serialized to JSON

public jsonSerialize() : array<string|int, mixed>
Attributes
#[ReturnTypeWillChange]
Return values
array<string|int, mixed>

set()

public set(mixed $name[, mixed $value = null ]) : mixed
Parameters
$name : mixed
$value : mixed = null

setValues()

public setValues(mixed $values) : mixed
Parameters
$values : mixed

sortByColumn()

public sortByColumn(mixed $columns[, mixed $callbacks = '' ][, mixed $defaultValueIfNotSetValue = null ][, mixed $preserveKeys = false ]) : mixed
Parameters
$columns : mixed
$callbacks : mixed = ''
$defaultValueIfNotSetValue : mixed = null
$preserveKeys : mixed = false

toArray()

Returns the values as an array.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results