Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove FilterProviderInterface #205

Open
wants to merge 3 commits into
base: 3.0.x
Choose a base branch
from

Conversation

gsteel
Copy link
Member

@gsteel gsteel commented Dec 4, 2024

This interface is MVC Module Manager specific and does not belong in this library

See #204

@gsteel gsteel added this to the 3.0.0 milestone Dec 4, 2024
@gsteel gsteel mentioned this pull request Dec 4, 2024
54 tasks
@froschdesign
Copy link
Member

The documentation must also be removed:

# Providing Filters via Modules
If you wish to indicate that your laminas-mvc module provides filters, have your `Module` class implement `Laminas\Filter\FilterProviderInterface`, which defines the method:
```php
/**
* @return array
*/
public function getFilterConfig();
```
The method should return an array of configuration following the [laminas-servicemanager configuration format](https://docs.laminas.dev/laminas-servicemanager/configuring-the-service-manager/).
If you are not using laminas-mvc, but are using a dependency injection container (e.g., if you are using Mezzio), you can also provide filters using the top-level `filters` configuration key; the value of that key should be laminas-servicemanager configuration, as linked above.
(laminas-mvc users may also provide configuration in the same way, and omit implementation of the `FilterProviderInterface`.)

This interface is MVC Module Manager specific and does not belong in this library

Signed-off-by: George Steel <[email protected]>
@gsteel gsteel force-pushed the v3/remove-filter-provider-interface branch from fe142b9 to abff8c3 Compare December 4, 2024 22:49
@gsteel
Copy link
Member Author

gsteel commented Dec 4, 2024

The documentation must also be removed:

I've retained and updated the docs to point to the same interface in the Module Manager lib/docs

Comment on lines -10 to -11
* Implement this interface within Module classes to indicate that your module
* provides filter configuration for the FilterPluginManager.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But doesn't this also apply to a config provider? What I mean by that is, wouldn't the interface also help the user in a config provider?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants