ObjectDatabaseInstance
in package
Tags
Table of Contents
- __construct() : mixed
- addMultipleColumnsToTable() : ObjectDatabaseResult
- changeMultipleColumnsInTable() : ObjectDatabaseResult
- createAlias() : ObjectDatabaseResult
- createTable() : array<string|int, mixed>
- Creates the table for a specific name and ObjectDatabaseColumn objects.
- deleteAlias() : ObjectDatabaseResult
- deleteDataFromTable() : ObjectDatabaseResult
- deleteDataFromTableWithSearch() : ObjectDatabaseResult
- deleteMultipleColumnsFromTable() : ObjectDatabaseResult
- dropTable() : ObjectDatabaseResult
- existAliasWithName() : bool
- existTableWithName() : bool
- flushTable() : ObjectDatabaseResult
- getAlias() : ObjectDatabaseResult
- getColumnType() : string
- getConfiguration() : ObjectDatabaseConfiguration
- Returns the object database configuration.
- getDataCountFromTableWithSearch() : ObjectDatabaseSearchResult
- getDataFromTableWithId() : ObjectDatabaseResult
- getDataFromTableWithSearch() : ObjectDatabaseSearchResult
- getNodesInfo() : mixed
- getQuotedValue() : mixed
- Returns the quoted value based on the column type and the collection type.
- getTableColumns() : array<string|int, mixed>
- getTableNameForAlias() : string
- getTablePrefix() : string
- getUnquotedValue() : mixed
- Returns the unquoted value based on the column type and the collection type.
- insertDataIntoTable() : bool|mixed
- insertDataIntoTable
- insertMultipleDataIntoTable() : ObjectDatabaseResult
- insertMultipleDataIntoTable
- isConnected() : bool
- reindexTable() : ObjectDatabaseResult
- Re-indexes a table with a given table name.
- truncateTable() : ObjectDatabaseResult
- updateAlias() : ObjectDatabaseResult
- updateDataInTable() : bool|mixed
- updateTable
- updateDataInTableWithSearchFilter() : bool|mixed
- updateTable
Methods
__construct()
public
__construct(ObjectDatabaseConfiguration $oConfiguration) : mixed
Parameters
- $oConfiguration : ObjectDatabaseConfiguration
Tags
Return values
mixed —addMultipleColumnsToTable()
public
addMultipleColumnsToTable(string $sTableName, array<string|int, mixed> $aColumns) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : array<string|int, mixed>
Tags
Return values
ObjectDatabaseResult —changeMultipleColumnsInTable()
public
changeMultipleColumnsInTable(string $sTableName, array<string|int, mixed> $aColumns) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : array<string|int, mixed>
Tags
Return values
ObjectDatabaseResult —createAlias()
public
createAlias(string $sAliasName, string $sTableName) : ObjectDatabaseResult
Parameters
- $sAliasName : string
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —createTable()
Creates the table for a specific name and ObjectDatabaseColumn objects.
public
createTable(string $sTableName[, array<string|int, ObjectDatabaseColumn> $aColumns = array() ][, array<string|int, mixed> $aSettings = array() ]) : array<string|int, mixed>
Parameters
- $sTableName : string
- $aColumns : array<string|int, ObjectDatabaseColumn> = array()
- $aSettings : array<string|int, mixed> = array()
Tags
Return values
array<string|int, mixed> —deleteAlias()
public
deleteAlias(string $sAliasName, string $sTableName) : ObjectDatabaseResult
Parameters
- $sAliasName : string
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —deleteDataFromTable()
public
deleteDataFromTable(string $sTableName, array<string|int, mixed> $aIds) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aIds : array<string|int, mixed>
Tags
Return values
ObjectDatabaseResult —deleteDataFromTableWithSearch()
public
deleteDataFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseResult —deleteMultipleColumnsFromTable()
public
deleteMultipleColumnsFromTable(string $sTableName, mixed $aColumns) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : mixed
Tags
Return values
ObjectDatabaseResult —dropTable()
public
dropTable(string $sTableName) : ObjectDatabaseResult
Parameters
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —existAliasWithName()
public
existAliasWithName(string $sAliasName) : bool
Parameters
- $sAliasName : string
Tags
Return values
bool —existTableWithName()
public
existTableWithName(string $sTableName) : bool
Parameters
- $sTableName : string
Tags
Return values
bool —flushTable()
public
flushTable(string $sTableName) : ObjectDatabaseResult
Parameters
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —getAlias()
public
getAlias(string $sAliasName) : ObjectDatabaseResult
Parameters
- $sAliasName : string
Tags
Return values
ObjectDatabaseResult —getColumnType()
public
getColumnType(string $sColumnName, array<string|int, mixed> $aColumns) : string
Parameters
- $sColumnName : string
- $aColumns : array<string|int, mixed>
Tags
Return values
string —getConfiguration()
Returns the object database configuration.
public
getConfiguration() : ObjectDatabaseConfiguration
Tags
Return values
ObjectDatabaseConfiguration —getDataCountFromTableWithSearch()
public
getDataCountFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : ObjectDatabaseSearchResult
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseSearchResult —getDataFromTableWithId()
public
getDataFromTableWithId(string $sTableName, string $sId) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $sId : string
Tags
Return values
ObjectDatabaseResult —getDataFromTableWithSearch()
public
getDataFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : ObjectDatabaseSearchResult
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseSearchResult —getNodesInfo()
public
getNodesInfo() : mixed
Tags
Return values
mixed —getQuotedValue()
Returns the quoted value based on the column type and the collection type.
public
getQuotedValue(mixed $mValue[, string $sType = ObjectDatabaseColumn::TYPE_TEXT ]) : mixed
Intentionally used single ' to escape the string values.
Parameters
- $mValue : mixed
-
The value which should be quoted.
- $sType : string = ObjectDatabaseColumn::TYPE_TEXT
-
The column type of the value.
Tags
Return values
mixed —with the quoted value.
getTableColumns()
public
getTableColumns(string $sTableName) : array<string|int, mixed>
Parameters
- $sTableName : string
Tags
Return values
array<string|int, mixed> —getTableNameForAlias()
public
getTableNameForAlias(string $sAliasName) : string
Parameters
- $sAliasName : string
Tags
Return values
string —getTablePrefix()
public
getTablePrefix() : string
Tags
Return values
string —getUnquotedValue()
Returns the unquoted value based on the column type and the collection type.
public
getUnquotedValue(mixed $mQuotedValue[, string $sType = ObjectDatabaseColumn::TYPE_TEXT ]) : mixed
Parameters
- $mQuotedValue : mixed
-
The value which should be unquoted.
- $sType : string = ObjectDatabaseColumn::TYPE_TEXT
-
The column type of the value.
Tags
Return values
mixed —with the unquoted value.
insertDataIntoTable()
insertDataIntoTable
public
insertDataIntoTable(string $sTableName, array<string|int, mixed> $aColumnValueMapping[, array<string|int, ObjectDatabaseColumn> $aColumns = array() ]) : bool|mixed
Parameters
- $sTableName : string
- $aColumnValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = array()
Tags
Return values
bool|mixed —insertMultipleDataIntoTable()
insertMultipleDataIntoTable
public
insertMultipleDataIntoTable(string $sTableName, array<string|int, mixed> $aMultipleData[, array<string|int, ObjectDatabaseColumn> $aColumns = array() ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aMultipleData : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = array()
-
@return bool|mixed
Tags
Return values
ObjectDatabaseResult —isConnected()
public
isConnected() : bool
Tags
Return values
bool —reindexTable()
Re-indexes a table with a given table name.
public
reindexTable(string $sTableName[, array<string|int, mixed> $aColumns = array() ][, array<string|int, mixed> $aSettings = array() ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : array<string|int, mixed> = array()
- $aSettings : array<string|int, mixed> = array()
Tags
Return values
ObjectDatabaseResult —truncateTable()
public
truncateTable(string $sTableName[, array<string|int, mixed> $aColumns = array() ][, array<string|int, mixed> $aSettings = array() ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : array<string|int, mixed> = array()
- $aSettings : array<string|int, mixed> = array()
Tags
Return values
ObjectDatabaseResult —updateAlias()
public
updateAlias(string $sAliasName, string $sTableName) : ObjectDatabaseResult
Parameters
- $sAliasName : string
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —updateDataInTable()
updateTable
public
updateDataInTable(string $sTableName, array<string|int, mixed> $aColumnValueMapping[, array<string|int, ObjectDatabaseColumn> $aColumns = array() ]) : bool|mixed
Parameters
- $sTableName : string
- $aColumnValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = array()
Tags
Return values
bool|mixed —updateDataInTableWithSearchFilter()
updateTable
public
updateDataInTableWithSearchFilter(string $sTableName, ObjectDatabaseSearchFilter $oSearchFilter, array<string|int, mixed> $aColumnValueMapping[, array<string|int, ObjectDatabaseColumn> $aColumns = array() ]) : bool|mixed
Parameters
- $sTableName : string
- $oSearchFilter : ObjectDatabaseSearchFilter
- $aColumnValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = array()