Skip to content

Field Repository

Query available fields. The resource type is fields.

Basic Usage

php
use Innobrain\OnOfficeAdapter\Facades\FieldRepository;

$fields = FieldRepository::query()->withModules(['estate', 'address'])->get();
$fields = FieldRepository::query()->withModules('estate')->get();

Modules

address, estate, agentsLog, calendar, email, file, task, user

Options

php
$fields = FieldRepository::query()
    ->withModules('estate')
    ->parameters([
        'labels' => true,
        'language' => 'DEU',
        'realDataTypes' => true,
        'showfieldfilters' => true,
        'showfielddependencies' => true,
        'showFieldMeasureFormat' => true,
        'fieldList' => ['kaufpreis', 'wohnflaeche'],
    ])
    ->get();

All of these are opt-in and default to off — a default response gives no hint that richer output exists. Without realDataTypes, real field types are flattened to text (e.g. a user field reports as text).

Response Fields

PropertyDescription
typesingleselect, multiselect, freetext, float, etc.
permittedvaluesAllowed values for select fields
labelGUI label
fieldMeasureFormatData type (DATA_TYPE_MONETARY, DATA_TYPE_AREA, etc.)

TIP

Records always return internal keys (objektart: "haus", status2: "status2obj_aktiv"), never display labels. To show labels, resolve them via a fields call with 'labels' => true for the module.

WARNING

The metadata is not always complete: mandatory select fields can report empty permittedvalues, and some writable fields are missing entirely (e.g. erledigt on tasks).

TIP

Cache field responses - they can take several seconds.

Released under the MIT License.