Methods summary
private
|
#
__construct( )
Create object.
Private as only the data provider shall know how to instantiate.
|
public static
DcGeneral\Data\ConfigInterface
|
#
init( )
Static constructor.
Returns
Todo:
do we want to keep this behaviour? Third party will not know the correct class
anyway.
Implementation of
|
public
mixed
|
#
getId( )
Get specific id.
Returns
mixed
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setId( mixed $mixId )
Set a specific id for an element to be retrieved.
Set a specific id for an element to be retrieved.
Parameters
- $mixId
mixed
$mixId The id of the element to be retrieved. Returns
Implementation of
|
public
array
|
#
getIds( )
Get list of specific ids to be retrieved.
Get list of specific ids to be retrieved.
Returns
array
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setIds( array $arrIds )
Set list of specific ids to be retrieved.
Set list of specific ids to be retrieved.
Parameters
- $arrIds
array
$arrIds The list of ids to be retrieved. Returns
Implementation of
|
public
boolean
|
#
getIdOnly( )
Return flag if only ids should be returned.
Return flag if only ids should be returned.
Returns
boolean
Implementation of
|
public
boolean
|
#
setIdOnly( boolean $blnIdOnly )
Set flag for return id only.
Set flag for return id only.
Parameters
- $blnIdOnly
boolean
$blnIdOnly Boolean flag to determine that only Ids shall be returned when
calling fetchAll(). Returns
boolean
Implementation of
|
public
integer
|
#
getStart( )
Get the offset to start with.
Get the offset to start with.
This is the offset to use for pagination.
Returns
integer
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setStart( integer $intStart )
Set the offset to start with.
Set the offset to start with.
This is the offset to use for pagination.
Parameters
- $intStart
integer
$intStart Number of first element to return. Returns
Implementation of
|
public
integer
|
#
getAmount( )
Get the limit for results.
Get the limit for results.
This is the amount of items to return for pagination.
Returns
integer
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setAmount( integer $intAmount )
Set the limit for results.
Set the limit for results.
This is the amount of items to return for pagination.
Parameters
- $intAmount
integer
$intAmount The amount to use. Returns
Implementation of
|
public
array
|
#
getFilter( )
Get the list with filter options.
Get the list with filter options.
Returns
array
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setFilter( array $arrFilter )
Set the list with filter options.
Set the list with filter options.
Parameters
- $arrFilter
array
$arrFilter The array containing the filter values. Returns
Implementation of
|
public
array
|
#
getSorting( )
Get the list of all defined sortings.
Get the list of all defined sortings.
The returning array will be of 'property name' => 'ASC|DESC' nature.
Returns
array
Implementation of
|
public
array
|
#
setSorting( array $arrSorting )
Set the list of all defined sortings.
Set the list of all defined sortings.
The array must be of 'property name' => 'ASC|DESC' nature.
Parameters
- $arrSorting
array
$arrSorting The sorting array to use. Returns
array
Implementation of
|
public
array
|
#
getFields( )
Get the list of fields to be retrieved.
Get the list of fields to be retrieved.
Returns
array
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
setFields( array $arrFields )
Set the list of fields to be retrieved.
Set the list of fields to be retrieved.
Parameters
- $arrFields
array
$arrFields Array of property names. Returns
Implementation of
|
public
mixed
|
#
get( string $strKey )
Get the additional information.
Get the additional information.
Parameters
- $strKey
string
$strKey The name of the information to retrieve. Returns
mixed
|| null
Implementation of
|
public
DcGeneral\Data\ConfigInterface
|
#
set( string $strKey, mixed $varValue )
Set the additional information.
Set the additional information.
Parameters
- $strKey
string
$strKey The name of the information to retrieve.- $varValue
mixed
$varValue The value to store. Returns
Implementation of
|
Properties summary
protected
mixed
|
$mixId
|
null |
#
The id of the element to be retrieved.
The id of the element to be retrieved.
|
protected
array
|
$arrIds
|
array() |
|
protected
boolean
|
$blnIdOnly
|
false |
#
Flag determining if only the ids shall get fetched or models.
Flag determining if only the ids shall get fetched or models.
See
fetch
|
protected
integer
|
$intStart
|
0 |
#
Offset for retrieving entries.
Offset for retrieving entries.
|
protected
integer
|
$intAmount
|
0 |
#
Amount of entries to be retrieved.
Amount of entries to be retrieved.
|
protected
array|null
|
$arrFilter
|
null |
|
protected
array(string
|
$arrSorting
|
array() |
#
The properties to use for sorting.
The properties to use for sorting.
|
protected
array|null
|
$arrFields
|
null |
#
The properties to retrieve.
The properties to retrieve.
|
protected
array
|
$arrData
|
array() |
#
Miscellaneous arbitrary data stored in the config.
Miscellaneous arbitrary data stored in the config.
See
|