CombinedRecord
Combined record class
Table of Contents
Properties
- $liveRecord : DatabaseRecord
- $table : string
- $versionRecord : DatabaseRecord
Methods
- __construct() : mixed
- create() : CombinedRecord
- Creates combined record object just by live-id and version-id of database record rows.
- createFromArrays() : CombinedRecord
- Creates combined record object by relevant database live-record and version-record rows.
- getLiveId() : int
- Gets the id of the live-record.
- getLiveRecord() : DatabaseRecord
- Gets the live-record object.
- getTable() : string
- Gets the name of the database table.
- getVersiondId() : int
- Gets the id of version-record.
- getVersionRecord() : DatabaseRecord
- Gets the version-record object.
- setLiveRecord() : void
- Sets the live-record object.
- setTable() : void
- Sets the name of the database table.
- setVersionRecord() : void
- Sets the version-record object.
Properties
$liveRecord
protected
DatabaseRecord
$liveRecord
$table
protected
string
$table
$versionRecord
protected
DatabaseRecord
$versionRecord
Methods
__construct()
public
__construct(string $table, DatabaseRecord $liveRecord, DatabaseRecord $versionRecord) : mixed
Parameters
- $table : string
- $liveRecord : DatabaseRecord
- $versionRecord : DatabaseRecord
create()
Creates combined record object just by live-id and version-id of database record rows.
public
static create(string $table, int $liveId, int $versionId) : CombinedRecord
Parameters
- $table : string
-
Name of the database table
- $liveId : int
-
Id of the database live-record row
- $versionId : int
-
Id of the database version-record row
Return values
CombinedRecordcreateFromArrays()
Creates combined record object by relevant database live-record and version-record rows.
public
static createFromArrays(string $table, array<string|int, mixed> $liveRow, array<string|int, mixed> $versionRow) : CombinedRecord
Parameters
- $table : string
-
Name of the database table
- $liveRow : array<string|int, mixed>
-
The relevant database live-record row
- $versionRow : array<string|int, mixed>
-
The relevant database version-record row
Return values
CombinedRecordgetLiveId()
Gets the id of the live-record.
public
getLiveId() : int
Return values
intgetLiveRecord()
Gets the live-record object.
public
getLiveRecord() : DatabaseRecord
Return values
DatabaseRecordgetTable()
Gets the name of the database table.
public
getTable() : string
Return values
stringgetVersiondId()
Gets the id of version-record.
public
getVersiondId() : int
Return values
intgetVersionRecord()
Gets the version-record object.
public
getVersionRecord() : DatabaseRecord
Return values
DatabaseRecordsetLiveRecord()
Sets the live-record object.
public
setLiveRecord(DatabaseRecord $liveRecord) : void
Parameters
- $liveRecord : DatabaseRecord
setTable()
Sets the name of the database table.
public
setTable(string $table) : void
Parameters
- $table : string
setVersionRecord()
Sets the version-record object.
public
setVersionRecord(DatabaseRecord $versionRecord) : void
Parameters
- $versionRecord : DatabaseRecord