Merge remote-tracking branch 'origin/3.x'

sonata-project · Jul 2, 2020 · 4386d7d · 4386d7d
2 parents 75c36b6 + af25c1c
commit 4386d7d
Show file tree

Hide file tree

Showing 19 changed files with 309 additions and 76 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -1,3 +1,7 @@
+# DO NOT EDIT THIS FILE!
+#
+# It's auto-generated by sonata-project/dev-kit package.
+
 on:
     push:
         paths:
@@ -31,7 +35,7 @@ jobs:
               run: sudo apt-get install python-dev build-essential
 
             - name: "Cache pip"
-              uses: actions/cache@v1
+              uses: actions/cache@v2
               with:
                   path: ~/.cache/pip
                   key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,39 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.20.0](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/compare/3.19.0...3.20.0) - 2020-06-30
+### Added
+- [[#1057](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1057)]
+  Add `StringFilter` support for `START_WITH` and `END_WITH` operator
+([@napestershine](https://github.com/napestershine))
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)]
+  Added `FieldDescription::getTargetModel()`.
+([@phansys](https://github.com/phansys))
+
+### Deprecated
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)] Deprecated passing `null` as argument 2 for `ModelManager::find()`; ([@phansys](https://github.com/phansys))
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)] Deprecated passing `null` as argument 1 for `ModelManager::getNormalizedIdentifier()`; ([@phansys](https://github.com/phansys))
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)] Deprecated passing objects which are in state 2 (new) or 4 (removed) as argument 1 for `ModelManager::getNormalizedIdentifier()`; ([@phansys](https://github.com/phansys))
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)] Deprecated passing other type than `object` as argument 1 for `ModelManager::getUrlSafeIdentifier()`; ([@phansys](https://github.com/phansys))
+- [[#1049](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1049)] Deprecated `FieldDescription::getTargetEntity()` in favor of `FieldDescription::getTargetModel()`. ([@phansys](https://github.com/phansys))
+
+## [3.19.0](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/compare/3.18.0...3.19.0) - 2020-06-26
+### Changed
+- [[#1055](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1055)]
+  `decimal` and `float` type use the `float` template if no `number` template
+exists ([@VincentLanglet](https://github.com/VincentLanglet))
+
+### Fixed
+- [[#1055](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1055)]
+  `one_to_one`, `one_to_many`, `many_to_one` and `many_to_many` type are
+correctly using the template defined in your config instead of the Sonata one.
+([@VincentLanglet](https://github.com/VincentLanglet))
+
+### Removed
+- [[#1048](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/pull/1048)]
+  Remove SonataCoreBundle dependencies
+([@wbloszyk](https://github.com/wbloszyk))
+
 ## [3.18.0](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/compare/3.17.1...3.18.0) - 2020-06-02
 ### Added
 - Added direct dependency against "twig/twig".

diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md
@@ -1,11 +1,24 @@
 UPGRADE 3.x
 ===========
 
+UPGRADE FROM 3.19 to 3.20
+=========================
+
+### Sonata\DoctrineORMAdminBundle\Admin\FieldDescription
+
+Deprecated `getTargetEntity()`, use `getTargetModel()` instead.
+
+### Sonata\DoctrineORMAdminBundle\Model\ModelManager
+
+Deprecated passing `null` as argument 2 for `find()`.
+Deprecated passing `null` or an object which is in state new or removed as argument 1 for `getNormalizedIdentifier()`.
+Deprecated passing `null` as argument 1 for `getUrlSafeIdentifier()`.
+
 UPGRADE FROM 3.0 to 3.1
 =======================
 
 ### Tests
 
-All files under the ``Tests`` directory are now correctly handled as internal test classes. 
-You can't extend them anymore, because they are only loaded when running internal tests. 
+All files under the ``Tests`` directory are now correctly handled as internal test classes.
+You can't extend them anymore, because they are only loaded when running internal tests.
 More information can be found in the [composer docs](https://getcomposer.org/doc/04-schema.md#autoload-dev).
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
         "doctrine/doctrine-bundle": "^1.8 || ^2.0",
         "doctrine/orm": "^2.5",
         "doctrine/persistence": "^1.3.4",
-        "sonata-project/admin-bundle": "^3.63",
+        "sonata-project/admin-bundle": "^3.71",
         "sonata-project/exporter": "^1.11.0 || ^2.0",
         "sonata-project/form-extensions": "^0.1 || ^1.4",
         "symfony/config": "^4.4",
@@ -44,7 +44,8 @@
     },
     "conflict": {
         "simplethings/entity-audit-bundle": ">=2.0",
-        "sonata-project/block-bundle": "<3.11"
+        "sonata-project/block-bundle": "<3.11",
+        "sonata-project/core-bundle": "<3.20"
     },
     "provide": {
         "sonata-project/admin-bundle-persistency-layer": "1.0.0"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,6 @@
-Sphinx!=1.8.0
+# DO NOT EDIT THIS FILE!
+#
+# It's auto-generated by sonata-project/dev-kit package.
+Sphinx==1.8.5
 git+https://github.com/fabpot/sphinx-php.git
 sphinx_rtd_theme
diff --git a/src/Admin/FieldDescription.php b/src/Admin/FieldDescription.php
@@ -35,11 +35,33 @@ public function setAssociationMapping($associationMapping): void
         $this->fieldName = $associationMapping['fieldName'];
     }
 
+    /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since sonata-project/doctrine-orm-admin-bundle 3.20 and will be removed in version 4.0. Use FieldDescription::getTargetModel() instead.
+     */
     public function getTargetEntity()
+    {
+        @trigger_error(sprintf(
+            'Method %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.20 and will be removed in version 4.0.'
+            .' Use %s::getTargetModel() instead.',
+            __METHOD__,
+            __CLASS__
+        ), E_USER_DEPRECATED);
+
+        return $this->getTargetModel();
+    }
+
+    /**
+     * @final since sonata-project/doctrine-orm-admin-bundle 3.20.
+     */
+    public function getTargetModel(): ?string
     {
         if ($this->associationMapping) {
             return $this->associationMapping['targetEntity'];
         }
+
+        return null;
     }
 
     public function setFieldMapping($fieldMapping): void

diff --git a/src/Builder/DatagridBuilder.php b/src/Builder/DatagridBuilder.php
@@ -158,7 +158,7 @@ public function addFilter(DatagridInterface $datagrid, $type, FieldDescriptionIn
 
         if (ModelAutocompleteFilter::class === $type) {
             $fieldDescription->mergeOption('field_options', [
-                'class' => $fieldDescription->getTargetEntity(),
+                'class' => $fieldDescription->getTargetModel(),
                 'model_manager' => $fieldDescription->getAdmin()->getModelManager(),
                 'admin_code' => $admin->getCode(),
                 'context' => 'filter',

diff --git a/src/Builder/FormContractor.php b/src/Builder/FormContractor.php
@@ -113,7 +113,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                 ));
             }
 
-            $options['class'] = $fieldDescription->getTargetEntity();
+            $options['class'] = $fieldDescription->getTargetModel();
             $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();
 
             if ($this->checkFormClass($type, [ModelAutocompleteType::class])) {
@@ -122,7 +122,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                         'The current field `%s` is not linked to an admin.'
                         .' Please create one for the target entity: `%s`',
                         $fieldDescription->getName(),
-                        $fieldDescription->getTargetEntity()
+                        $fieldDescription->getTargetModel()
                     ));
                 }
             }
@@ -132,7 +132,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                     'The current field `%s` is not linked to an admin.'
                     .' Please create one for the target entity : `%s`',
                     $fieldDescription->getName(),
-                    $fieldDescription->getTargetEntity()
+                    $fieldDescription->getTargetModel()
                 ));
             }
 
@@ -165,7 +165,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                     'The current field `%s` is not linked to an admin.'
                     .' Please create one for the target entity : `%s`',
                     $fieldDescription->getName(),
-                    $fieldDescription->getTargetEntity()
+                    $fieldDescription->getTargetModel()
                 ));
             }
 

diff --git a/src/Builder/ListBuilder.php b/src/Builder/ListBuilder.php
@@ -19,6 +19,7 @@
 use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 use Sonata\AdminBundle\Builder\ListBuilderInterface;
 use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
+use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;
 
 class ListBuilder implements ListBuilderInterface
 {
@@ -192,12 +193,27 @@ public function buildActionFieldDescription(FieldDescriptionInterface $fieldDesc
     /**
      * @param string $type
      *
-     * @return string
+     * @return string|null
      */
     private function getTemplate($type)
     {
         if (!isset($this->templates[$type])) {
-            return;
+            // NEXT_MAJOR: Remove the check for deprecated type and always return null.
+            if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
+                return $this->getTemplate(TypeGuesser::DEPRECATED_TYPES[$type]);
+            }
+
+            return null;
+        }
+
+        // NEXT_MAJOR: Remove the deprecation.
+        if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
+            @trigger_error(sprintf(
+                'Overriding %s list template is deprecated since sonata-project/doctrine-orm-admin-bundle 3.19.'
+                .' You should override %s list template instead.',
+                $type,
+                TypeGuesser::DEPRECATED_TYPES[$type]
+            ), E_USER_DEPRECATED);
         }
 
         return $this->templates[$type];

diff --git a/src/Builder/ShowBuilder.php b/src/Builder/ShowBuilder.php
@@ -19,6 +19,7 @@
 use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 use Sonata\AdminBundle\Builder\ShowBuilderInterface;
 use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
+use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;
 
 class ShowBuilder implements ShowBuilderInterface
 {
@@ -89,35 +90,6 @@ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInter
 
         if (!$fieldDescription->getTemplate()) {
             $fieldDescription->setTemplate($this->getTemplate($fieldDescription->getType()));
-
-            if (!$fieldDescription->getTemplate()) {
-                switch ($fieldDescription->getMappingType()) {
-                    case ClassMetadata::MANY_TO_ONE:
-                        $fieldDescription->setTemplate(
-                            '@SonataAdmin/CRUD/Association/show_many_to_one.html.twig'
-                        );
-
-                        break;
-                    case ClassMetadata::ONE_TO_ONE:
-                        $fieldDescription->setTemplate(
-                            '@SonataAdmin/CRUD/Association/show_one_to_one.html.twig'
-                        );
-
-                        break;
-                    case ClassMetadata::ONE_TO_MANY:
-                        $fieldDescription->setTemplate(
-                            '@SonataAdmin/CRUD/Association/show_one_to_many.html.twig'
-                        );
-
-                        break;
-                    case ClassMetadata::MANY_TO_MANY:
-                        $fieldDescription->setTemplate(
-                            '@SonataAdmin/CRUD/Association/show_many_to_many.html.twig'
-                        );
-
-                        break;
-                }
-            }
         }
 
         switch ($fieldDescription->getMappingType()) {
@@ -134,12 +106,27 @@ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInter
     /**
      * @param string $type
      *
-     * @return string
+     * @return string|null
      */
     private function getTemplate($type)
     {
         if (!isset($this->templates[$type])) {
-            return;
+            // NEXT_MAJOR: Remove the check for deprecated type and always return null.
+            if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
+                return $this->getTemplate(TypeGuesser::DEPRECATED_TYPES[$type]);
+            }
+
+            return null;
+        }
+
+        // NEXT_MAJOR: Remove the deprecation.
+        if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
+            @trigger_error(sprintf(
+                'Overriding %s show template is deprecated since sonata-project/doctrine-orm-admin-bundle 3.19.'
+                .' You should override %s show template instead.',
+                $type,
+                TypeGuesser::DEPRECATED_TYPES[$type]
+            ), E_USER_DEPRECATED);
         }
 
         return $this->templates[$type];

diff --git a/src/Filter/StringFilter.php b/src/Filter/StringFilter.php
@@ -15,14 +15,16 @@
 
 use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
 use Sonata\AdminBundle\Form\Type\Filter\ChoiceType;
-use Sonata\AdminBundle\Form\Type\Operator\ContainsOperatorType;
+use Sonata\AdminBundle\Form\Type\Operator\StringOperatorType;
 
 class StringFilter extends Filter
 {
     public const CHOICES = [
-        ContainsOperatorType::TYPE_CONTAINS => 'LIKE',
-        ContainsOperatorType::TYPE_NOT_CONTAINS => 'NOT LIKE',
-        ContainsOperatorType::TYPE_EQUAL => '=',
+        StringOperatorType::TYPE_CONTAINS => 'LIKE',
+        StringOperatorType::TYPE_STARTS_WITH => 'LIKE',
+        StringOperatorType::TYPE_ENDS_WITH => 'LIKE',
+        StringOperatorType::TYPE_NOT_CONTAINS => 'NOT LIKE',
+        StringOperatorType::TYPE_EQUAL => '=',
     ];
 
     public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data): void
@@ -37,7 +39,7 @@ public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
             return;
         }
 
-        $data['type'] = !isset($data['type']) ? ContainsOperatorType::TYPE_CONTAINS : $data['type'];
+        $data['type'] = !isset($data['type']) ? StringOperatorType::TYPE_CONTAINS : $data['type'];
 
         $operator = $this->getOperator((int) $data['type']);
 
@@ -56,22 +58,33 @@ public function filter(ProxyQueryInterface $queryBuilder, $alias, $field, $data)
             $or->add(sprintf('LOWER(%s.%s) %s :%s', $alias, $field, $operator, $parameterName));
         }
 
-        if (ContainsOperatorType::TYPE_NOT_CONTAINS === $data['type']) {
+        if (StringOperatorType::TYPE_NOT_CONTAINS === $data['type']) {
             $or->add($queryBuilder->expr()->isNull(sprintf('%s.%s', $alias, $field)));
         }
 
         $this->applyWhere($queryBuilder, $or);
 
-        if (ContainsOperatorType::TYPE_EQUAL === $data['type']) {
+        if (StringOperatorType::TYPE_EQUAL === $data['type']) {
             $queryBuilder->setParameter(
                 $parameterName,
                 $this->getOption('case_sensitive') ? $data['value'] : mb_strtolower($data['value'])
             );
         } else {
+            switch ($data['type']) {
+                case StringOperatorType::TYPE_STARTS_WITH:
+                    $format = '%s%%';
+                    break;
+                case StringOperatorType::TYPE_ENDS_WITH:
+                    $format = '%%%s';
+                    break;
+                default:
+                    $format = $this->getOption('format');
+            }
+
             $queryBuilder->setParameter(
                 $parameterName,
                 sprintf(
-                    $this->getOption('format'),
+                    $format,
                     $this->getOption('case_sensitive') ? $data['value'] : mb_strtolower($data['value'])
                 )
             );

diff --git a/src/Guesser/FilterTypeGuesser.php b/src/Guesser/FilterTypeGuesser.php
@@ -37,6 +37,7 @@ class FilterTypeGuesser extends AbstractTypeGuesser
     public function guessType($class, $property, ModelManagerInterface $modelManager)
     {
         if (!$ret = $this->getParentMetadataForProperty($class, $property, $modelManager)) {
+            // NEXT_MAJOR: Return null.
             return false;
         }