[FrameworkBundle] Expose configuration of PropertyAccess

Author: lyrixx

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * Added `Controller::isCsrfTokenValid` helper
+ * Added configuration for the PropertyAccess component
 
 2.5.0
 -----

DependencyInjection/Configuration.php

@@ -92,6 +92,7 @@ public function getConfigTreeBuilder()
         $this->addValidationSection($rootNode);
         $this->addAnnotationsSection($rootNode);
         $this->addSerializerSection($rootNode);
+        $this->addPropertyAccessSection($rootNode);
 
         return $treeBuilder;
     }
@@ -524,4 +525,20 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
             ->end()
         ;
     }
+
+    private function addPropertyAccessSection(ArrayNodeDefinition $rootNode)
+    {
+        $rootNode
+            ->children()
+                ->arrayNode('property_access')
+                    ->addDefaultsIfNotSet()
+                    ->info('Property access configuration')
+                    ->children()
+                        ->booleanNode('magic_call')->defaultFalse()->end()
+                        ->booleanNode('throw_exception_on_invalid_index')->defaultFalse()->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+    }
 }

DependencyInjection/FrameworkExtension.php

@@ -133,6 +133,8 @@ public function load(array $configs, ContainerBuilder $container)
 
         $this->registerAnnotationsConfiguration($config['annotations'], $container, $loader);
 
+        $this->registerPropertyAccessConfiguration($config['property_access'], $container);
+
         if (isset($config['serializer']) && $config['serializer']['enabled']) {
             $loader->load('serializer.xml');
         }
@@ -818,6 +820,15 @@ private function registerAnnotationsConfiguration(array $config, ContainerBuilde
         }
     }
 
+    private function registerPropertyAccessConfiguration(array $config, ContainerBuilder $container)
+    {
+        $container
+            ->getDefinition('property_accessor')
+            ->replaceArgument(0, $config['magic_call'])
+            ->replaceArgument(1, $config['throw_exception_on_invalid_index'])
+        ;
+    }
+
     /**
      * Loads the security configuration.
      *

Resources/config/property_access.xml

@@ -9,6 +9,9 @@
     </parameters>
 
     <services>
-        <service id="property_accessor" class="%property_accessor.class%" />
+        <service id="property_accessor" class="%property_accessor.class%" >
+            <argument /> <!-- magicCall, set by the extension -->
+            <argument /> <!-- throwExceptionOnInvalidIndex, set by the extension -->
+        </service>
     </services>
 </container>

Resources/config/schema/symfony-1.0.xsd

@@ -30,6 +30,7 @@
             <xsd:element name="translator" type="translator" minOccurs="0" maxOccurs="1" />
             <xsd:element name="validation" type="validation" minOccurs="0" maxOccurs="1" />
             <xsd:element name="annotations" type="annotations" minOccurs="0" maxOccurs="1" />
+            <xsd:element name="property-access" type="property_access" minOccurs="0" maxOccurs="1" />
         </xsd:all>
 
         <xsd:attribute name="http-method-override" type="xsd:boolean" />
@@ -177,4 +178,9 @@
         <xsd:attribute name="debug" type="xsd:string" />
         <xsd:attribute name="file-cache-dir" type="xsd:string" />
     </xsd:complexType>
+
+    <xsd:complexType name="property_access">
+        <xsd:attribute name="magic-call" type="xsd:boolean" />
+        <xsd:attribute name="throw-exception-on-invalid-index" type="xsd:boolean" />
+    </xsd:complexType>
 </xsd:schema>

Tests/DependencyInjection/ConfigurationTest.php

@@ -139,7 +139,11 @@ protected static function getBundleDefaultConfig()
             ),
             'serializer'          => array(
                 'enabled' => false
-            )
+            ),
+            'property_access' => array(
+                'magic_call' => false,
+                'throw_exception_on_invalid_index' => false,
+            ),
         );
     }
 }

Tests/DependencyInjection/Fixtures/php/property_accessor.php

@@ -0,0 +1,8 @@
+<?php
+
+$container->loadFromExtension('framework', array(
+    'property_access' => array(
+        'magic_call' => true,
+        'throw_exception_on_invalid_index' => true,
+    ),
+));

Tests/DependencyInjection/Fixtures/xml/property_accessor.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config>
+        <framework:property-access magic-call="true" throw-exception-on-invalid-index="true" />
+    </framework:config>
+</container>

Tests/DependencyInjection/Fixtures/yml/property_accessor.yml

@@ -0,0 +1,4 @@
+framework:
+    property_access:
+        magic_call: true
+        throw_exception_on_invalid_index: true

Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -34,6 +34,23 @@ public function testCsrfProtection()
         $this->assertEquals('%form.type_extension.csrf.field_name%', $def->getArgument(2));
     }
 
+    public function testPropertyAccessWithDefaultValue()
+    {
+        $container = $this->createContainerFromFile('full');
+
+        $def = $container->getDefinition('property_accessor');
+        $this->assertEquals(false, $def->getArgument(0));
+        $this->assertEquals(false, $def->getArgument(1));
+    }
+
+    public function testPropertyAccessWithOverriddenValues()
+    {
+        $container = $this->createContainerFromFile('property_accessor');
+        $def = $container->getDefinition('property_accessor');
+        $this->assertEquals(true, $def->getArgument(0));
+        $this->assertEquals(true, $def->getArgument(1));
+    }
+
     /**
      * @expectedException \LogicException
      * @expectedExceptionMessage CSRF protection needs sessions to be enabled.