Class NoOpDataProvider

Class NoOpDataProvider.

Base implementation of an no operational data provider. This data provider is simply a stub endpoint without any logic at all. It is useful as parent class for drivers that only implement a fraction of all DcGeneral features.

DcGeneral\Data\NoOpDataProvider implements DcGeneral\Data\DataProviderInterface

Namespace: DcGeneral\Data
Package: DcGeneral\Data
Located at Data/NoOpDataProvider.php

Methods summary
`public`	# `setBaseConfig( array $arrConfig )` Set base config with source and other necessary parameter. Set base config with source and other necessary parameter. Parameters `$arrConfig` `array` $arrConfig The configuration to use. Throws `DcGeneralRuntimeException` When no source has been defined. Implementation of `DcGeneral\Data\DataProviderInterface::setBaseConfig()`
`public DcGeneral\Data\ConfigInterface`	# `getEmptyConfig( )` Return an empty configuration object. Return an empty configuration object. Returns `DcGeneral\Data\ConfigInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getEmptyConfig()`
`public DcGeneral\Data\ModelInterface`	# `getEmptyModel( )` Fetch an empty single record (new model). Fetch an empty single record (new model). Returns `DcGeneral\Data\ModelInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getEmptyModel()`
`public DcGeneral\Data\CollectionInterface`	# `getEmptyCollection( )` Fetch an empty single collection (new model list). Fetch an empty single collection (new model list). Returns `DcGeneral\Data\CollectionInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getEmptyCollection()`
`public DcGeneral\Data\ModelInterface`	# `fetch( DcGeneral\Data\ConfigInterface $objConfig )` Fetch a single or first record by id or filter. Fetch a single or first record by id or filter. Parameters `$objConfig` `DcGeneral\Data\ConfigInterface` $objConfig The configuration to use. Returns `DcGeneral\Data\ModelInterface` Implementation of `DcGeneral\Data\DataProviderInterface::fetch()`
`public DcGeneral\Data\CollectionInterface\|array`	# `fetchAll( DcGeneral\Data\ConfigInterface $objConfig )` Fetch all records (optional filtered, sorted and limited). Fetch all records (optional filtered, sorted and limited). Parameters `$objConfig` `DcGeneral\Data\ConfigInterface` $objConfig The configuration to use. Returns `DcGeneral\Data\CollectionInterface\|array` Implementation of `DcGeneral\Data\DataProviderInterface::fetchAll()`
`public DcGeneral\Data\CollectionInterface`	# `getFilterOptions( DcGeneral\Data\ConfigInterface $objConfig )` Retrieve all unique values for the given property. Retrieve all unique values for the given property. Parameters `$objConfig` `DcGeneral\Data\ConfigInterface` $objConfig The filter config options. Returns `DcGeneral\Data\CollectionInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getFilterOptions()`
`public integer`	# `getCount( DcGeneral\Data\ConfigInterface $objConfig )` Return the amount of total items (filtering may be used in the config). Return the amount of total items (filtering may be used in the config). Parameters `$objConfig` `DcGeneral\Data\ConfigInterface` $objConfig The configuration to use. Returns `integer` Implementation of `DcGeneral\Data\DataProviderInterface::getCount()`
`public DcGeneral\Data\ModelInterface`	# `save( DcGeneral\Data\ModelInterface $objItem )` Save an item to the data provider. Save an item to the data provider. Parameters `$objItem` `DcGeneral\Data\ModelInterface` $objItem The model to save back. Returns `DcGeneral\Data\ModelInterface` The passed model. Implementation of `DcGeneral\Data\DataProviderInterface::save()`
`public`	# `saveEach( DcGeneral\Data\CollectionInterface $objItems )` Save a collection of items to the data provider. Save a collection of items to the data provider. Parameters `$objItems` `DcGeneral\Data\CollectionInterface` $objItems The collection containing all items to be saved. Implementation of `DcGeneral\Data\DataProviderInterface::saveEach()`
`public`	# `delete( mixed $item )` Delete an item. Delete an item. Parameters `$item` `mixed` $item Id or the model itself, to delete. Throws `DcGeneralRuntimeException` When an unusable object has been passed. Implementation of `DcGeneral\Data\DataProviderInterface::delete()`
`public`	# `saveVersion( DcGeneral\Data\ModelInterface $objModel, string $strUsername )` Save a new version of a model. Save a new version of a model. Parameters `$objModel` `DcGeneral\Data\ModelInterface` $objModel The model for which a new version shall be created. `$strUsername` `string` $strUsername The username to attach to the version as creator. Implementation of `DcGeneral\Data\DataProviderInterface::saveVersion()`
`public DcGeneral\Data\ModelInterface`	# `getVersion( mixed $mixID, mixed $mixVersion )` Return a model based of the version information. Return a model based of the version information. Parameters `$mixID` `mixed` $mixID The ID of the record. `$mixVersion` `mixed` $mixVersion The ID of the version. Returns `DcGeneral\Data\ModelInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getVersion()`
`public DcGeneral\Data\CollectionInterface`	# `getVersions( mixed $mixID, boolean $blnOnlyActive = false )` Return a list with all versions for the model with the given Id. Return a list with all versions for the model with the given Id. Parameters `$mixID` `mixed` $mixID The ID of the row. `$blnOnlyActive` `boolean` $blnOnlyActive If true, only active versions will get returned, if false all version will get returned. Returns `DcGeneral\Data\CollectionInterface` Implementation of `DcGeneral\Data\DataProviderInterface::getVersions()`
`public`	# `setVersionActive( mixed $mixID, mixed $mixVersion )` Set a version as active. Set a version as active. Parameters `$mixID` `mixed` $mixID The ID of the model. `$mixVersion` `mixed` $mixVersion The version number to set active. Implementation of `DcGeneral\Data\DataProviderInterface::setVersionActive()`
`public mixed`	# `getActiveVersion( mixed $mixID )` Retrieve the current active version for a model. Retrieve the current active version for a model. Parameters `$mixID` `mixed` $mixID The ID of the model. Returns `mixed` The current version number of the requested row. Implementation of `DcGeneral\Data\DataProviderInterface::getActiveVersion()`
`public`	# `resetFallback( string $strField )` Reset the fallback field. Reset the fallback field. Parameters `$strField` `string` $strField The field to reset. Implementation of `DcGeneral\Data\DataProviderInterface::resetFallback()`
`public boolean`	# `isUniqueValue( string $strField, mixed $varNew, integer $intId = null )` Check if the value is unique in the data provider. Check if the value is unique in the data provider. Parameters `$strField` `string` $strField The field in which to test. `$varNew` `mixed` $varNew The value about to be saved. `$intId` `integer` $intId The (optional) id of the item currently in scope - pass null for new items. Documentation: Evaluation - unique => If true the field value cannot be saved if it exists already. Returns `boolean` Implementation of `DcGeneral\Data\DataProviderInterface::isUniqueValue()`
`public boolean`	# `fieldExists( string $strField )` Check if a property with the given name exists in the data provider. Check if a property with the given name exists in the data provider. Parameters `$strField` `string` $strField The name of the property to search. Returns `boolean` Implementation of `DcGeneral\Data\DataProviderInterface::fieldExists()`
`public boolean`	# `sameModels( DcGeneral\Data\ModelInterface $objModel1, DcGeneral\Data\ModelInterface $objModel2 )` Check if two models have the same values in all properties. Check if two models have the same values in all properties. Parameters `$objModel1` `DcGeneral\Data\ModelInterface` $objModel1 The first model to compare. `$objModel2` `DcGeneral\Data\ModelInterface` $objModel2 The second model to compare. Returns `boolean` True - If both models are same, false if not. Implementation of `DcGeneral\Data\DataProviderInterface::sameModels()`

Properties summary
`protected array`	`$arrBaseConfig`		# The configuration data for this instance. The configuration data for this instance.

Namespaces

Classes

Interfaces

Class NoOpDataProvider

Parameters

Throws

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Throws

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of