contao-community-alliance/dc-general
Back to top  

Interface ConfigInterface.

This interface describes the configuration objects to use when retrieving models and collections from a data provider.

 Methods

Get the additional information.

get(string $strKey) : mixed

Parameters

$strKey

string

The name of the information to retrieve.

Returns

mixed|| null

Get the limit for results.

getAmount() : int
This is the amount of items to return for pagination.

Returns

int

Get the list of fields to be retrieved.

getFields() : array

Returns

array

Get the list with filter options.

getFilter() : array

Returns

array

Get specific id.

getId() : mixed

Returns

mixed

Return flag if only ids should be returned.

getIdOnly() : bool
SuppressWarnings (PHPMD.BooleanGetMethodName)

Returns

bool

Get list of specific ids to be retrieved.

getIds() : array

Returns

array

Get the list of all defined sortings.

getSorting() : array
The returning array will be of 'property name' => 'ASC|DESC' nature.

Returns

array

Get the offset to start with.

getStart() : int
This is the offset to use for pagination.

Returns

int

Static constructor.

init() : mixed
Static
todo : do we want to keep this behaviour? Third party will not know the correct class anyway.

Returns

mixed

Set the additional information.

set(string $strKey, mixed $varValue) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$strKey

string

The name of the information to retrieve.

$varValue

mixed

The value to store.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set the limit for results.

setAmount(int $intAmount) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface
This is the amount of items to return for pagination.

Parameters

$intAmount

int

The amount to use.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set the list of fields to be retrieved.

setFields(array $arrFields) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$arrFields

array

Array of property names.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set the list with filter options.

setFilter(array $arrFilter) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$arrFilter

array

The array containing the filter values.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set a specific id for an element to be retrieved.

setId(mixed $mixId) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$mixId

mixed

The id of the element to be retrieved.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set flag for return id only.

setIdOnly(bool $blnIdOnly) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$blnIdOnly

bool

Boolean flag to determine that only Ids shall be returned when calling fetchAll().

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set list of specific ids to be retrieved.

setIds(array $arrIds) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Parameters

$arrIds

array

The list of ids to be retrieved.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set the list of all defined sortings.

setSorting(array $arrSorting) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface
The array must be of 'property name' => 'ASC|DESC' nature.

Parameters

$arrSorting

array

The sorting array to use.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

Set the offset to start with.

setStart(int $intStart) : \ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface
This is the offset to use for pagination.

Parameters

$intStart

int

Number of first element to return.

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface