Copied!

DefaultDataFieldStorage

DefaultDataFieldStorage.php : 14
Interface
Extends FieldStorage

Interface for setting field type data.

Methods in this interface are called by storage engine.

Methods

publicdeleteFieldData()

FieldStorage.php : 63

Deletes field data for all $fieldIds in the version identified by $versionInfo.

 
public deleteFieldData(VersionInfo $versionInfo, array<string|int, mixed> $fieldIds) : bool

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$fieldIds array<string|int, mixed> -

Array of field IDs

Return values

bool

publicgetDefaultFieldData()

DefaultDataFieldStorage.php : 23

Populates <code>$field</code> value property with default data based on the external data.

 
public getDefaultFieldData(VersionInfo $versionInfo, Field $field) : void

$field->value is a FieldValue object. This value holds the data as a Value based object, according to the field type (e.g. for TextLine, it will be a Value object).

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$field Field - -

publicgetFieldData()

FieldStorage.php : 52

Populates $field value property based on the external data.

 
public getFieldData(VersionInfo $versionInfo, Field $field) : mixed

$field->value is a FieldValue object. This value holds the data as a Value based object, according to the field type (e.g. for TextLine, it will be a Value object).

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$field Field - -

publichasFieldData()

FieldStorage.php : 70

Checks if field type has external data to deal with.

 
public hasFieldData() : bool

Return values

bool

publicstoreFieldData()

FieldStorage.php : 41

Allows custom field types to store data in an external source (e.g. another DB table).

 
public storeFieldData(VersionInfo $versionInfo, Field $field) : mixed

Stores value for $field in an external data source. The whole Field object is passed and its value is accessible through the FieldValue 'value' property. This value holds the data filled by the user as a Value based object, according to the field type (e.g. for TextLine, it will be a Value object).

$field->id = unique ID from the attribute tables (needs to be generated by database back end on create, before the external data source may be called from storing).

This method might return true if $field needs to be updated after storage done here (to store a PK for instance). In any other case, this method must not return anything (null).

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$field Field - -

Return values

mixed

null|true