FileAccess Orion

General extends Base
in package

Implement response object

Tags
category

Helper

author

Tobias Teichner webmaster@teichner.biz

since

File available since v3.18.0

Table of Contents

$  : bool
$  : string
$  : null|string
$  : null|string
$  : int|string
$  : null|string
$  : null|string
$  : null|string
$  : null|string
$  : bool
$  : null|string
$  : null|string
$  : null|string
$  : string
$  : string|null
$  : bool
$  : string|null
$  : float|int
$  : float|int
$  : int
$  : string|null
$  : string|null
$  : string|null
$  : array<string|int, mixed>|null
$  : string
$  : int|string
$id  : null|int|string
The primary key
$score  : float|null
$type  : string|null
The object type
$_date_format  : string
Pointer to date format of system
$dynamics  : array<string|int, mixed>
__construct()  : mixed
General constructor.
__get()  : mixed|null
Magic getter to avoid "PHP 8.2: Dynamic Properties are deprecated"
__isset()  : bool
Magic check to avoid "PHP 8.2: Dynamic Properties are deprecated"
__set()  : void
Magic setter to avoid "PHP 8.2: Dynamic Properties are deprecated"
jsonSerialize()  : array<string|int, mixed>
patchExtra()  : void

Properties

$

public null|string $

content_type The system content type for relation linked searches

$

public null|string $

__type The document content type

$

public int|string $

content_id The system content id for relation linked searches

$

public null|string $

folder The folder in relations

$

public null|string $

created_at The creation date of the linked object

$

public null|string $

title The content title

$

public null|string $

key The assignment key for relations

$

public null|string $

date_from Is valid from

$

public null|string $

date_to Is valid to

$

public null|string $

teaser The content specific teaser field (translated)

$

public string $

path The relative folder path

$

public string|null $

position The position of the relation

$

public bool $

thumbnail The content specific thumbnail

$

public string|null $

name Content specific name

$

public float|int $

amount The assignment amount for amount relations

$

public float|int $

limit The configured limit

$

public string|null $

description The description depending on content type

$

public string|null $

main_company The main responsible company id for folders

$

public string|null $

sub_location Sub storage location or similar label

$

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

children Additional children of similar type

$id

The primary key

public null|int|string $id = null

$score

public float|null $score

The search equality score

$type

The object type

public string|null $type = null

$_date_format

Pointer to date format of system

protected string $_date_format = FAA_DATE_SHORT

$dynamics

private array<string|int, mixed> $dynamics = array()

Methods

__construct()

General constructor.

public __construct(object $doc, string $language[, array<string|int, mixed>|null $extra = null ]) : mixed
Parameters
$doc : object

The search response object

$language : string

The request language

$extra : array<string|int, mixed>|null = null

Additional fields

Return values
mixed —

__get()

Magic getter to avoid "PHP 8.2: Dynamic Properties are deprecated"

public __get( $name) : mixed|null
Parameters
$name :
Return values
mixed|null —

__isset()

Magic check to avoid "PHP 8.2: Dynamic Properties are deprecated"

public __isset( $name) : bool
Parameters
$name :
Return values
bool —

__set()

Magic setter to avoid "PHP 8.2: Dynamic Properties are deprecated"

public __set( $name,  $value) : void
Parameters
$name :
$value :
Return values
void —

jsonSerialize()

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

patchExtra()

protected patchExtra(object $doc, array<string|int, mixed>|null $extra) : void
Parameters
$doc : object
$extra : array<string|int, mixed>|null
Return values
void —

Search results