FileAccess Orion

ChatDBAL extends BaseDBAL
in package

Define database abstraction layer for chats

Define the interface to handle stored vouchers in the database. We use the doctrine interface as base definition

Tags
category

Interface function

author

Tobias Teichner webmaster@teichner.biz

since

File available since v6.19.0

Table of Contents

$FIELD_CHAT_ID  : string
$FIELD_CREATED_AT  : string
$FIELD_CREATOR_ID  : string
$FIELD_DESCRIPTION  : string
$FIELD_EXTERNAL_ID  : string
$FIELD_ID  : string
$FIELD_LAST_SEEN_AT  : string
$FIELD_STATUS  : string
$FIELD_TITLE  : string
$REF_FIELD_MEMBERS  : string
$TABLE  : string
$TABLE_MEMBER  : string
$table  : string
Placeholder for table field
$charset  : string
$interface  : null|bool|Connection
The search interface
__construct()  : mixed
Create with individual table
AddDocument()  : Result
Add a document
DeleteDocument()  : Result
DeleteDocumentList()  : Result
Delete a document list
DirectQuery()  : Result
Direct execute query
Drop()  : Result
Delete a document
Execute()  : Result
Fetch()  : Result
Get a document Get a document from database index.
FetchAll()  : Result
GetClient()  : Connection|null
GetServerVersion()  : string|null
GetVersion()  : string
IndexList()  : Result
Update()  : Result
Update a document
Write()  : Result
Add/update a document
AddSingle()  : Result
client()  : null|Connection
Setup client
DropSingle()  : Result
FetchSingle()  : Result
setupFilters()  : void

Properties

$FIELD_CHAT_ID

public static string $FIELD_CHAT_ID = 'chat_id'

$FIELD_CREATED_AT

public static string $FIELD_CREATED_AT = 'created_at'

$FIELD_CREATOR_ID

public static string $FIELD_CREATOR_ID = 'creator_id'

$FIELD_DESCRIPTION

public static string $FIELD_DESCRIPTION = 'description'

$FIELD_EXTERNAL_ID

public static string $FIELD_EXTERNAL_ID = 'external_id'

$FIELD_ID

public static string $FIELD_ID = 'id'

$FIELD_LAST_SEEN_AT

public static string $FIELD_LAST_SEEN_AT = 'last_seen_at'

$FIELD_STATUS

public static string $FIELD_STATUS = 'status'

$FIELD_TITLE

public static string $FIELD_TITLE = 'title'

$REF_FIELD_MEMBERS

public static string $REF_FIELD_MEMBERS = 'members'

$TABLE

public static string $TABLE = 'chat'

$TABLE_MEMBER

public static string $TABLE_MEMBER = 'chat_member'

$table

Placeholder for table field

protected string $table = ''

$charset

private string $charset = 'utf8mb4'

The charset for the connection

$interface

The search interface

private null|bool|Connection $interface = null

A client instance

Methods

__construct()

Create with individual table

public __construct() : mixed

VoucherDBAL constructor.

Return values
mixed —

AddDocument()

Add a document

public AddDocument(int|string|null $id, string|null $type, mixed $data[, bool $has_auto_increment = false ][, string|null $table = null ]) : Result

Add a document to search index.

Parameters
$id : int|string|null

A object id

$type : string|null

The type of object, in our case the primary column

$data : mixed

The document data with key value pairs

$has_auto_increment : bool = false

Known table with auto increment column

$table : string|null = null
Return values
Result —

A system result object

DeleteDocument()

public DeleteDocument(int|string|array<string|int, mixed> $id, string $type) : Result
Parameters
$id : int|string|array<string|int, mixed>
$type : string
Tags
inheritDoc
Return values
Result —

DeleteDocumentList()

Delete a document list

public DeleteDocumentList(string|null $type) : Result

Delete a document list from search index. When no type is given then delete the hole index

Parameters
$type : string|null

The type of object

Return values
Result —

A system result object

DirectQuery()

Direct execute query

public DirectQuery(string $sql) : Result

Execute a given query, use with care and commit using external arguments

Parameters
$sql : string

The query to execute

Return values
Result —

A system result object

Drop()

Delete a document

public Drop(int|string $id) : Result

Delete a document from database index.

Parameters
$id : int|string

An internal or, external object id

Return values
Result —

A system result object

Execute()

public Execute(array<string|int, mixed> $filter, array<string|int, mixed> $order, array<string|int, mixed> $payload, string|null $language, null|object $handler) : Result
Parameters
$filter : array<string|int, mixed>
$order : array<string|int, mixed>
$payload : array<string|int, mixed>
$language : string|null
$handler : null|object
Tags
inheritDoc
Return values
Result —

Fetch()

Get a document Get a document from database index.

public Fetch(int|string $id) : Result
Parameters
$id : int|string

A object id

Return values
Result —

A system result object

FetchAll()

public FetchAll(string $member_id, int $start, int $length, string|null $search) : Result
Parameters
$member_id : string
$start : int
$length : int
$search : string|null
Return values
Result —

GetClient()

public GetClient() : Connection|null
Return values
Connection|null —

GetServerVersion()

public GetServerVersion() : string|null
Tags
inheritDoc
Return values
string|null —

GetVersion()

public GetVersion() : string
Tags
inheritDoc
Return values
string —

IndexList()

public IndexList(string $type, array<string|int, mixed> $list[, bool $is_full = false ][, int|string|object $correct_count = -1 ]) : Result
Parameters
$type : string
$list : array<string|int, mixed>
$is_full : bool = false
$correct_count : int|string|object = -1
Tags
inheritDoc
Return values
Result —

Update()

Update a document

public Update(array<string|int, mixed> $condition, array<string|int, mixed> $data[, string|null $table = null ]) : Result

Update a document in search index, without check for existing.

Parameters
$condition : array<string|int, mixed>
$data : array<string|int, mixed>

The document data with key value pairs

$table : string|null = null
Return values
Result —

A system result object

Write()

Add/update a document

public Write(int|string|null $id, array<string|int, mixed> $data) : Result

Add/update a document to search index.

Parameters
$id : int|string|null

A object id or, null for new entries

$data : array<string|int, mixed>

The document data with key value pairs

Return values
Result —

A system result object

AddSingle()

protected AddSingle(array<string|int, mixed> $cells, string $pk, string $table) : Result
Parameters
$cells : array<string|int, mixed>
$pk : string
$table : string
Return values
Result —

client()

Setup client

protected client() : null|Connection

Connect to local database server and return instance. This method is cached

Return values
null|Connection —

DropSingle()

protected DropSingle(int|string $id, string $pk, string $table) : Result
Parameters
$id : int|string
$pk : string
$table : string
Return values
Result —

FetchSingle()

protected FetchSingle(int|string $id, string $pk, string $table) : Result
Parameters
$id : int|string
$pk : string
$table : string
Return values
Result —

setupFilters()

private setupFilters(array<string|int, Filter> $filters, QueryBuilder &$queryBuilder, QueryBuilder &$queryBuilderCount) : void
Parameters
$filters : array<string|int, Filter>

A set of filters

$queryBuilder : QueryBuilder

A doctrine query builder for search

$queryBuilderCount : QueryBuilder

A doctrine query builder for count

Return values
void —

Search results