Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add filters documentation to configuration.rst

  • Loading branch information...
commit 75d0892034d752755cc10a6973e03ec79313908f 1 parent d355798
Jérémy Jourdin authored
Showing with 25 additions and 0 deletions.
  1. +25 −0 Resources/doc/configuration.rst
View
25 Resources/doc/configuration.rst
@@ -212,6 +212,31 @@ can control. The following configuration options exist for a mapping:
.. _`reference-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
+
Doctrine DBAL Configuration
---------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.