Skip to content

Loading…

Add filters documentation to configuration.rst #162

Merged
merged 2 commits into from

3 participants

@JJK801

No description provided.

@stof stof commented on an outdated diff
Resources/doc/configuration.rst
@@ -212,6 +212,31 @@ can control. The following configuration options exist for a mapping:
.. _`reference-dbal-configuration`:
@stof Doctrine member
stof added a note

This should be kept above the related title

@JJK801
JJK801 added a note

Sorry, copy/paste mistake...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@guilhermeblanco guilhermeblanco merged commit d29d852 into doctrine:master

1 check passed

Details default The Travis build passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 6, 2013
  1. Add filters documentation to configuration.rst

    Jérémy Jourdin committed
  2. Add filters documentation to configuration.rst

    Jérémy Jourdin committed
This page is out of date. Refresh to see the latest.
Showing with 25 additions and 0 deletions.
  1. +25 −0 Resources/doc/configuration.rst
View
25 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
Something went wrong with that request. Please try again.