ObjectDatabaseTable
in package
Tags
Table of Contents
- __construct() : mixed
- The ObjectDatabaseTable constructor.
- addRecord() : void
- clearRecords() : void
- getRecords() : array<string|int, mixed>
- getResultBySearch() : ObjectDatabaseSearchResult
- getResultCountBySearch() : int
- getTableRecord() : ObjectDatabaseRecord
- Returns the current record from the ObjectDatabase table.
- getTableRecordClassName() : string
- insertRecords() : void
- updateRecordsForFilter() : ObjectDatabaseResult
- Updates records for a given column / value mapping and filter
Methods
__construct()
The ObjectDatabaseTable constructor.
public
__construct(ObjectDatabaseRecord|string $mTableRecord) : mixed
Parameters
- $mTableRecord : ObjectDatabaseRecord|string
-
The table record.
Tags
Return values
mixed —addRecord()
public
addRecord(ObjectDatabaseRecord $oRecord[, mixed $bUseIdAsKey = false ]) : void
Parameters
- $oRecord : ObjectDatabaseRecord
- $bUseIdAsKey : mixed = false
Tags
Return values
void —clearRecords()
public
clearRecords() : void
Tags
Return values
void —getRecords()
public
getRecords() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getResultBySearch()
public
getResultBySearch(ObjectDatabaseSearch $oSearch) : ObjectDatabaseSearchResult
Parameters
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseSearchResult —getResultCountBySearch()
public
getResultCountBySearch(ObjectDatabaseSearch $oSearch) : int
Parameters
- $oSearch : ObjectDatabaseSearch
Tags
Return values
int —getTableRecord()
Returns the current record from the ObjectDatabase table.
public
getTableRecord() : ObjectDatabaseRecord
Tags
Return values
ObjectDatabaseRecord —getTableRecordClassName()
public
getTableRecordClassName() : string
Tags
Return values
string —insertRecords()
public
insertRecords() : void
Tags
Return values
void —updateRecordsForFilter()
Updates records for a given column / value mapping and filter
public
updateRecordsForFilter(ObjectDatabaseSearchFilter $oObjectDatabaseFilter, array<string|int, mixed> $aColumnValueMapping) : ObjectDatabaseResult
Parameters
- $oObjectDatabaseFilter : ObjectDatabaseSearchFilter
-
The filter to restrict the records, which should be updated.
- $aColumnValueMapping : array<string|int, mixed>
-
The column / value mapping to update the records.