See Also: Writing Registry Plugins and Registry Data Filters
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:
As of Registry v4.1.0, Data Filter Plugins must declare which context(s) they support in $PLUGIN/Model/FooFilter.php
:
// The context(s) this filter supports public $supportedContexts = array( DataFilterContextEnum::OrgIdentitySource, DataFilterContextEnum::ProvisioningTarget ); |
Each Data Filter plugin must implement the following function in $PLUGIN/Model/FooFilter.php
:
public function filter($context, $dataFilterId, $data) {} |
where
DataFilterContextEnum
(currently will always be ProvisioningTarget
)$provisioningData
prior to Registry v4.1.0.The function should return an array of the same form passed in $data
, or throw an Exception on error.