Bitrix API

PageState

FinalYes

Table of Contents

Constants

SIGNER_SALT  = 'pageState'
STEP_DELETED_OBJECTS  = 'd'
STEP_PERSONAL  = 'p'
STEP_SYMLINKS  = 's'

Methods

__construct()  : mixed
PageState constructor.
__toString()  : string
Returns string representation (works with Signer).
createFromSignedString()  : static
Creates the PageState from signedData.
getCursor()  : mixed
getDataByStep()  : array<string|int, mixed>
Returns data.
getNextId()  : string
Returns next id.
getOffset()  : int
Returns offset. By default is 0.
getStep()  : string
hasCursor()  : bool
hasNextId()  : bool
Tells if the page state has next id.
isEqual()  : bool
Tells if the current page state is equal to another.
reset()  : $this
Resets state (fields nextId, skipIds and dataByStep).
setCursor()  : $this
setDataByStep()  : $this
setNextId()  : $this
Sets next id of entity which will be expected on the step.
setOffset()  : $this
Sets offset.
setStep()  : $this

Constants

SIGNER_SALT

public mixed SIGNER_SALT = 'pageState'

STEP_DELETED_OBJECTS

public mixed STEP_DELETED_OBJECTS = 'd'

STEP_PERSONAL

public mixed STEP_PERSONAL = 'p'

STEP_SYMLINKS

public mixed STEP_SYMLINKS = 's'

Methods

__construct()

PageState constructor.

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

Step name.

$dataByStep : array<string|int, mixed>|null = null

Data associated with step.

__toString()

Returns string representation (works with Signer).

public __toString() : string
Tags
throws
ArgumentTypeException
Return values
string

createFromSignedString()

Creates the PageState from signedData.

public static createFromSignedString(string $signedData) : static
Parameters
$signedData : string

String which contains signed data.

Tags
throws
ArgumentTypeException
throws
BadSignatureException
Return values
static

getDataByStep()

Returns data.

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

getNextId()

Returns next id.

public getNextId() : string
Return values
string

getOffset()

Returns offset. By default is 0.

public getOffset() : int
Return values
int

getStep()

public getStep() : string
Return values
string

hasCursor()

public hasCursor() : bool
Return values
bool

hasNextId()

Tells if the page state has next id.

public hasNextId() : bool
Return values
bool

isEqual()

Tells if the current page state is equal to another.

public isEqual(PageState $pageState) : bool
Parameters
$pageState : PageState

Page state for comparison.

Return values
bool

reset()

Resets state (fields nextId, skipIds and dataByStep).

public reset() : $this
Return values
$this

setCursor()

public setCursor(mixed $cursor) : $this
Parameters
$cursor : mixed
Return values
$this

setDataByStep()

public setDataByStep(array<string|int, mixed> $dataByStep) : $this
Parameters
$dataByStep : array<string|int, mixed>
Return values
$this

setNextId()

Sets next id of entity which will be expected on the step.

public setNextId(string $nextId) : $this
Parameters
$nextId : string

Next id.

Return values
$this

setOffset()

Sets offset.

public setOffset(int $offset) : $this
Parameters
$offset : int

Offset.

Return values
$this

setStep()

public setStep(string $step) : $this
Parameters
$step : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results