Documentation

Messages
in package
implements Serializable uses Serializable

Implements session messages.

Table of Contents

Interfaces

Serializable

Properties

$isCleared  : bool
$messages  : array<string|int, mixed>

Methods

__serialize()  : array<string|int, mixed>
__unserialize()  : void
add()  : $this
Add message to the queue.
all()  : array<string|int, mixed>
Fetch all messages.
clear()  : $this
Clear message queue.
fetch()  : array<string|int, mixed>
Fetch and clear message queue.
isCleared()  : bool
serialize()  : string
unserialize()  : void
getUnserializeAllowedClasses()  : array<string|int, mixed>|bool

Properties

$isCleared

protected bool $isCleared = false

$messages

protected array<string|int, mixed> $messages = []

Methods

__serialize()

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

__unserialize()

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

add()

Add message to the queue.

public add(string $message[, string $scope = 'default' ]) : $this
Parameters
$message : string
$scope : string = 'default'
Return values
$this

all()

Fetch all messages.

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

clear()

Clear message queue.

public clear([string|null $scope = null ]) : $this
Parameters
$scope : string|null = null
Return values
$this

fetch()

Fetch and clear message queue.

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

isCleared()

public isCleared() : bool
Return values
bool

serialize()

public final serialize() : string
Return values
string

unserialize()

public final unserialize(string $serialized) : void
Parameters
$serialized : string

getUnserializeAllowedClasses()

protected getUnserializeAllowedClasses() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

        
On this page

Search results