Bitrix API

State extends Dictionary

FinalYes

Table of Contents

Methods

__construct()  : mixed
State constructor.
__toString()  : mixed
__unserialize()  : void
addStepChain()  : State
append()  : State
clear()  : mixed
createFromEncodedData()  : mixed
createFromRequest()  : State
get()  : null|string|array<string|int, mixed>
Returns any variable by its name. Null if variable is not set.
getPrevStep()  : mixed
getStepNumber()  : int
getValues()  : array<string|int, mixed>
isEmpty()  : bool
Returns true if the dictionary is empty.
jsonSerialize()  : array<string|int, mixed>
JsonSerializable::jsonSerialize — Specify data which should be serialized to JSON
popStepChain()  : mixed
set()  : mixed
setValues()  : mixed
toArray()  : array<string|int, mixed>
Returns the values as an array.
toString()  : string
unSign()  : string

Methods

__construct()

State constructor.

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

__toString()

public __toString() : mixed

__unserialize()

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

addStepChain()

public addStepChain(mixed $step) : State
Parameters
$step : mixed
Return values
State

append()

public append(array<string|int, mixed> $values) : State
Parameters
$values : array<string|int, mixed>
Return values
State

createFromEncodedData()

public static createFromEncodedData(mixed $data) : mixed
Parameters
$data : mixed

createFromRequest()

public static createFromRequest(HttpRequest $request) : State
Parameters
$request : HttpRequest
Return values
State

get()

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

public get(string $name[, callable|null $defaultValue = null ]) : null|string|array<string|int, mixed>
Parameters
$name : string
$defaultValue : callable|null = null
Return values
null|string|array<string|int, mixed>

getPrevStep()

public getPrevStep() : mixed

getStepNumber()

public getStepNumber() : int
Return values
int

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

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>

popStepChain()

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

toArray()

Returns the values as an array.

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

toString()

public toString() : string
Return values
string

unSign()

public unSign(string $data) : string
Parameters
$data : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results