Bitrix API

State extends Dictionary

Table of Contents

Constants

MODE_CREATE  = 1
MODE_DELETE  = 3
MODE_UPDATE  = 2

Methods

__construct()  : mixed
Creates object.
__unserialize()  : void
clear()  : mixed
containsKey()  : mixed
enter()  : mixed
get()  : string|array<string|int, mixed>|null
Returns any variable by its name. Null if variable is not set.
getEnterTime()  : mixed
getEnterTimeAsDateTime()  : mixed
getEnterTimeFormatted()  : mixed
getEnterTimeObject()  : mixed
getMode()  : mixed
getParameters()  : mixed
getResult()  : Result
getValues()  : array<string|int, mixed>
isEmpty()  : bool
Returns true if the dictionary is empty.
isInProgress()  : mixed
isModeCreate()  : mixed
isModeDelete()  : mixed
isModeUpdate()  : mixed
jsonSerialize()  : array<string|int, mixed>
JsonSerializable::jsonSerialize — Specify data which should be serialized to JSON
leave()  : mixed
set()  : mixed
setValue()  : mixed
setValues()  : mixed
toArray()  : array<string|int, mixed>
Returns the values as an array.

Constants

MODE_CREATE

public mixed MODE_CREATE = 1

MODE_DELETE

public mixed MODE_DELETE = 3

MODE_UPDATE

public mixed MODE_UPDATE = 2

Methods

__construct()

Creates object.

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

__unserialize()

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

containsKey()

public containsKey(mixed $key) : mixed
Parameters
$key : mixed

enter()

public enter([array<string|int, mixed> $values = array() ][, mixed $mode = 1 ][, mixed $parameters = null ]) : mixed
Parameters
$values : array<string|int, mixed> = array()
$mode : mixed = 1
$parameters : mixed = null

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

getEnterTime()

public getEnterTime() : mixed

getEnterTimeAsDateTime()

public getEnterTimeAsDateTime() : mixed

getEnterTimeFormatted()

public getEnterTimeFormatted() : mixed

getEnterTimeObject()

public getEnterTimeObject() : mixed

getMode()

public getMode() : mixed

getParameters()

public getParameters() : 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

isInProgress()

public isInProgress() : mixed

isModeCreate()

public isModeCreate() : mixed

isModeDelete()

public isModeDelete() : mixed

isModeUpdate()

public isModeUpdate() : 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>

leave()

public leave() : mixed

set()

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

setValue()

public setValue(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed

setValues()

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

toArray()

Returns the values as an array.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results