Class TableRowsAsRecordsDataProvider.
This data provider allows to map multiple rows of a SQL table into a single model for usage in a MultiColumnWizard.
Methods
Unsupported in this data provider, throws an Exception.
delete(mixed $item) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Fetch a single record by id.
fetch(\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface $objConfig) : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface
This data provider only supports retrieving by id so use $objConfig->setId() to populate the config with an Id.
Parameters
Exceptions
Returns
Unsupported in this data provider, throws an Exception.
fetchAll(\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface $objConfig) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Check if the property exists in the table.
fieldExists(string $strField) : boolean
This data provider only returns true for the tstamp property.
Parameters
$strField
stringThe name of the property to check.
Returns
boolean
Unsupported in this data provider, throws an Exception.
getActiveVersion(mixed $mixID) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
getCount(\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface $objConfig) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
getVersion(mixed $mixID, mixed $mixVersion) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Return null as versioning is not supported in this data provider.
getVersions(mixed $mixID, boolean $blnOnlyActive) : null
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
$blnOnlyActive
booleanUnused.
Returns
null
Unsupported in this data provider, throws an Exception.
isUniqueValue(string $strField, mixed $varNew, int $intId) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
resetFallback(string $strField) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
sameModels(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objModel1, \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objModel2) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Save a model to the database.
save(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objItem, bool $recursive) : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface
In general, this method fetches the solely property "rows" from the model and updates the local table against
these contents.
The parent id (id of the model) will get checked and reflected also for new items.
When rows with duplicate ids are encountered (like from MCW for example), the dupes are inserted as new rows.
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
$recursive
boolIgnored as not relevant in this data provider.
Exceptions
Returns
Unsupported in this data provider, throws an Exception.
saveEach(\ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface $objItems) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
saveVersion(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $objModel, string $strUsername) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
$strUsername
stringUnused.
Exceptions
Set base config with source and other necessary parameter.
setBaseConfig(array $arrConfig) : void
Parameters
$arrConfig
arrayThe configuration to use.
Exceptions
Unsupported in this data provider, throws an Exception.
setVersionActive(mixed $mixID, mixed $mixVersion) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
Exceptions
Unsupported in this data provider, throws an Exception.
insertUndo(string $strSourceSQL, string $strSaveSQL, string $strTable) : void
| SuppressWarnings |
(PHPMD.UnusedFormalParameter) |
Parameters
$strSourceSQL
stringUnused.
$strSaveSQL
stringUnused.
Exceptions
Exception throwing convenience method.
youShouldNotCallMe(string $strMethod) : void
Convenience method in this data provider that simply throws an Exception stating that the passed method name
should not be called on this data provider, as it is only intended to display an edit mask.
Parameters
$strMethod
stringThe name of the method being called.
Exceptions
Properties
Grouping column to use to tie rows together.
$strGroupCol : string
Sorting column to sort the entries by.
$strSortCol : string