Merge branch 'feature/26-filter-provider' into develop

Close #26

Author: weierophinney

CHANGELOG.md

@@ -6,7 +6,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#26](https://github.com/zendframework/zend-filter/pull/26) adds the interface
+  `Zend\Filter\FilterProviderInterface`, which can be used to provide
+  configuration for the `FilterPluginManager` via zend-mvc `Module` classes.
 
 ### Deprecated
 

doc/book/intro.md

@@ -128,3 +128,27 @@ is `My_Original_Content`.
 As you can see it is not always possible to get the original output by using a
 filter which seems to be the opposite. It depends on the filter and also on the
 given input.
+
+## Providing filters via modules
+
+If you wish to indicate that your zend-mvc module provides filters, have your
+`Module` class implement `Zend\Filter\FilterProviderInterface`, which defines
+the method:
+
+```php
+/**
+ * @return array
+ */
+public function getFilterConfig();
+```
+
+The method should return an array of configuration following the
+[zend-servicemanager configuration format](https://docs.zendframework.com/zend-servicemanager/configuring-the-service-manager/).
+
+If you are not using zend-mvc, but are using a dependency injection container
+(e.g., if you are using Expressive), you can also provide filters using the
+top-level `filters` configuration key; the value of that key should be
+zend-servicemanager configuration, as linked above.
+
+(zend-mvc users may also provide configuration in the same way, and omit
+implementation of the `FilterProviderInterface`.)

src/FilterProviderInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-filter for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-filter/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Filter;
+
+/**
+ * Implement this interface within Module classes to indicate that your module
+ * provides filter configuration for the FilterPluginManager.
+ */
+interface FilterProviderInterface
+{
+    /**
+     * Provide plugin manager configuration for filters.
+     *
+     * @return array
+     */
+    public function getFilterConfig();
+}

src/Module.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link      http://github.com/zendframework/zend-filter for the canonical source repository
- * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/zend-filter for the canonical source repository
+ * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-filter/blob/master/LICENSE.md New BSD License
  */
 
 namespace Zend\Filter;
@@ -36,7 +36,7 @@ public function init($moduleManager)
         $serviceListener->addServiceManager(
             'FilterManager',
             'filters',
-            'Zend\ModuleManager\Feature\FilterProviderInterface',
+            FilterProviderInterface::class,
             'getFilterConfig'
         );
     }