ObjectDatabaseRecord
in package
implements
DatabaseRecordInterface
Tags
Interfaces, Classes and Traits
Table of Contents
- EVENT_TYPE_CREATE = 'create'
- Defines the available event types of the object database Record.
- EVENT_TYPE_DELETE = 'delete'
- EVENT_TYPE_STORE = 'store'
- __construct() : mixed
- delete() : bool
- deleteByFilter() : bool
- deleteById() : bool
- getClass() : mixed
- getClassName() : mixed
- getColumnForName() : ObjectDatabaseColumn|null
- getColumns() : array<string|int, ObjectDatabaseColumn>
- Returns the database columns for the current record.
- getColumnTypes() : array<string|int, mixed>
- getData() : array<string|int, mixed>
- getDateField() : string
- getId() : mixed
- getIdField() : string
- getLastUpdateDate() : string
- getModule() : mixed
- getModuleName() : mixed
- getNewInstance() : mixed
- getSettings() : array<string|int, mixed>
- getTable() : ObjectDatabaseTable
- Returns the object database table.
- getValue() : mixed
- loadForFilter() : bool
- loadForId() : mixed
- loadForSearchResultItem() : bool
- loadFromData() : bool
- migrateOutdatedData() : mixed
- onBeforeEvent() : void
- This method will be triggered before various event types.
- onEvent() : void
- This method is triggered for various event types.
- setLastUpdateDate() : void
- setValue() : void
- store() : bool|int
- uninstall() : mixed
Constants
EVENT_TYPE_CREATE
Defines the available event types of the object database Record.
public
string
EVENT_TYPE_CREATE
= 'create'
Tags
EVENT_TYPE_DELETE
public
mixed
EVENT_TYPE_DELETE
= 'delete'
Tags
EVENT_TYPE_STORE
public
mixed
EVENT_TYPE_STORE
= 'store'
Tags
Methods
__construct()
public
__construct([mixed $iId = null ]) : mixed
Parameters
- $iId : mixed = null
Tags
Return values
mixed —delete()
public
delete() : bool
Tags
Return values
bool —deleteByFilter()
public
deleteByFilter(ObjectDatabaseSearchFilter $oFilter) : bool
Parameters
- $oFilter : ObjectDatabaseSearchFilter
Tags
Return values
bool —deleteById()
public
deleteById(array<string|int, mixed> $aIds) : bool
Parameters
- $aIds : array<string|int, mixed>
Tags
Return values
bool —getClass()
public
getClass() : mixed
Tags
Return values
mixed —getClassName()
public
getClassName() : mixed
Tags
Return values
mixed —getColumnForName()
public
getColumnForName(mixed $sColumnName) : ObjectDatabaseColumn|null
Parameters
- $sColumnName : mixed
Tags
Return values
ObjectDatabaseColumn|null —getColumns()
Returns the database columns for the current record.
public
getColumns() : array<string|int, ObjectDatabaseColumn>
Tags
Return values
array<string|int, ObjectDatabaseColumn> —An array with the database columns.
getColumnTypes()
public
getColumnTypes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getData()
public
getData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getDateField()
public
getDateField() : string
Tags
Return values
string —getId()
public
getId() : mixed
Tags
Return values
mixed —getIdField()
public
getIdField() : string
Tags
Return values
string —getLastUpdateDate()
public
getLastUpdateDate() : string
Tags
Return values
string —getModule()
public
getModule() : mixed
Tags
Return values
mixed —getModuleName()
public
getModuleName() : mixed
Tags
Return values
mixed —getNewInstance()
public
getNewInstance([mixed $iId = null ]) : mixed
Parameters
- $iId : mixed = null
Tags
Return values
mixed —getSettings()
public
getSettings() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getTable()
Returns the object database table.
public
getTable() : ObjectDatabaseTable
Tags
Return values
ObjectDatabaseTable —getValue()
public
getValue(string $sName) : mixed
Parameters
- $sName : string
Tags
Return values
mixed —loadForFilter()
public
loadForFilter(ObjectDatabaseSearchFilter $oFilter) : bool
Parameters
- $oFilter : ObjectDatabaseSearchFilter
Tags
Return values
bool —loadForId()
public
loadForId(mixed $sId) : mixed
Parameters
- $sId : mixed
Tags
Return values
mixed —loadForSearchResultItem()
public
loadForSearchResultItem(ObjectDatabaseResultSearchItem $oSearchResultItem) : bool
Parameters
- $oSearchResultItem : ObjectDatabaseResultSearchItem
Tags
Return values
bool —loadFromData()
public
loadFromData(mixed $aData) : bool
Parameters
- $aData : mixed
Tags
Return values
bool —migrateOutdatedData()
public
migrateOutdatedData([mixed $aNewColumns = array() ][, mixed $aDeletedColumnNames = array() ]) : mixed
Parameters
- $aNewColumns : mixed = array()
- $aDeletedColumnNames : mixed = array()
Tags
Return values
mixed —onBeforeEvent()
This method will be triggered before various event types.
public
onBeforeEvent(string $sEventType[, array<string|int, mixed> $aIds = [] ]) : void
Parameters
- $sEventType : string
-
The event type which will be triggered. Please see the constants EVENT_TYPE_* for all available event types.
- $aIds : array<string|int, mixed> = []
Tags
Return values
void —onEvent()
This method is triggered for various event types.
public
onEvent(string $sEventType[, array<string|int, mixed> $aIds = [] ]) : void
Parameters
- $sEventType : string
-
The event type which has been triggered. Please see the constants EVENT_TYPE_* for all available event types.
- $aIds : array<string|int, mixed> = []
Tags
Return values
void —setLastUpdateDate()
public
setLastUpdateDate(mixed $sDateTime) : void
Parameters
- $sDateTime : mixed
Tags
Return values
void —setValue()
public
setValue(string $sName, mixed $mValue) : void
Parameters
- $sName : string
- $mValue : mixed
Tags
Return values
void —store()
public
store() : bool|int
Tags
Return values
bool|int —uninstall()
public
uninstall() : mixed