Bitrix API

MemoryBuilder

Tags
template

Table of Contents

Methods

build()  : array<string|int, Message>
Builds messages.
setLimit()  : $this
Sets limit for messages.
useMergeMode()  : self
Sets time interval for merge mode.

Methods

build()

Builds messages.

public build() : array<string|int, Message>

It's a main method to get messages. It returns messages according to set limit.

Return values
array<string|int, Message>

List of messages.

setLimit()

Sets limit for messages.

public setLimit(int $limit) : $this

It's maximum number of messages to return after build. Pay attention that it's not a number of messages to load.

Parameters
$limit : int

Limit.

Tags
see
self::useMergeMode()
Return values
$this

useMergeMode()

Sets time interval for merge mode.

public useMergeMode(int $timeInterval) : self

Merge mode is used to merge messages with the same author in a short time interval in a row.

Parameters
$timeInterval : int

Time interval in seconds.

Return values
self

        
On this page

Search results