DynamicDatabaseRepositoryConfiguration
extends AbstractConfiguration
in package
A Configuration class representing a DynamicDatabaseRepository configuration
Tags
Table of Contents
Properties
- $defaultOrderBy : string|null
- $gettableColumns : array<string|int, string>|null
- $primaryKey : string
- $searchableColumns : array<string|int, string>|null
- $tableName : string
Methods
- __construct() : mixed
- getAllProperties() : array<string, string>
- Returns an array of all the defined properties for the instance
- getDefaultOrderBy() : string|null
- Provides the default column(s) to order queries by
- getGettableColumns() : array<string|int, string>|null
- Provides the columns to SELECT in queries
- getPrimaryKey() : string
- Provides the name of the primary key column
- getSearchableColumns() : array<string|int, string>|null
- Provides the columns to check search terms against in search queries
- getTableName() : string
- Provides the name of the base table
Properties
$defaultOrderBy
protected
string|null
$defaultOrderBy
The column name to sort by for default queries
$gettableColumns
protected
array<string|int, string>|null
$gettableColumns
The column names to include in default queries
$primaryKey
protected
string
$primaryKey
The name of the primary key for the base table
$searchableColumns
protected
array<string|int, string>|null
$searchableColumns
The column names to apply search terms against in search queries
$tableName
protected
string
$tableName
The name of the base table
Methods
__construct()
public
__construct(string $tableName, string $primaryKey[, string|null $defaultOrderBy = null ][, array<string|int, string>|null $gettableColumns = null ][, array<string|int, string>|null $searchableColumns = null ]) : mixed
Parameters
- $tableName : string
-
The name of the base table
- $primaryKey : string
-
The name of the primary key for the base table
- $defaultOrderBy : string|null = null
-
The column name to sort by for default queries. Optional
- $gettableColumns : array<string|int, string>|null = null
-
The column names to include in default queries. Optional
- $searchableColumns : array<string|int, string>|null = null
-
The column names to apply search terms against in search queries. Optional
getAllProperties()
Returns an array of all the defined properties for the instance
public
getAllProperties() : array<string, string>
Return values
array<string, string>getDefaultOrderBy()
Provides the default column(s) to order queries by
public
getDefaultOrderBy() : string|null
Return values
string|nullgetGettableColumns()
Provides the columns to SELECT in queries
public
getGettableColumns() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetPrimaryKey()
Provides the name of the primary key column
public
getPrimaryKey() : string
Return values
string —$primaryKey The name of the primary key column
getSearchableColumns()
Provides the columns to check search terms against in search queries
public
getSearchableColumns() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetTableName()
Provides the name of the base table
public
getTableName() : string
Return values
string —$tableName The name of the base table