Enabling filter's default parameters in config files #159

JJK801 · 2013-02-25T10:02:43Z

Hi stof,

This update is comming from troubles we had to set a filter parameter at the application start, it enable default values in the config files without breaking older configs.

Jérémy

stof · 2013-02-25T10:31:25Z

ManagerConfigurator.php

@@ -60,7 +62,28 @@ private function enableFilters(EntityManager $entityManager)

        $filterCollection = $entityManager->getFilters();
        foreach ($this->enabledFilters as $filter) {
-            $filterCollection->enable($filter);
+            $oFilter = $filterCollection->enable($filter);


Why oFilter ?

$filter is the filter name and $oFilter the filter object, is it a problem?

we are not using the o*, s* convention to name variable starting with their type. So it is weird to have it used in a single place.

ok, $filterObject sounds better?

stof · 2013-02-25T10:32:35Z

Resources/config/schema/doctrine-1.0.xsd

+            <xsd:element name="parameters" type="parameters" minOccurs="0" maxOccurs="1" />
+        </xsd:choice>
+        <xsd:attribute name="name" type="xsd:string" use="required" />
+        <xsd:attribute name="class" type="xsd:string" />


This is a BC break for XML users

I've run some tests and seems good with class as node value as the current config

yeah, I missed mixed="true"

stof · 2013-02-25T10:33:15Z

Tests/DependencyInjection/Fixtures/config/xml/orm_filters.xml

+            <filter name="myFilter" enabled="true" class="Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\TestFilter">
+                <parameters>
+                    <parameter name="myParameter">myValue</parameter>
+                </parameters>


It should not look this way in XML but several <parameter> tags

stof · 2013-02-25T10:35:14Z

your XML configuration will not work(try to put at lest 2 parameters) as it is not how prototype nodes should be represented.

stof · 2013-02-25T10:39:59Z

ManagerConfigurator.php

+    /**
+     * Enable filters for an given entity manager
+     *
+     * @param EntityManager $entityManager


This is wrong

oh yes, i missed that...

JJK801 · 2013-02-25T13:05:29Z

This will fix previouly said bad things

stof · 2013-02-25T18:25:00Z

ManagerConfigurator.php

@@ -60,7 +62,28 @@ private function enableFilters(EntityManager $entityManager)

        $filterCollection = $entityManager->getFilters();
        foreach ($this->enabledFilters as $filter) {
-            $filterCollection->enable($filter);
+            $filterObject = $filterCollection->enable($filter);
+            if( null !== $filterObject ) {


spaces should be around the braces, not inside them

ok, i will fix it

stof · 2013-02-25T18:25:53Z

ManagerConfigurator.php

+     * Set defaults parameters for a given filter
+     *
+     * @param string $name Filter name
+     * @param object $filter Filter object


instead of object, it would be better to use SQLFilter as it is the actual requirement (I would even typehint it)

I was not sure SQLFilter is a requirement, so i'm going to implement it

stof · 2013-02-25T18:27:08Z

Tests/DependencyInjection/AbstractDoctrineExtensionTest.php

+        foreach ($calls as $call) {
+            if ($call[0] == $methodName) {
+                if ($called > $nbCalls) { break; }
+                else {


Please follow the Symfony2 CS

Ok sorry, my CS may be a little bit outdated :/

stof · 2013-02-25T18:29:05Z

Tests/DependencyInjection/AbstractDoctrineExtensionTest.php

+            } else {
+                $this->fail("Method '".$methodName."' is expected to be called ". $nbCalls ." time, definition contain ". $called ." calls.");
+            }
+        }


I would replace all this with

$this->assertEquals($nbCalls, $call, sprintf('The method "%s" should be called %d times', $methodName, $nbCalls));

my first choice was similar but i changed it to get the same model as assertDICDefinitionMethodCallOnce, but you're right, this solution is much better

stof · 2013-02-25T18:30:11Z

Tests/DependencyInjection/AbstractDoctrineExtensionTest.php

+            if ($call[0] == $methodName) {
+                if ($called > $nbCalls) { break; }
+                else {
+                    if ($params[$called] !== null) {


what if it is not set ?

:/ lets fix it ;)

stof · 2013-02-26T02:03:15Z

ManagerConfigurator.php

@@ -15,6 +15,7 @@
 namespace Doctrine\Bundle\DoctrineBundle;

 use Doctrine\ORM\EntityManager;
+use  Doctrine\ORM\Query\Filter\SQLFilter;


there is an extra space here

stof · 2013-02-26T02:03:41Z

ManagerConfigurator.php

+     */
+    private function setFilterParameters($name, SQLFilter $filter)
+    {
+        if( !empty($this->filtersParameters[$name]) ) {


space spacing issue several times in this method

stof · 2013-02-26T02:04:23Z

Tests/DependencyInjection/AbstractDoctrineExtensionTest.php

+            if ($call[0] == $methodName) {
+                if ($called > $nbCalls) {
+                    break;
+                } else {


no need to use else as you are breaking the loop in the if

intel352 · 2013-03-03T04:30:46Z

+1 -- I need this functionality as well (ability to set parameters for filters within config).

omansour · 2013-03-04T09:02:11Z

👍 we need this PR at work

Enabling filter's default parameters in config files

trsteel88 · 2013-07-14T09:27:53Z

Is there a way to use the service container to inject a value?

Eg, I have a Site Context and I want to use the SiteId from that Entity.

May relate to #134

Jérémy JOURDIN added 3 commits Feb 22, 2013

Added default parameters for query filters

8610564

XML Configuration support update + Tests update

12cab9a

XML Configuration support update + Tests update

Loading status checks…

78d8c10

stof reviewed Feb 25, 2013
View changes

Jérémy JOURDIN added 2 commits Feb 25, 2013

Fixs from pull request comments

Loading status checks…

eab53d0

Fixs from pull request comments

Loading status checks…

4ea05ac

stof reviewed Feb 25, 2013
View changes

Fix coding standards and some mistakes

Loading status checks…

6432345

stof reviewed Feb 26, 2013
View changes

ManagerConfigurator.php Outdated

@@ -15,6 +15,7 @@

namespace Doctrine\Bundle\DoctrineBundle;

use Doctrine\ORM\EntityManager;

use Doctrine\ORM\Query\Filter\SQLFilter;

This comment has been minimized.

Sign in to view

stof Feb 26, 2013
Member

there is an extra space here

stof reviewed Feb 26, 2013
View changes

ManagerConfigurator.php Outdated

*/

private function setFilterParameters($name, SQLFilter $filter)

{

if( !empty($this->filtersParameters[$name]) ) {

This comment has been minimized.

Sign in to view

stof Feb 26, 2013
Member

space spacing issue several times in this method

stof reviewed Feb 26, 2013
View changes

Tests/DependencyInjection/AbstractDoctrineExtensionTest.php Outdated

if ($call[0] == $methodName) {

if ($called > $nbCalls) {

break;

} else {

This comment has been minimized.

Sign in to view

stof Feb 26, 2013
Member

no need to use else as you are breaking the loop in the if

Removing some unexpected spaces

Loading status checks…

35b3043

stof added a commit that referenced this pull request Mar 5, 2013

Merge pull request #159 from JJK801/filters

Loading status checks…

d355798

Enabling filter's default parameters in config files

stof merged commit d355798 into doctrine:master Mar 5, 2013
1 check passed

1 check passed

default The Travis build passed
Details

JJK801 deleted the JJK801:filters branch Mar 6, 2013

doctrine / DoctrineBundle

Enabling filter's default parameters in config files #159

Enabling filter's default parameters in config files #159

JJK801 commented Feb 25, 2013

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

stof commented Feb 25, 2013

This comment has been minimized.

This comment has been minimized.

JJK801 commented Feb 25, 2013

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

intel352 commented Mar 3, 2013

omansour commented Mar 4, 2013

trsteel88 commented Jul 14, 2013

doctrine / DoctrineBundle

Sponsor doctrine/DoctrineBundle

Enabling filter's default parameters in config files #159

Enabling filter's default parameters in config files #159

Conversation

JJK801 commented Feb 25, 2013

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

stof commented Feb 25, 2013

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

JJK801 commented Feb 25, 2013

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 25, 2013 Member

This comment has been minimized.

JJK801 Feb 25, 2013 Author

This comment has been minimized.

stof Feb 26, 2013 Member

This comment has been minimized.

stof Feb 26, 2013 Member

This comment has been minimized.

stof Feb 26, 2013 Member

intel352 commented Mar 3, 2013

omansour commented Mar 4, 2013

trsteel88 commented Jul 14, 2013

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 25, 2013
Member

JJK801 Feb 25, 2013
Author

stof Feb 26, 2013
Member

stof Feb 26, 2013
Member

stof Feb 26, 2013
Member