FileAccess Orion

Chat extends BaseDbContent
in package

Define system chat object

Tags
category

Core content type

author

Tobias Teichner webmaster@teichner.biz

since

File available since v6.19.0

Table of Contents

$members  : null|array<string|int, string>
$db_fields  : array<string|int, mixed>
$dbal  : DBAL|null
The database abstraction layer buffer
__construct()  : mixed
Chat constructor.
Delete()  : Result|null
Delete from database
Save()  : Result|null
SendMessage()  : Result
Create anew message for all members
SetSeen()  : Result
Update a members based last seen state
ToPlainObject()  : stdClass
To plain resolved object
database()  : DBAL|null
Get db instance
loadFromSrc()  : void
Fetch from db

Properties

$members

public null|array<string|int, string> $members

The member ids

$db_fields

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

Methods

__construct()

Chat constructor.

public __construct([string|null $id = null ][, null|string $language = null ]) : mixed
Parameters
$id : string|null = null

The chat id

$language : null|string = null

The local language or null

Return values
mixed —

Delete()

Delete from database

public Delete([false $skip = false ]) : Result|null
Parameters
$skip : false = false
Return values
Result|null —

Save()

public Save([false $force_new_id = false ]) : Result|null
Parameters
$force_new_id : false = false
Return values
Result|null —

SendMessage()

Create anew message for all members

public SendMessage(string $payload, int $status[, string|null $user_id = null ]) : Result
Parameters
$payload : string
$status : int
$user_id : string|null = null
Return values
Result —

SetSeen()

Update a members based last seen state

public SetSeen(string $id) : Result
Parameters
$id : string
Return values
Result —

ToPlainObject()

To plain resolved object

public ToPlainObject([ $language = null ][,  $with_parent = true ]) : stdClass
Parameters
$language : = null
$with_parent : = true
Return values
stdClass —

database()

Get db instance

protected database() : DBAL|null
Return values
DBAL|null —

loadFromSrc()

Fetch from db

protected loadFromSrc() : void
Return values
void —

Search results