ObjectDatabase
in package
Tags
Table of Contents
- ERROR_TYPE_EXCEPTION = 1
- ERROR_TYPE_RESULT = 0
- SIZE_DEFAULT_PAGE = 1000
- SIZE_DELETION = 1000
- SIZE_MASS_ACTIONS = 10000
- __callStatic() : mixed
- Redirects method calls to the current database instance object.
- addMultipleColumnsToTable() : ObjectDatabaseResult
- createColumn() : ObjectDatabaseColumn
- createConfiguration() : ObjectDatabaseConfiguration
- createInstance() : ObjectDatabaseInstance
- Returns the object database instance API object.
- createParameter() : ObjectDatabaseParameter
- createResult() : ObjectDatabaseResult
- createSearch() : ObjectDatabaseSearch
- createSearchAggregation() : ObjectDatabaseSearchAggregation
- createSearchFilter() : ObjectDatabaseSearchFilter
- Creates a plain object database filter object.
- createSearchResult() : ObjectDatabaseResult
- createSortOrder() : ObjectDatabaseSortOrder
- createTable() : ObjectDatabaseResult
- Creates the table for a specific name and ObjectDatabaseColumn objects.
- deleteDataFromTable() : ObjectDatabaseResult
- deleteDataFromTableWithSearch() : ObjectDatabaseResult
- dropTable() : ObjectDatabaseResult
- existTableWithName() : bool
- flushTable() : ObjectDatabaseResult
- getColumnType() : string
- getDataCountFromTableWithSearch() : int
- getDataFromTableWithId() : ObjectDatabaseResult
- getDataFromTableWithSearch() : ObjectDatabaseResult
- getDefaultColumnNames() : array<string|int, mixed>
- getErrorType() : int
- getNodesInfo() : ObjectDatabaseResult
- Returns information about the nodes of the elastic search host.
- getQuotedValue() : mixed
- Returns the quoted value based on the column type and the collection type.
- getTableColumns() : array<string|int, ObjectDatabaseColumn>
- getUnquotedValue() : mixed
- Returns the unquoted value based on the column type and the collection type.
- insertDataIntoTable() : bool|mixed
- insertDataIntoTable
- insertMultipleDataIntoTable() : bool|mixed
- insertMultipleDataIntoTable
- isConnected() : bool
- isInstalled() : bool
- reindexTable() : ObjectDatabaseResult
- Re-indexes a table with a given table name.
- setErrorType() : mixed
- throwError() : mixed
- Throws a object database exception for a given message and error code.
- truncateTable() : ObjectDatabaseResult
- updateDataInTable() : ObjectDatabaseResult
- updateDataInTableWithSearchFilter() : ObjectDatabaseResult
- updateDataModel() : bool
- updateDataModelForModuleName() : bool
- updateDataModelForRecord() : bool
Constants
ERROR_TYPE_EXCEPTION
public
mixed
ERROR_TYPE_EXCEPTION
= 1
Tags
ERROR_TYPE_RESULT
public
mixed
ERROR_TYPE_RESULT
= 0
Tags
SIZE_DEFAULT_PAGE
public
mixed
SIZE_DEFAULT_PAGE
= 1000
Tags
SIZE_DELETION
public
mixed
SIZE_DELETION
= 1000
Tags
SIZE_MASS_ACTIONS
public
mixed
SIZE_MASS_ACTIONS
= 10000
Tags
Methods
__callStatic()
Redirects method calls to the current database instance object.
public
static __callStatic(string $sMethodName, array<string|int, mixed> $aArguments) : mixed
Parameters
- $sMethodName : string
- $aArguments : array<string|int, mixed>
Tags
Return values
mixed —addMultipleColumnsToTable()
public
final static addMultipleColumnsToTable(string $sTableName) : ObjectDatabaseResult
Parameters
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —createColumn()
public
final static createColumn(string $sColumnName) : ObjectDatabaseColumn
Parameters
- $sColumnName : string
Tags
Return values
ObjectDatabaseColumn —createConfiguration()
public
final static createConfiguration() : ObjectDatabaseConfiguration
Tags
Return values
ObjectDatabaseConfiguration —createInstance()
Returns the object database instance API object.
public
final static createInstance(ObjectDatabaseConfiguration $oConfiguration) : ObjectDatabaseInstance
Parameters
- $oConfiguration : ObjectDatabaseConfiguration
Tags
Return values
ObjectDatabaseInstance —createParameter()
public
final static createParameter(string $sKey, mixed $mValue) : ObjectDatabaseParameter
Parameters
- $sKey : string
- $mValue : mixed
Tags
Return values
ObjectDatabaseParameter —createResult()
public
final static createResult(array<string|int, mixed> $aResult[, Exception|null $oException = null ]) : ObjectDatabaseResult
Parameters
- $aResult : array<string|int, mixed>
- $oException : Exception|null = null
Tags
Return values
ObjectDatabaseResult —createSearch()
public
final static createSearch() : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseSearch —createSearchAggregation()
public
final static createSearchAggregation() : ObjectDatabaseSearchAggregation
Tags
Return values
ObjectDatabaseSearchAggregation —createSearchFilter()
Creates a plain object database filter object.
public
final static createSearchFilter([int $iType = ObjectDatabaseSearchFilter::TYPE_AND ]) : ObjectDatabaseSearchFilter
Parameters
- $iType : int = ObjectDatabaseSearchFilter::TYPE_AND
Tags
Return values
ObjectDatabaseSearchFilter —createSearchResult()
public
final static createSearchResult(array<string|int, mixed> $aSearchResult[, Exception|null $oException = null ][, ObjectDatabaseSearch $oSearch = null ]) : ObjectDatabaseResult
Parameters
- $aSearchResult : array<string|int, mixed>
- $oException : Exception|null = null
- $oSearch : ObjectDatabaseSearch = null
Tags
Return values
ObjectDatabaseResult —createSortOrder()
public
final static createSortOrder() : ObjectDatabaseSortOrder
Tags
Return values
ObjectDatabaseSortOrder —createTable()
Creates the table for a specific name and ObjectDatabaseColumn objects.
public
final static createTable(string $sTableName[, array<string|int, ObjectDatabaseColumn> $aColumns = [] ][, array<string|int, ObjectDatabaseSettings> $aSettings = [] ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumns : array<string|int, ObjectDatabaseColumn> = []
- $aSettings : array<string|int, ObjectDatabaseSettings> = []
Tags
Return values
ObjectDatabaseResult —deleteDataFromTable()
public
final static deleteDataFromTable(string $sTableName, array<string|int, mixed> $aIds) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aIds : array<string|int, mixed>
Tags
Return values
ObjectDatabaseResult —deleteDataFromTableWithSearch()
public
final static deleteDataFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseResult —dropTable()
public
final static dropTable(string $sTableName) : ObjectDatabaseResult
Parameters
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —existTableWithName()
public
final static existTableWithName(string $sTableName) : bool
Parameters
- $sTableName : string
Tags
Return values
bool —flushTable()
public
final static flushTable(string $sTableName) : ObjectDatabaseResult
Parameters
- $sTableName : string
Tags
Return values
ObjectDatabaseResult —getColumnType()
public
final static getColumnType(string $sColumnName, array<string|int, mixed> $aColumns) : string
Parameters
- $sColumnName : string
- $aColumns : array<string|int, mixed>
Tags
Return values
string —getDataCountFromTableWithSearch()
public
final static getDataCountFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : int
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
int —getDataFromTableWithId()
public
final static getDataFromTableWithId(string $sTableName, string $sId) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $sId : string
Tags
Return values
ObjectDatabaseResult —getDataFromTableWithSearch()
public
final static getDataFromTableWithSearch(string $sTableName, ObjectDatabaseSearch $oSearch) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $oSearch : ObjectDatabaseSearch
Tags
Return values
ObjectDatabaseResult —getDefaultColumnNames()
public
final static getDefaultColumnNames() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getErrorType()
public
final static getErrorType() : int
Tags
Return values
int —getNodesInfo()
Returns information about the nodes of the elastic search host.
public
final static getNodesInfo() : ObjectDatabaseResult
Tags
Return values
ObjectDatabaseResult —getQuotedValue()
Returns the quoted value based on the column type and the collection type.
public
final static 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
final static getTableColumns(mixed $sTableName) : array<string|int, ObjectDatabaseColumn>
Parameters
- $sTableName : mixed
Tags
Return values
array<string|int, ObjectDatabaseColumn> —getUnquotedValue()
Returns the unquoted value based on the column type and the collection type.
public
final static 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
final static insertDataIntoTable(string $sTableName, array<string|int, mixed> $aFieldValueMapping[, array<string|int, ObjectDatabaseColumn> $aColumns = [] ]) : bool|mixed
Parameters
- $sTableName : string
- $aFieldValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = []
Tags
Return values
bool|mixed —insertMultipleDataIntoTable()
insertMultipleDataIntoTable
public
final static insertMultipleDataIntoTable(string $sTableName, array<string|int, mixed> $aMultipleData[, array<string|int, ObjectDatabaseColumn> $aColumns = [] ]) : bool|mixed
Parameters
- $sTableName : string
- $aMultipleData : array<string|int, mixed>
- $aColumns : array<string|int, ObjectDatabaseColumn> = []
Tags
Return values
bool|mixed —isConnected()
public
final static isConnected() : bool
Tags
Return values
bool —isInstalled()
public
final static isInstalled() : bool
Tags
Return values
bool —reindexTable()
Re-indexes a table with a given table name.
public
final static 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 —setErrorType()
public
final static setErrorType([int $iErrorType = self::ERROR_TYPE_RESULT ]) : mixed
Parameters
- $iErrorType : int = self::ERROR_TYPE_RESULT
Tags
Return values
mixed —throwError()
Throws a object database exception for a given message and error code.
public
final static throwError(string $sMessage, int $iErrorCode) : mixed
Parameters
- $sMessage : string
-
The message for the object database exception.
- $iErrorCode : int
-
The error code for the object database exception.
Tags
Return values
mixed —truncateTable()
public
final static 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 —updateDataInTable()
public
final static updateDataInTable(string $sTableName, array<string|int, mixed> $aColumnValueMapping[, array<string|int, mixed> $aColumns = [] ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $aColumnValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, mixed> = []
Tags
Return values
ObjectDatabaseResult —updateDataInTableWithSearchFilter()
public
final static updateDataInTableWithSearchFilter(string $sTableName, ObjectDatabaseSearchFilter $objectDatabaseSearchFilter, array<string|int, mixed> $aColumnValueMapping[, array<string|int, mixed> $aColumns = [] ]) : ObjectDatabaseResult
Parameters
- $sTableName : string
- $objectDatabaseSearchFilter : ObjectDatabaseSearchFilter
- $aColumnValueMapping : array<string|int, mixed>
- $aColumns : array<string|int, mixed> = []
Tags
Return values
ObjectDatabaseResult —updateDataModel()
public
final static updateDataModel([bool $bShowProcessOutput = false ]) : bool
Parameters
- $bShowProcessOutput : bool = false
Tags
Return values
bool —updateDataModelForModuleName()
public
final static updateDataModelForModuleName(string $sModuleName[, bool $bShowProcessOutput = false ]) : bool
Parameters
- $sModuleName : string
- $bShowProcessOutput : bool = false
Tags
Return values
bool —updateDataModelForRecord()
public
final static updateDataModelForRecord(ObjectDatabaseRecord $oTableRecord[, mixed $bShowProcessOutput = false ]) : bool
Parameters
- $oTableRecord : ObjectDatabaseRecord
- $bShowProcessOutput : mixed = false