Bitrix API

Queue

Class Queue

Table of Contents

Methods

__construct()  : mixed
Queue constructor.
current()  : null|string
Get last used item from list.
delete()  : $this
Remove data from DB by type and ID.
disableAutoSave()  : $this
Save last item automatically.
enableUserCheck()  : $this
Return true if user checking enabled.
enableWorkTimeCheck()  : $this
Enable work time checking.
getId()  : null|string
Get ID.
getValues()  : array<string|int, mixed>
Get list.
isSupportedWorkTime()  : bool
Return true if wirk time is supported.
isWorkTimeCheckEnabled()  : bool
Return true if work time checking enabled.
next()  : string|null
Return next item from list.
previous()  : string|null
Return previous used item.
restore()  : $this
Restore last item from DB.
save()  : $this
Save last item to DB.
setId()  : $this
Set ID.
setValues()  : $this
Set list.

Methods

__construct()

Queue constructor.

public __construct(string $type, string $id[, array<string|int, mixed> $list = [] ]) : mixed
Parameters
$type : string

Type.

$id : string

ID.

$list : array<string|int, mixed> = []

List.

current()

Get last used item from list.

public current() : null|string
Return values
null|string

delete()

Remove data from DB by type and ID.

public delete() : $this
Return values
$this

disableAutoSave()

Save last item automatically.

public disableAutoSave() : $this
Return values
$this

enableUserCheck()

Return true if user checking enabled.

public enableUserCheck() : $this
Return values
$this

enableWorkTimeCheck()

Enable work time checking.

public enableWorkTimeCheck() : $this
Return values
$this

getId()

Get ID.

public getId() : null|string
Return values
null|string

getValues()

Get list.

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

isSupportedWorkTime()

Return true if wirk time is supported.

public static isSupportedWorkTime() : bool
Return values
bool

isWorkTimeCheckEnabled()

Return true if work time checking enabled.

public isWorkTimeCheckEnabled() : bool
Return values
bool

next()

Return next item from list.

public next() : string|null

Save item to DB if $isAutoSaveEnabled is true. Check item as User if $isUserCheckEnabled is true. Check item for work time if $isWorkTimeCheckEnabled is true.

Return values
string|null

previous()

Return previous used item.

public previous() : string|null

Stack of previous items is limited by 3 values.

Return values
string|null

restore()

Restore last item from DB.

public restore() : $this
Return values
$this

save()

Save last item to DB.

public save() : $this
Return values
$this

setId()

Set ID.

public setId(null|string $id) : $this
Parameters
$id : null|string
Return values
$this

setValues()

Set list.

public setValues(array<string|int, mixed> $list) : $this
Parameters
$list : array<string|int, mixed>

List.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results