Permalink
Browse files

Merge pull request #162 from JJK801/filters_doc

Add filters documentation to configuration.rst
  • Loading branch information...
2 parents d355798 + 3c27ed4 commit d29d85217be2d087a9660238c522e0159b9b84f1 @guilhermeblanco guilhermeblanco committed Mar 7, 2013
Showing with 25 additions and 0 deletions.
  1. +25 −0 Resources/doc/configuration.rst
@@ -210,6 +210,31 @@ can control. The following configuration options exist for a mapping:
single: Configuration; Doctrine DBAL
single: Doctrine; DBAL configuration
+Filters Configuration
+~~~~~~~~~~~~~~~~~~~~~
+
+You can easily define `doctrine filters`_ in your configuration file:
+
+.. code-block:: yaml
+
+ doctrine:
+ orm:
+ filters:
+ myFilter:
+ class: MyVendor\MyBundle\Filters\MyFilter
+ enabled: true
+ parameters:
+ myParameter: myValue
+ mySecondParameter: mySecondValue
+
+* ``myFilter:`` Filter identifier (Required)
+* ``class:`` Filter target class (Required)
+* ``enabled:`` Enable/Disable the filter by default (Optional - Default disabled)
+* ``parameters:`` Set default parameters (Optional)
+* ``myParameter: myValue`` Bind the value ``myValue`` to the parameter ``myParameter`` (Optional)
+
+.. _doctrine filters: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/filters.html
+
.. _`reference-dbal-configuration`:
Doctrine DBAL Configuration

0 comments on commit d29d852

Please sign in to comment.