See Also: Writing Registry Plugins and Registry Data Filters
| Info |
|---|
The interface for Data Filter Plugins is experimental and may change across minor releases. |
The name of the plugin should match the format FooFilter.
Data Filter plugins operate within specified contexts. Currently, all Data Filter plugins are invoked in all contexts, though this may change in a future release. The following contexts are defined:
- ProvisioningTarget: Registry Data Filters run prior to provisioning data being passed to Provisioner Plugins.
Each Data Filter plugin must implement the following function in $PLUGIN/Model/FooFilter.php:
| Code Block | ||
|---|---|---|
| ||
public function filter($context, $dataFilterId, $provisioningData) {} |
where
- context:
DataFilterContextEnum(currently will always beProvisioningTarget) - dataFilterId: The ID of the appropriate Data Filter instantiation (ie: cm_data_filters:id)
- provisioningData: An array of provisioning data, in the same format as passed to Provisioner Plugins
The function should return an array of the same form passed in $provisioningData, or throw an Exception on error.