...
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:
- OrgIdentitySource: Registry Data Filters run when the Organizational Identity Source record is retrieved from the source and converted to a Registry Organizational Identity. Available in Registry v4.1.0.
- ProvisioningTarget: Registry Data Filters run prior to provisioning data being passed to Provisioner Plugins.
...
Code Block | ||
---|---|---|
| ||
public function filter($context, $dataFilterId, $provisioningData$data) {} |
where
- context:
DataFilterContextEnum
(currently will always beProvisioningTarget
) - dataFilterId: The ID of the appropriate Data Filter instantiation (ie: cm_data_filters:id)
- provisioningDatadata: An array of provisioning data to be filtered, depending on the context
- OrgIdentitySource: Org Identity data
- ProvisioningTarget: Provisioning data, in the same format as passed to Provisioner Plugins
- This field was called
$provisioningData
prior to Registry v4.1.0.
The function should return an array of the same form passed in $provisioningData
$data
, or throw an Exception on error.