The "property" option is deprecated in ecommit_javascript_jqueryautocompleteentityajax, ecommit_javascript_select2entityajax and ecommit_javascript_tokeninputentitiesajax. Use "choice_label" instead

Author: hlecorche

Form/DataTransformer/Entity/AbstractEntityTransformer.php

@@ -88,7 +88,7 @@ protected function extractLabel($object)
         } elseif (method_exists($object, '__toString')) {
             return (string)$object;
         } else {
-            throw new \Exception('"property" option or "__toString" method must be defined"');
+            throw new \Exception('"choice_label" option or "__toString" method must be defined"');
         }
     }
 }

Form/Type/EntityNormalizerTrait.php

@@ -96,7 +96,17 @@ public function addCommonDefaultOptions(OptionsResolver $resolver, ManagerRegist
                 'em' => null,
                 'query_builder' => null,
                 'identifier' => null,
-                'property' => null,
+                'property' => null, // deprecated since 2.2, use "choice_label"
+                'choice_label' => function (Options $options) {
+                    // BC with the "property" option
+                    if ($options['property']) {
+                        trigger_error('The "property" option is deprecated since version 2.2. Use "choice_label" instead.', E_USER_DEPRECATED);
+
+                        return $options['property'];
+                    }
+
+                    return null;
+                },
                 'min_chars' => 1,
                 'route_name' => null,
                 'route_params' => array(),

Form/Type/JqueryAutocompleteEntityAjaxType.php

@@ -69,7 +69,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             new EntityToArrayTransformer(
                 $options['query_builder'],
                 $options['identifier'],
-                $options['property']
+                $options['choice_label']
             )
         );
     }

Form/Type/Select2/Select2EntityAjaxType.php

@@ -78,7 +78,7 @@ protected function multipleAddTransformers(FormBuilderInterface $builder, array
             new EntitiesToJsonTransformer(
                 $options['query_builder'],
                 $options['identifier'],
-                $options['property'],
+                $options['choice_label'],
                 'key',
                 'label',
                 $options['max'],
@@ -121,9 +121,9 @@ public function buildView(FormView $view, FormInterface $form, array $options)
 
         $dataSelected = '';
         if (!$options['multiple'] && $options['input'] == 'entity' && $form->getData() && is_object($form->getData())) {
-            $dataSelected = $this->extractLabel($form->getData(), $options['property']);
+            $dataSelected = $this->extractLabel($form->getData(), $options['choice_label']);
         } elseif (!$options['multiple'] && $options['input'] == 'key' && $form->getNormData() && is_object($form->getNormData())) {
-            $dataSelected = $this->extractLabel($form->getNormData(), $options['property']);
+            $dataSelected = $this->extractLabel($form->getNormData(), $options['choice_label']);
         }
 
         $view->vars['url'] = $options['url'];
@@ -148,7 +148,7 @@ protected function extractLabel($object, $property)
         } elseif (method_exists($object, '__toString')) {
             return (string)$object;
         } else {
-            throw new \Exception('"property" option or "__toString" method must be defined"');
+            throw new \Exception('"choice_label" option or "__toString" method must be defined"');
         }
     }
 

Form/Type/TokenInputEntitiesAjaxType.php

@@ -66,7 +66,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             new EntitiesToJsonTransformer(
                 $options['query_builder'],
                 $options['identifier'],
-                $options['property'],
+                $options['choice_label'],
                 'id',
                 'name',
                 $options['max'],