FileAccess Orion

CalendarDBAL extends BaseDBAL
in package
implements DBAL

Define doctrine database abstraction layer

Define the interface to handle stored emails 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 v3.13.1

Interfaces, Classes, Traits and Enums

DBAL
Define Database abstraction layer This is the dba handler interface definition

Table of Contents

$FIELD_ACTIVE  : string
$FIELD_ARTICLE_ID  : string
$FIELD_BLOCKING  : string
$FIELD_CALENDAR_ID  : string
$FIELD_CUSTOMER_ID  : string
$FIELD_DATE_FROM  : string
$FIELD_DATE_TO  : string
$FIELD_DESCRIPTION  : string
$FIELD_EXTERNAL_DEVICE_ID  : string
$FIELD_EXTERNAL_ID  : string
$FIELD_EXTERNAL_TASK_ID  : string
$FIELD_FILES  : string
$FIELD_ID  : string
$FIELD_LEGEND  : string
$FIELD_RESOURCE_ID  : string
$FIELD_ROOM_ID  : string
$FIELD_STATUS  : string
$FIELD_TEMPLATE_ID  : string
$FIELD_TYPE  : string
$TABLE  : string
$TABLE_ATTENDEE  : string
$TABLE_RESOURCE_LINK  : string
$table  : string
Placeholder for table field
$charset  : string
$interface  : null|bool|Connection
The search interface
$keys  : array<string|int, mixed>
__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.
FetchArticleResources()  : Result
Get resources of certain article
FetchArticleRoomBookings()  : Result
Get te room booking(s) in calendar
FetchAssignees()  : Result
Get calendar entry members
FetchList()  : Result
Fetch list
GetClient()  : Connection|null
GetServerVersion()  : string|null
GetVersion()  : string
IndexList()  : Result
LinkArticleResource()  : Result
UnlinkAllArticleResource()  : Result
UnlinkAllResource()  : Result
UnlinkArticleResource()  : Result
Update()  : Result
Update a document
UpdateArticleResource()  : Result
Write()  : Result
Add a document Add a document to search index.
WriteList()  : Result
Add a document set Add a list of documents to search index.
AddSingle()  : Result
client()  : null|Connection
Setup client
DropSingle()  : Result
FetchSingle()  : Result
hasDelta()  : bool
Check if we have a difference in the array of entries
setupFilters()  : void

Properties

$FIELD_ACTIVE

public static string $FIELD_ACTIVE = 'active'

$FIELD_ARTICLE_ID

public static string $FIELD_ARTICLE_ID = 'article_id'

$FIELD_BLOCKING

public static string $FIELD_BLOCKING = 'blocking'

$FIELD_CALENDAR_ID

public static string $FIELD_CALENDAR_ID = 'calendar_id'

$FIELD_CUSTOMER_ID

public static string $FIELD_CUSTOMER_ID = 'customer_id'

$FIELD_DATE_FROM

public static string $FIELD_DATE_FROM = 'date_from'

$FIELD_DATE_TO

public static string $FIELD_DATE_TO = 'date_to'

$FIELD_DESCRIPTION

public static string $FIELD_DESCRIPTION = 'description'

$FIELD_EXTERNAL_DEVICE_ID

public static string $FIELD_EXTERNAL_DEVICE_ID = 'external_device_id'

$FIELD_EXTERNAL_ID

public static string $FIELD_EXTERNAL_ID = 'external_id'

$FIELD_EXTERNAL_TASK_ID

public static string $FIELD_EXTERNAL_TASK_ID = 'task_id'

$FIELD_FILES

public static string $FIELD_FILES = 'files'

$FIELD_LEGEND

public static string $FIELD_LEGEND = 'legend'

$FIELD_RESOURCE_ID

public static string $FIELD_RESOURCE_ID = 'resource_id'

$FIELD_ROOM_ID

public static string $FIELD_ROOM_ID = 'room_id'

$FIELD_STATUS

public static string $FIELD_STATUS = 'status'

$FIELD_TEMPLATE_ID

public static string $FIELD_TEMPLATE_ID = 'template_id'

$FIELD_TYPE

public static string $FIELD_TYPE = 'external_type'

$TABLE_ATTENDEE

public static string $TABLE_ATTENDEE = 'calendar_attendee'

$TABLE_RESOURCE_LINK

public static string $TABLE_RESOURCE_LINK = 'linked_resource'

$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
Parameters
$id : int|string

A object id

Tags
inheritDoc
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(mixed $id) : Result
Parameters
$id : mixed

A object id

Tags
inheritDoc
Return values
Result —

A system result object

FetchArticleResources()

Get resources of certain article

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

FetchArticleRoomBookings()

Get te room booking(s) in calendar

public FetchArticleRoomBookings(string $article_id, string $room_id) : Result
Parameters
$article_id : string
$room_id : string
Return values
Result —

FetchAssignees()

Get calendar entry members

public FetchAssignees(int $id) : Result
Parameters
$id : int
Return values
Result —

FetchList()

Fetch list

public FetchList(string $type, array<int, string> $ids[, string|null $from = null ][, string|null $to = null ][, string|null $status = '' ]) : Result

Load a list of overlapping events from the calder by given range. The items inside need only to touch part of the range to be included.

Parameters
$type : string

An external type to search for

$ids : array<int, string>

A list of external ids to search for

$from : string|null = null

Start date of range in format Y-m-d h:i:s

$to : string|null = null

End date of range in format Y-m-d h:i:s

$status : string|null = ''
Return values
Result —

A system result object

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 —

LinkArticleResource()

public LinkArticleResource(array<string|int, mixed> $data) : Result
Parameters
$data : array<string|int, mixed>
Return values
Result —

UnlinkAllArticleResource()

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

UnlinkAllResource()

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

UnlinkArticleResource()

public UnlinkArticleResource(string $id) : Result
Parameters
$id : string
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

UpdateArticleResource()

public UpdateArticleResource(string $id, array<string|int, mixed> $data) : Result
Parameters
$id : string
$data : array<string|int, mixed>
Return values
Result —

Write()

Add a document Add a document to search index.

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

An 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

WriteList()

Add a document set Add a list of documents to search index.

public WriteList(int|string $id, string $type, array<string|int, mixed> $data[, string|null $task_id = null ]) : Result
Parameters
$id : int|string

An object id, this field is mandatory

$type : string

An object type name, this field is mandatory

$data : array<string|int, mixed>

The document data with key value pairs

$task_id : string|null = null

A related task identification

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 —

hasDelta()

Check if we have a difference in the array of entries

private hasDelta(array<string|int, mixed> $old, array<string|int, mixed> $new) : bool
Parameters
$old : array<string|int, mixed>
$new : array<string|int, mixed>
Return values
bool —

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