com\setasign\Konquadrat\Field\FieldContainer

FieldContainerInterface Interface FieldContainerInterface

File: /Konquadrat/src/Field/FieldContainer/FieldContainerInterface.php

Implemented in

Summary

Methods

__get()

abstract public FieldContainerInterface::__get (
string $fieldName
): ?mixed

Alias for get($fieldName, true)

Parameters
$fieldName : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\MissingConfigurationException

See

__isset()

abstract public FieldContainerInterface::__isset (
string $fieldName
): bool

Checks whether $fieldName exists and the value is not null.

Parameters
$fieldName : string
 

__set()

abstract public FieldContainerInterface::__set (
string $fieldName,
mixed $value
): void

Alias for set($fieldName, $value)

Parameters
$fieldName : string
 
$value : mixed
 
See

get()

abstract public FieldContainerInterface::get (
string $fieldName,
bool $resolve = true
): ?mixed

Get the value of $fieldName.

Parameters
$fieldName : string
 
$resolve : bool

Resolve resolvable fields like reference and json fields.

getField()

Gets the field instance of $fieldName.

Parameters
$fieldName : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\MissingConfigurationException If the field isn't configured.

getFieldContainerName()

abstract public FieldContainerInterface::getFieldContainerName (
void
): string

getFields()

abstract public FieldContainerInterface::getFields (
void
): array

Return all fields.

hasField()

abstract public FieldContainerInterface::hasField (
string $fieldName
): bool

Checks whether the object has the field $fieldName.

Parameters
$fieldName : string
 

isSettingData()

abstract public FieldContainerInterface::isSettingData (
void
): bool

Will be true when the data from the database will be inserted into the object.

set()

abstract public FieldContainerInterface::set (
string $fieldName,
mixed|\com\setasign\Konquadrat\Field\DefaultValue $value
): static

Sets the value for the field.

If $value is a AbstractObject and the field is a reference field this method will automatically use setParent/setReference.

Parameters
$fieldName : string
 
$value : mixed|\com\setasign\Konquadrat\Field\DefaultValue
 

update()

This field will notify the field container that the field was updated.

Parameters
$field : \com\setasign\Konquadrat\Field\AbstractField