diff --git a/.editorconfig b/.editorconfig index dca0534cd0..b2621ff980 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + root = true [*] diff --git a/.flintci.yml b/.flintci.yml index 8258ef2e91..0de2252fa4 100644 --- a/.flintci.yml +++ b/.flintci.yml @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + services: composernormalize: true phpcsfixer: true diff --git a/.gitattributes b/.gitattributes index 667b29d794..14d001e6cf 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + .* export-ignore *.md export-ignore tests export-ignore diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 208ccb2658..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,52 +0,0 @@ - - - - -### Environment - -#### Sonata packages - -``` -$ composer show --latest 'sonata-project/*' -# Put the result here. -``` - -#### Symfony packages - -``` -$ composer show --latest 'symfony/*' -# Put the result here. -``` - -#### PHP version - -``` -$ php -v -# Put the result here. -``` - -## Subject - - - -## Steps to reproduce - -## Expected results - -## Actual results - - diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md deleted file mode 100644 index e363f8e5cb..0000000000 --- a/.github/ISSUE_TEMPLATE/Question.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: ⛔ NO support questions -about: If you have a question, please check out our Slack or StackOverflow! ---- - -Hi, we try to keep Github issues for bug reports and feature requests only. -If you have a question, please ask it on Stack Overflow or on #sonata on [the symfony-devs slack](https://symfony.com/slack-invite). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..7876e7c920 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + +blank_issues_enabled: false +contact_links: + - name: StackOverflow + url: https://stackoverflow.com/questions/tagged/sonata + about: 'Questions tagged with "sonata" on StackOverflow' + - name: Slack + url: https://symfony-devs.slack.com/archives/C3GC7MKM5 + about: '#sonata channel on Symfony Devs Slack' diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index ee08883498..0e4647bc10 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + on: [push, pull_request] name: Lint diff --git a/.github/workflows/qa.yaml b/.github/workflows/qa.yaml index a796313469..0a7eb5136a 100644 --- a/.github/workflows/qa.yaml +++ b/.github/workflows/qa.yaml @@ -12,3 +12,11 @@ jobs: REQUIRE_DEV: true with: args: analyse + psalm: + name: Psalm + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Psalm + uses: docker://vimeo/psalm-github-actions diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml index dd4acf6ea9..9679ec46c7 100644 --- a/.github/workflows/stale.yaml +++ b/.github/workflows/stale.yaml @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + # https://github.com/actions/stale name: "Stale" diff --git a/.php_cs.dist b/.php_cs.dist index 47f50fea69..6f7ff02b54 100644 --- a/.php_cs.dist +++ b/.php_cs.dist @@ -1,6 +1,6 @@ + # Sonata project contribution Thanks for your interest in Sonata projects! @@ -266,15 +272,17 @@ The deprecated minor version **MUST NOT** be provided. Use `x` instead. It will Any deprecation **MUST** be documented in the corresponding `UPGRADE-[0-9].x.md`. The documentation **MUST** be filled inside the top **unreleased** section with a sub title. -The `NEXT_MAJOR` tag SHOULD not be used for deprecation. -The `@deprecated` and `E_USER_DEPRECATED` key will be searched for before releasing the next major version. +The `NEXT_MAJOR` tag SHOULD also be used for deprecations, it will be searched for before releasing the next major version. You have three ways to deprecate things. -For class definitions, methods (or first level functions) and properties, use the `@deprecated` tag: +For class definitions and properties, use the `@deprecated` tag. +For methods, use the `@deprecated` tag and trigger a deprecation with `@trigger_error('...', E_USER_DEPRECATED)`: ```php /** + * NEXT_MAJOR: Remove this class. + * * @deprecated since sonata-project/foo-lib 42.x, to be removed in 43.0. Use Shiny\New\ClassOfTheMonth instead. */ final class IAmOldAndUseless @@ -284,15 +292,24 @@ final class IAmOldAndUseless final class StillUsedClass { /** + * NEXT_MAJOR: Remove this property. + * * @deprecated since sonata-project/foo-lib 42.x, to be removed in 43.0. */ public $butNotThisProperty; /** + * NEXT_MAJOR: Remove this method. + * * @deprecated since sonata-project/foo-lib 42.x, to be removed in 43.0. */ public function iAmBatman() { + @trigger_error(sprintf( + 'Method %s() is deprecated since sonata-project/foo-lib 42.x and will be removed in version 43.0.', + __METHOD__ + ), E_USER_DEPRECATED); + echo "But this is not Gotham here."; } } @@ -301,6 +318,7 @@ final class StillUsedClass If the deprecated thing is a service, you **MUST** specify it on the service definition: ```xml + The "%service_id%" service is deprecated since sonata-project/bar-bundle 42.x and will be removed in 43.0. @@ -309,14 +327,15 @@ If the deprecated thing is a service, you **MUST** specify it on the service def More info: http://symfony.com/blog/new-in-symfony-2-8-deprecated-service-definitions -For everything else, not managed by the `@deprecated` tag, you **MUST** trigger a deprecation message. +For everything else, not managed by the `@deprecated` tag, +you **MUST** still trigger a deprecation message (and add a `NEXT_MAJOR` comment). ```php + # Sonata Admin Bundle The missing Symfony Admin Generator diff --git a/UPGRADE-2.1.md b/UPGRADE-2.1.md deleted file mode 100644 index 206005b6a4..0000000000 --- a/UPGRADE-2.1.md +++ /dev/null @@ -1,13 +0,0 @@ -UPGRADE FROM 2.0 to 2.1 -======================= - -### Form - - * Due to refactoring in the Form Component, some type definitions have been changed and - new ones have been introduced: - - * sonata_type_model : this type now only renders a standard select widget or a list - widget (if the `multiple` option is set) - - * sonata_type_model_list : this type replaces the option `edit = list` provided as - a 4th argument on the `sonata_type_model` diff --git a/UPGRADE-2.2.md b/UPGRADE-2.2.md deleted file mode 100644 index 493442834b..0000000000 --- a/UPGRADE-2.2.md +++ /dev/null @@ -1,10 +0,0 @@ -UPGRADE FROM 2.1 to 2.2 -======================= - -### Form - - * Refactoring the general layout to be more compact - * Remove the collapsing option to migrate to tabbed form layout - * Add tab menu to edit form - * Fix deprecated calls to the Form API - diff --git a/UPGRADE-2.3.md b/UPGRADE-2.3.md deleted file mode 100644 index 8497d87828..0000000000 --- a/UPGRADE-2.3.md +++ /dev/null @@ -1,19 +0,0 @@ -UPGRADE FROM 2.2 to 2.3 -======================= - -### Dependencies - -You'll need to follow the dependencies upgrade instructions. - -### Templates - - - `standard_layout.html.twig` has been updated (refactored layout accordingly to the theme). Some blocks have been moved, and the sonata_side_nav twig block became the main menu. - - Admin's sidemenus are now tab-menus; former tab-menus are now collapsible items. - -### Admin classes - - - `configureSideMenu` and `buildSideMenu` methods of the `Admin` class have been deprecated; they are replaced by `configureTabMenu` and `buildTabMenu`. - -### Remove configureShowField - - - `configureShowField` has been deprecated since a while now, use `configureShowFields` instead => add a `s`. \ No newline at end of file diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md deleted file mode 100644 index 696cf71765..0000000000 --- a/UPGRADE-3.0.md +++ /dev/null @@ -1,40 +0,0 @@ -UPGRADE FROM 2.x to 3.0 -======================= - -### Dependencies - -You will need to follow the dependencies upgrade instructions. - -## Deprecated BaseFieldDescription::camelize() and AdminHelper::camelize() - -If you were using this method, please use `Doctrine\Common\Inflector\Inflector::classify()` instead. - -## Datagrid builders - -If you have implemented a custom datagrid builder, you must adapt the signature of its `addFilter` method to match the one in `DatagridBuilderInterface` again. - -## sonata_type_model_autocomplete -CSS class `sonata-autocomplete-dropdown-item` is not automatically added to dropdown autocomplete item in `sonata_type_model_autocomplete`, use option `dropdown_item_css_class` to set the CSS class of dropdown item. - -## Standard Layout -`sonata_wrapper` block was moved and is now inside the `.wrapper` div of admin lte theme. - -## ErrorElement - -The inline validation has been migrating to CoreBundle. Just rename `Sonata\AdminBundle\Validator\ErrorElement` to `Sonata\CoreBundle\Validator\ErrorElement` - -## AdminLTE 2 - -AdminLTE version 2 has been integrated, this should work out of the box if you havn't change templates. If not you can review the upgrade guide here : [http://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#upgrade](http://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#upgrade) - -## AclSecurityHandler - -In order to fix deprecated issue by spiting `SecurityContextInterface`, `AclSecurityHandler` constructor got a new argument. - -## AdminPoolLoader - -If you're using a custom implementation of `sonata.admin.route_loader` service, make sure to provide an array as 2nd argument since the type for this argument is now hinted to `array`. - -## LegacyModelsToArrayTransformer - -The `ModelsToArrayTransformer` has been renamed to `LegacyModelsToArrayTransformer`. `ModelsToArrayTransformer` should be only be used with SF2.7+ diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md index 892a122d77..8e0c264c58 100644 --- a/UPGRADE-3.x.md +++ b/UPGRADE-3.x.md @@ -1,8 +1,21 @@ UPGRADE 3.x =========== -UPGRADE FROM 3.x to 3.x -======================= +## Deprecated `Sonata\AdminBundle\Model\ModelManagerInterface` collection-related methods. + +Use: +- `new \Doctrine\Common\Collections\ArrayCollection()` instead of `getModelCollectionInstance($class)` +- `$collection->removeElement($element)` instead of `collectionRemoveElement($collection, $element)` +- `$collection->add($element)` instead of `collectionAddElement($collection, $element)` +- `$collection->contains($element)` instead of `collectionHasElement($collection, $element)` +- `$collection->clear()` instead of `collectionClear($collection)` + +UPGRADE FROM 3.73 to 3.74 +========================= + +## Deprecated `Sonata\AdminBundle\Datagrid\ProxyQueryInterface::getSingleScalarResult` + +Use `Sonata\AdminBundle\Datagrid\ProxyQueryInterface::execute` instead. ## The following templates have been deprecated @@ -45,6 +58,10 @@ with `sonata-project/block-bundle` on your composer.json in order to avoid unwan There is a minimal BC Break on `AdminListBlockService`, `AdminSearchBlockService` and `AdminStatsBlockService`. If you are extending those clases (keep in mind that they will become final on 4.0) you should add return type hints to `execute()` and `configureSettings()`. +## Deprecated passing `callable` that does not return `Symfony\Component\Routing\Route` as `$element` (2nd argument) to `Sonata\AdminBundle\Route\RouteCollection::addElement($code, $element)` + +When calling a `Sonata\AdminBundle\Route\RouteCollection::addElement($code, $element)`, please pass `$element` of type `Route|callable():Route`. Passing `callable` that returns non instance of `Route` is deprecated. + UPGRADE FROM 3.72 to 3.73 ========================= diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md index 75af37cea1..16850aa621 100644 --- a/UPGRADE-4.0.md +++ b/UPGRADE-4.0.md @@ -128,6 +128,9 @@ If you have implemented a custom admin extension, you must adapt the signature o * `configureBatchActions` * `getAccessMapping` +## AdminHelper +The `AdminHelper::__construct` method changes its `Pool` param to a `PropertyAccessorInterface` one. + ## BreadcrumbsBuilder The `buildBreacrumbs` method may no longer be called from outside the class. diff --git a/composer.json b/composer.json index 5853d209c9..7e31bc8048 100644 --- a/composer.json +++ b/composer.json @@ -23,9 +23,11 @@ ], "require": { "php": "^7.3", - "doctrine/common": "^2.7", + "ext-json": "*", + "doctrine/collections": "^1.6", + "doctrine/common": "^2.7 || ^3.0", "doctrine/inflector": "^1.4 || ^2.0", - "doctrine/persistence": "^1.3.3", + "doctrine/persistence": "^1.3.6 || ^2.0", "knplabs/knp-menu": "^3.1", "knplabs/knp-menu-bundle": "^3.0", "sonata-project/block-bundle": "^4.2", @@ -70,7 +72,9 @@ }, "require-dev": { "matthiasnoback/symfony-dependency-injection-test": "^4.1", + "phpdocumentor/reflection-docblock": "^5.2", "phpstan/phpstan": "^0.12.29", + "psalm/plugin-symfony": "^1.4", "psr/event-dispatcher": "^1.0", "sonata-project/intl-bundle": "^2.4", "symfony/browser-kit": "^4.4 || ^5.1", @@ -78,7 +82,8 @@ "symfony/filesystem": "^4.4 || ^5.1", "symfony/maker-bundle": "^1.17", "symfony/phpunit-bridge": "^5.1.1", - "symfony/yaml": "^4.4 || ^5.1" + "symfony/yaml": "^4.4 || ^5.1", + "vimeo/psalm": "^3.13.1" }, "suggest": { "kunicmarko/sonata-auto-configure-bundle": "Auto configures Admin classes", diff --git a/docs/.doctor-rst.yaml b/docs/.doctor-rst.yaml index 29257eb943..641228cde2 100644 --- a/docs/.doctor-rst.yaml +++ b/docs/.doctor-rst.yaml @@ -1,3 +1,7 @@ +# DO NOT EDIT THIS FILE! +# +# It's auto-generated by sonata-project/dev-kit package. + rules: blank_line_after_directive: ~ short_array_syntax: ~ diff --git a/docs/conf.py b/docs/conf.py index 66f99f3eee..09cf99d8ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- + +# DO NOT EDIT THIS FILE! # +# It's auto-generated by sonata-project/dev-kit package. + # IoC documentation build configuration file, created by # sphinx-quickstart on Fri Mar 29 01:43:00 2013. # @@ -44,7 +48,7 @@ master_doc = 'index' # General information about the project. -project = u'' +project = u'Sonata Admin Bundle' copyright = u'2010-2019, Thomas Rabaix' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/reference/routing.rst b/docs/reference/routing.rst index caddc62cfb..a35f4adda0 100644 --- a/docs/reference/routing.rst +++ b/docs/reference/routing.rst @@ -281,7 +281,7 @@ Any single registered route can be removed by name:: Removing all routes except named ones ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you want to disable all default Sonata routes except few whitelisted ones, you can use +If you want to disable all default Sonata routes except few allowed ones, you can use the ``clearExcept()`` method. This method accepts an array of routes you want to keep active:: // src/Admin/MediaAdmin.php diff --git a/docs/requirements.txt b/docs/requirements.txt index a86ef50ae7..ee596d3c45 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,7 @@ # 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/phpstan.neon.dist b/phpstan.neon.dist index 0cce313b04..4e75f11fa4 100644 --- a/phpstan.neon.dist +++ b/phpstan.neon.dist @@ -2,7 +2,7 @@ includes: - phpstan-baseline.neon parameters: - level: 4 + level: 5 paths: - src diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 01891c55df..36fc24d133 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -32,7 +32,7 @@ It's auto-generated by sonata-project/dev-kit package. - + diff --git a/psalm-baseline.xml b/psalm-baseline.xml new file mode 100644 index 0000000000..9231c5b801 --- /dev/null +++ b/psalm-baseline.xml @@ -0,0 +1,36 @@ + + + + + + DoctrinePersistentCollection + + + + + + $namespace + $class_name + $fields + $fields + $fields + $fields + + + + + $namespace + $class_name + + + + + array_merge(array_flip($keys), $this->filters) + + + + + array_merge(array_flip($keys), $this->elements) + + + diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000000..a02e46da29 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php index 5772399e3a..11f4aafc88 100644 --- a/src/Admin/AbstractAdmin.php +++ b/src/Admin/AbstractAdmin.php @@ -580,11 +580,7 @@ public function update(object $object): object $extension->preUpdate($this, $object); } - $result = $this->getModelManager()->update($object); - // BC compatibility - if (null !== $result) { - $object = $result; - } + $this->getModelManager()->update($object); $this->postUpdate($object); foreach ($this->extensions as $extension) { @@ -601,11 +597,7 @@ public function create(object $object): object $extension->prePersist($this, $object); } - $result = $this->getModelManager()->create($object); - // BC compatibility - if (null !== $result) { - $object = $result; - } + $this->getModelManager()->create($object); $this->postPersist($object); foreach ($this->extensions as $extension) { @@ -1938,22 +1930,12 @@ public function getSecurityInformation(): array */ public function getPermissionsShow(string $context): array { - switch ($context) { - case self::CONTEXT_DASHBOARD: - case self::CONTEXT_MENU: - default: - return ['LIST']; - } + return ['LIST']; } public function showIn(string $context): bool { - switch ($context) { - case self::CONTEXT_DASHBOARD: - case self::CONTEXT_MENU: - default: - return $this->isGranted($this->getPermissionsShow($context)); - } + return $this->isGranted($this->getPermissionsShow($context)); } public function createObjectSecurity(object $object): void @@ -2249,8 +2231,8 @@ final public function getActionButtons(string $action, ?object $object = null): $buttonList = []; if (\in_array($action, ['tree', 'show', 'edit', 'delete', 'list', 'batch'], true) - && $this->hasAccess('create') && $this->hasRoute('create') + && $this->hasAccess('create') ) { $buttonList['create'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_create'), @@ -2258,8 +2240,8 @@ final public function getActionButtons(string $action, ?object $object = null): } if (\in_array($action, ['show', 'delete', 'acl', 'history'], true) - && $this->canAccessObject('edit', $object) && $this->hasRoute('edit') + && $this->canAccessObject('edit', $object) ) { $buttonList['edit'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_edit'), @@ -2267,8 +2249,8 @@ final public function getActionButtons(string $action, ?object $object = null): } if (\in_array($action, ['show', 'edit', 'acl'], true) - && $this->canAccessObject('history', $object) && $this->hasRoute('history') + && $this->canAccessObject('history', $object) ) { $buttonList['history'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_history'), @@ -2277,8 +2259,8 @@ final public function getActionButtons(string $action, ?object $object = null): if (\in_array($action, ['edit', 'history'], true) && $this->isAclEnabled() - && $this->canAccessObject('acl', $object) && $this->hasRoute('acl') + && $this->canAccessObject('acl', $object) ) { $buttonList['acl'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_acl'), @@ -2286,9 +2268,9 @@ final public function getActionButtons(string $action, ?object $object = null): } if (\in_array($action, ['edit', 'history', 'acl'], true) + && $this->hasRoute('show') && $this->canAccessObject('show', $object) && \count($this->getShow()) > 0 - && $this->hasRoute('show') ) { $buttonList['show'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_show'), @@ -2296,8 +2278,8 @@ final public function getActionButtons(string $action, ?object $object = null): } if (\in_array($action, ['show', 'edit', 'delete', 'acl', 'batch'], true) - && $this->hasAccess('list') && $this->hasRoute('list') + && $this->hasAccess('list') ) { $buttonList['list'] = [ 'template' => $this->getTemplateRegistry()->getTemplate('button_list'), diff --git a/src/Admin/AdminHelper.php b/src/Admin/AdminHelper.php index 4eb936ffae..9c933a1a00 100644 --- a/src/Admin/AdminHelper.php +++ b/src/Admin/AdminHelper.php @@ -22,6 +22,7 @@ use Sonata\AdminBundle\Util\FormViewIterator; use Symfony\Component\Form\FormBuilderInterface; use Symfony\Component\Form\FormView; +use Symfony\Component\PropertyAccess\PropertyAccessorInterface; /** * @final since sonata-project/admin-bundle 3.52 @@ -36,13 +37,13 @@ class AdminHelper private const FORM_FIELD_DELETE = '_delete'; /** - * @var Pool + * @var PropertyAccessorInterface */ - protected $pool; + protected $propertyAccessor; - public function __construct(Pool $pool) + public function __construct(PropertyAccessorInterface $propertyAccessor) { - $this->pool = $pool; + $this->propertyAccessor = $propertyAccessor; } /** @@ -111,11 +112,9 @@ public function appendFormFieldElement(AdminInterface $admin, object $subject, s //Child form not found (probably nested one) //if childFormBuilder was not found resulted in fatal error getName() method call on non object if (!$childFormBuilder) { - $propertyAccessor = $this->pool->getPropertyAccessor(); - $path = $this->getElementAccessPath($elementId, $subject); - $collection = $propertyAccessor->getValue($subject, $path); + $collection = $this->propertyAccessor->getValue($subject, $path); if ($collection instanceof DoctrinePersistentCollection || $collection instanceof PersistentCollection) { //since doctrine 2.4 @@ -127,7 +126,7 @@ public function appendFormFieldElement(AdminInterface $admin, object $subject, s } $collection->add(new $modelClassName()); - $propertyAccessor->setValue($subject, $path, $collection); + $this->propertyAccessor->setValue($subject, $path, $collection); $fieldDescription = null; } else { @@ -195,8 +194,6 @@ public function appendFormFieldElement(AdminInterface $admin, object $subject, s */ public function getElementAccessPath(string $elementId, $model): string { - $propertyAccessor = $this->pool->getPropertyAccessor(); - $idWithoutIdentifier = preg_replace('/^[^_]*_/', '', $elementId); $initialPath = preg_replace('#(_(\d+)_)#', '[$2]_', $idWithoutIdentifier); @@ -208,7 +205,7 @@ public function getElementAccessPath(string $elementId, $model): string $currentPath .= empty($currentPath) ? $part : '_'.$part; $separator = empty($totalPath) ? '' : '.'; - if ($propertyAccessor->isReadable($model, $totalPath.$separator.$currentPath)) { + if ($this->propertyAccessor->isReadable($model, $totalPath.$separator.$currentPath)) { $totalPath .= $separator.$currentPath; $currentPath = ''; } diff --git a/src/Admin/AdminInterface.php b/src/Admin/AdminInterface.php index 87c29f4496..44ddd1a945 100644 --- a/src/Admin/AdminInterface.php +++ b/src/Admin/AdminInterface.php @@ -72,6 +72,8 @@ public function attachAdminClass(FieldDescriptionInterface $fieldDescription): v public function getDatagrid(): DatagridInterface; + public function getPagerType(): string; + /** * Set base controller name. */ @@ -162,7 +164,7 @@ public function setSecurityHandler(SecurityHandlerInterface $securityHandler): v public function getSecurityHandler(): ?SecurityHandlerInterface; /** - * @param string $name + * @param string|array $name */ public function isGranted($name, ?object $object = null): bool; diff --git a/src/Command/GenerateObjectAclCommand.php b/src/Command/GenerateObjectAclCommand.php index 2628114a38..665b6e3013 100644 --- a/src/Command/GenerateObjectAclCommand.php +++ b/src/Command/GenerateObjectAclCommand.php @@ -13,7 +13,7 @@ namespace Sonata\AdminBundle\Command; -use Doctrine\Common\Persistence\ManagerRegistry; +use Doctrine\Persistence\ManagerRegistry; use Sonata\AdminBundle\Admin\AdminInterface; use Sonata\AdminBundle\Admin\Pool; use Sonata\AdminBundle\Util\ObjectAclManipulatorInterface; diff --git a/src/Controller/CRUDController.php b/src/Controller/CRUDController.php index 33c5c194dd..5da8a567f7 100644 --- a/src/Controller/CRUDController.php +++ b/src/Controller/CRUDController.php @@ -470,16 +470,22 @@ public function batchAction(Request $request) $confirmation = $request->get('confirmation', false); - if ($data = json_decode($request->get('data', ''), true)) { + $forwardedRequest = $request->duplicate(); + + if ($data = json_decode((string) $request->get('data', ''), true)) { $action = $data['action']; $idx = $data['idx']; $allElements = (bool) $data['all_elements']; - $request->request->replace(array_merge($request->request->all(), $data)); + $forwardedRequest->request->replace(array_merge($forwardedRequest->request->all(), $data)); } else { - $action = $request->request->getAlnum('action'); + $action = $forwardedRequest->request->getAlnum('action'); $idx = $request->request->get('idx', []); - $allElements = $request->request->getBoolean('all_elements'); - $data = $request->request->all(); + $allElements = $forwardedRequest->request->getBoolean('all_elements'); + + $forwardedRequest->request->set('idx', $idx); + $forwardedRequest->request->set('all_elements', $allElements); + + $data = $forwardedRequest->request->all(); unset($data['_sonata_csrf_token']); } @@ -493,7 +499,7 @@ public function batchAction(Request $request) $isRelevantAction = sprintf('batchAction%sIsRelevant', $camelizedAction); if (method_exists($this, $isRelevantAction)) { - $nonRelevantMessage = $this->$isRelevantAction($idx, $allElements, $request); + $nonRelevantMessage = $this->$isRelevantAction($idx, $allElements, $forwardedRequest); } else { $nonRelevantMessage = 0 !== \count($idx) || $allElements; // at least one item is selected } @@ -564,7 +570,7 @@ public function batchAction(Request $request) return $this->redirectToList(); } - return $this->$finalAction($query, $request); + return $this->$finalAction($query, $forwardedRequest); } /** diff --git a/src/Datagrid/Datagrid.php b/src/Datagrid/Datagrid.php index e1e0ef5478..d92dc2661b 100644 --- a/src/Datagrid/Datagrid.php +++ b/src/Datagrid/Datagrid.php @@ -199,9 +199,11 @@ static function ($value) { $this->bound = true; } - public function addFilter(FilterInterface $filter): void + public function addFilter(FilterInterface $filter): FilterInterface { $this->filters[$filter->getName()] = $filter; + + return $filter; } public function hasFilter(string $name): bool diff --git a/src/Datagrid/DatagridInterface.php b/src/Datagrid/DatagridInterface.php index a401a19dd3..fcdf80ed54 100644 --- a/src/Datagrid/DatagridInterface.php +++ b/src/Datagrid/DatagridInterface.php @@ -34,7 +34,7 @@ public function getResults(): array; public function buildPager(): void; - public function addFilter(FilterInterface $filter): void; + public function addFilter(FilterInterface $filter): FilterInterface; /** * @return array diff --git a/src/Datagrid/Pager.php b/src/Datagrid/Pager.php index 8f42717b2e..73113856a3 100644 --- a/src/Datagrid/Pager.php +++ b/src/Datagrid/Pager.php @@ -420,6 +420,7 @@ public function next() --$this->resultsCounter; + // NEXT_MAJOR: remove `return` statement, to be compatible with Iterator::next(): void return next($this->results); } @@ -434,6 +435,7 @@ public function rewind() $this->resultsCounter = \count($this->results); + // NEXT_MAJOR: remove `return` statement, to be compatible with Iterator::rewind(): void return reset($this->results); } diff --git a/src/Datagrid/ProxyQueryInterface.php b/src/Datagrid/ProxyQueryInterface.php index 6699d3d647..c69a4264cf 100644 --- a/src/Datagrid/ProxyQueryInterface.php +++ b/src/Datagrid/ProxyQueryInterface.php @@ -40,17 +40,24 @@ public function execute(array $params = [], ?int $hydrationMode = null); */ public function setSortBy(array $parentAssociationMappings, array $fieldMapping): self; - public function getSortBy(): string; + public function getSortBy(): ?string; public function setSortOrder(string $sortOrder): self; - public function getSortOrder(): string; + public function getSortOrder(): ?string; - public function getSingleScalarResult(): ?int; + /** + * NEXT_MAJOR: Remove this method. + * + * @deprecated since sonata-project/admin-bundle 3.74, to be removed in 4.0. + * + * @return mixed + */ + public function getSingleScalarResult(); public function setFirstResult(?int $firstResult): self; - public function getFirstResult(): ?object; + public function getFirstResult(): ?int; public function setMaxResults(?int $maxResults): self; @@ -59,6 +66,8 @@ public function getMaxResults(): ?int; public function getUniqueParameterId(): int; /** + * Join entities from the given association mappings and return the last alias created. + * * @param mixed[] $associationMappings */ public function entityJoin(array $associationMappings): string; diff --git a/src/Form/ChoiceList/ModelChoiceLoader.php b/src/Form/ChoiceList/ModelChoiceLoader.php index e86f2cf6ad..c4cd4fd07a 100644 --- a/src/Form/ChoiceList/ModelChoiceLoader.php +++ b/src/Form/ChoiceList/ModelChoiceLoader.php @@ -28,8 +28,6 @@ */ final class ModelChoiceLoader implements ChoiceLoaderInterface { - public $identifier; - /** * @var \Sonata\AdminBundle\Model\ModelManagerInterface */ @@ -78,8 +76,6 @@ public function __construct( $this->query = $query; $this->choices = $choices; - $this->identifier = $this->modelManager->getIdentifierFieldNames($this->class); - // The property option defines, which property (path) is used for // displaying entities as strings if ($property) { diff --git a/src/Form/DataTransformer/ModelToIdPropertyTransformer.php b/src/Form/DataTransformer/ModelToIdPropertyTransformer.php index a41ebf3957..e763988d1e 100644 --- a/src/Form/DataTransformer/ModelToIdPropertyTransformer.php +++ b/src/Form/DataTransformer/ModelToIdPropertyTransformer.php @@ -13,6 +13,7 @@ namespace Sonata\AdminBundle\Form\DataTransformer; +use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Util\ClassUtils; use Sonata\AdminBundle\Model\ModelManagerInterface; use Symfony\Component\Form\DataTransformerInterface; @@ -71,7 +72,8 @@ public function __construct( public function reverseTransform($value) { - $collection = $this->modelManager->getModelCollectionInstance($this->className); + /** @var ArrayCollection $collection */ + $collection = new ArrayCollection(); if (empty($value)) { if ($this->multiple) { @@ -94,7 +96,11 @@ public function reverseTransform($value) continue; } - $collection[] = $this->modelManager->find($this->className, $id); + $object = $this->modelManager->find($this->className, $id); + + if (null !== $object) { + $collection->add($object); + } } return $collection; @@ -155,15 +161,13 @@ public function transform($entityOrCollection) } $label = ($this->toStringCallback)($model, $this->property); + } elseif (method_exists($model, '__toString')) { + $label = (string) $model; } else { - try { - $label = (string) $model; - } catch (\Exception $e) { - throw new \RuntimeException(sprintf( - 'Unable to convert the entity %s to String, entity must have a \'__toString()\' method defined', - ClassUtils::getClass($model) - ), 0, $e); - } + throw new \RuntimeException(sprintf( + 'Unable to convert the entity %s to String, entity must have a \'__toString()\' method defined', + ClassUtils::getClass($model) + )); } $result[] = $id; diff --git a/src/Form/DataTransformer/ModelsToArrayTransformer.php b/src/Form/DataTransformer/ModelsToArrayTransformer.php index d899cde5bd..32ff9038f6 100644 --- a/src/Form/DataTransformer/ModelsToArrayTransformer.php +++ b/src/Form/DataTransformer/ModelsToArrayTransformer.php @@ -13,6 +13,7 @@ namespace Sonata\AdminBundle\Form\DataTransformer; +use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Util\ClassUtils; use Sonata\AdminBundle\Model\ModelManagerInterface; use Sonata\Doctrine\Adapter\AdapterInterface; @@ -67,13 +68,14 @@ public function reverseTransform($keys) throw new UnexpectedTypeException($keys, 'array'); } - $collection = $this->modelManager->getModelCollectionInstance($this->class); + /** @var ArrayCollection $collection */ + $collection = new ArrayCollection(); $notFound = []; // optimize this into a SELECT WHERE IN query foreach ($keys as $key) { if ($model = $this->modelManager->find($this->class, $key)) { - $collection[] = $model; + $collection->add($model); } else { $notFound[] = $key; } diff --git a/src/Form/EventListener/MergeCollectionListener.php b/src/Form/EventListener/MergeCollectionListener.php index 1055b0dcc1..ec78232ac6 100644 --- a/src/Form/EventListener/MergeCollectionListener.php +++ b/src/Form/EventListener/MergeCollectionListener.php @@ -13,6 +13,7 @@ namespace Sonata\AdminBundle\Form\EventListener; +use Doctrine\Common\Collections\Collection; use Sonata\AdminBundle\Model\ModelManagerInterface; use Symfony\Component\EventDispatcher\EventSubscriberInterface; use Symfony\Component\Form\FormEvent; @@ -24,12 +25,23 @@ final class MergeCollectionListener implements EventSubscriberInterface { /** - * @var ModelManagerInterface + * @var ModelManagerInterface|null */ private $modelManager; - public function __construct(ModelManagerInterface $modelManager) + /** + * NEXT_MAJOR: Remove this constructor and the modelManager property. + */ + public function __construct(?ModelManagerInterface $modelManager = null) { + if (null !== $modelManager) { + @trigger_error(sprintf( + 'Passing argument 1 to %s() is deprecated since sonata-project/admin-bundle 3.x' + .' and will be ignored in version 4.0.', + __METHOD__ + ), E_USER_DEPRECATED); + } + $this->modelManager = $modelManager; } @@ -43,7 +55,10 @@ public static function getSubscribedEvents() public function onBind(FormEvent $event): void { $collection = $event->getForm()->getData(); + \assert(null === $collection || $collection instanceof Collection); + $data = $event->getData(); + \assert($data instanceof Collection); // looks like there is no way to remove other listeners $event->stopPropagation(); @@ -51,19 +66,19 @@ public function onBind(FormEvent $event): void if (!$collection) { $collection = $data; } elseif (0 === \count($data)) { - $this->modelManager->collectionClear($collection); + $collection->clear(); } else { // merge $data into $collection foreach ($collection as $model) { - if (!$this->modelManager->collectionHasElement($data, $model)) { - $this->modelManager->collectionRemoveElement($collection, $model); + if (!$data->contains($model)) { + $collection->removeElement($model); } else { - $this->modelManager->collectionRemoveElement($data, $model); + $data->removeElement($model); } } foreach ($data as $model) { - $this->modelManager->collectionAddElement($collection, $model); + $collection->add($model); } } diff --git a/src/Maker/AdminMaker.php b/src/Maker/AdminMaker.php index b489a5a51b..d0f8f54aca 100644 --- a/src/Maker/AdminMaker.php +++ b/src/Maker/AdminMaker.php @@ -39,7 +39,7 @@ final class AdminMaker extends AbstractMaker private $projectDirectory; /** - * @var string[] + * @var array */ private $availableModelManagers; @@ -78,6 +78,10 @@ final class AdminMaker extends AbstractMaker */ private $modelManager; + /** + * @param string $projectDirectory + * @param array $modelManagers + */ public function __construct($projectDirectory, array $modelManagers = []) { $this->projectDirectory = $projectDirectory; @@ -300,6 +304,6 @@ private function configure(InputInterface $input): void } $this->managerType = $input->getOption('manager') ?: array_keys($this->availableModelManagers)[0]; - $this->modelManager = $this->availableModelManagers[$this->managerType] ?: current($this->availableModelManagers); + $this->modelManager = $this->availableModelManagers[$this->managerType] ?? current($this->availableModelManagers); } } diff --git a/src/Manipulator/ObjectManipulator.php b/src/Manipulator/ObjectManipulator.php index 9b4a5e1fd2..5e4634600a 100644 --- a/src/Manipulator/ObjectManipulator.php +++ b/src/Manipulator/ObjectManipulator.php @@ -53,7 +53,7 @@ public static function setObject( object $object, FieldDescriptionInterface $parentFieldDescription ): object { - $mappedBy = $parentFieldDescription->getAssociationMapping()['mappedBy']; + $mappedBy = $parentFieldDescription->getAssociationMapping()['mappedBy'] ?? null; if (null === $mappedBy) { return $instance; } diff --git a/src/Model/AuditManager.php b/src/Model/AuditManager.php index 9442bd454e..e3668b3e28 100644 --- a/src/Model/AuditManager.php +++ b/src/Model/AuditManager.php @@ -21,12 +21,8 @@ final class AuditManager implements AuditManagerInterface { /** - * @var array - */ - private $classes = []; - - /** - * @var array + * @var array + * @phpstan-var array */ private $readers = []; @@ -40,12 +36,12 @@ public function __construct(ContainerInterface $container) $this->container = $container; } - public function setReader($serviceId, array $classes): void + public function setReader(string $serviceId, array $classes): void { $this->readers[$serviceId] = $classes; } - public function hasReader($class) + public function hasReader(string $class): bool { foreach ($this->readers as $classes) { if (\in_array($class, $classes, true)) { @@ -56,7 +52,7 @@ public function hasReader($class) return false; } - public function getReader($class) + public function getReader(string $class): AuditReaderInterface { foreach ($this->readers as $readerId => $classes) { if (\in_array($class, $classes, true)) { diff --git a/src/Model/AuditManagerInterface.php b/src/Model/AuditManagerInterface.php index 878d6d3acf..2cd71f33af 100644 --- a/src/Model/AuditManagerInterface.php +++ b/src/Model/AuditManagerInterface.php @@ -21,27 +21,25 @@ interface AuditManagerInterface /** * Set AuditReaderInterface service id for array of $classes. * - * @param string $serviceId + * @param string[] $classes + * + * @phpstan-param class-string[] $classes */ - public function setReader($serviceId, array $classes); + public function setReader(string $serviceId, array $classes): void; /** * Returns true if $class has AuditReaderInterface. * - * @param string $class - * - * @return bool + * @phpstan-param class-string $class */ - public function hasReader($class); + public function hasReader(string $class): bool; /** * Get AuditReaderInterface service for $class. * - * @param string $class - * * @throws \LogicException * - * @return AuditReaderInterface + * @phpstan-param class-string $class */ - public function getReader($class); + public function getReader(string $class): AuditReaderInterface; } diff --git a/src/Model/AuditReaderInterface.php b/src/Model/AuditReaderInterface.php index 83338353c4..c7a2629cd7 100644 --- a/src/Model/AuditReaderInterface.php +++ b/src/Model/AuditReaderInterface.php @@ -19,46 +19,47 @@ interface AuditReaderInterface { /** - * @param string $className - * @param string $id - * @param string $revision + * @template T of object * - * @return object + * @param mixed $id + * @param mixed $revisionId + * + * @phpstan-param class-string $className + * @phpstan-return T|null */ - public function find($className, $id, $revision); + public function find(string $className, $id, $revisionId): ?object; /** - * @param string $className - * @param int $limit - * @param int $offset - * * @return object[] + * + * @phpstan-param class-string $className */ - public function findRevisionHistory($className, $limit = 20, $offset = 0); + public function findRevisionHistory(string $className, int $limit = 20, int $offset = 0): array; /** - * @param string $classname - * @param string $revision + * @param mixed $revisionId * - * @return object + * @phpstan-param class-string $className */ - public function findRevision($classname, $revision); + public function findRevision(string $className, $revisionId): ?object; /** - * @param string $className - * @param string $id + * @param mixed $id * * @return object[] + * + * @phpstan-param class-string $className */ - public function findRevisions($className, $id); + public function findRevisions(string $className, $id): array; /** - * @param string $className - * @param int $id - * @param int $oldRevision - * @param int $newRevision + * @param mixed $id + * @param mixed $oldRevisionId + * @param mixed $newRevisionId + * + * @return array * - * @return array + * @phpstan-param class-string $className */ - public function diff($className, $id, $oldRevision, $newRevision); + public function diff(string $className, $id, $oldRevisionId, $newRevisionId): array; } diff --git a/src/Model/DatagridManagerInterface.php b/src/Model/DatagridManagerInterface.php index 822f749102..104d37491c 100644 --- a/src/Model/DatagridManagerInterface.php +++ b/src/Model/DatagridManagerInterface.php @@ -19,18 +19,18 @@ interface DatagridManagerInterface { /** - * Return _sort_order, _sort_by, _page and _per_page values. + * @return array{_page?: int, _per_page?: int, _sort_by?: string, _sort_order?: string} * - * @param string $class - * - * @return array + * @phpstan-param class-string $class */ - public function getDefaultSortValues($class); + public function getDefaultSortValues(string $class): array; /** * Return all the allowed _per_page values. * - * @return array + * @return int[] + * + * @phpstan-param class-string $class */ public function getDefaultPerPageOptions(string $class): array; } diff --git a/src/Model/LockInterface.php b/src/Model/LockInterface.php index 5ce55afb07..c03009b142 100644 --- a/src/Model/LockInterface.php +++ b/src/Model/LockInterface.php @@ -21,17 +21,12 @@ interface LockInterface extends ModelManagerInterface { /** - * @param object $object - * - * @return mixed|null + * @return mixed */ - public function getLockVersion($object); + public function getLockVersion(object $object); /** - * @param object $object - * @param mixed $expectedVersion - * * @throws LockException */ - public function lock($object, $expectedVersion); + public function lock(object $object, ?int $expectedVersion): void; } diff --git a/src/Model/ModelManagerInterface.php b/src/Model/ModelManagerInterface.php index bc5b7c32c2..2bbd1758b5 100644 --- a/src/Model/ModelManagerInterface.php +++ b/src/Model/ModelManagerInterface.php @@ -13,6 +13,7 @@ namespace Sonata\AdminBundle\Model; +use Doctrine\Common\Collections\Collection; use Sonata\AdminBundle\Admin\FieldDescriptionInterface; use Sonata\AdminBundle\Datagrid\DatagridInterface; use Sonata\AdminBundle\Datagrid\ProxyQueryInterface; @@ -25,70 +26,74 @@ interface ModelManagerInterface extends DatagridManagerInterface { /** - * @param string $class - * @param string $name + * @param array $options * - * @return FieldDescriptionInterface + * @phpstan-param class-string $class */ - public function getNewFieldDescriptionInstance($class, $name, array $options = []); + public function getNewFieldDescriptionInstance(string $class, string $name, array $options = []): FieldDescriptionInterface; /** - * @param object $object - * * @throws ModelManagerException */ - public function create($object); + public function create(object $object): void; /** - * @param object $object - * * @throws ModelManagerException */ - public function update($object); + public function update(object $object): void; /** - * @param object $object - * * @throws ModelManagerException */ - public function delete($object); + public function delete(object $object): void; /** - * @param string $class + * @template T of object + * + * @param array $criteria + * + * @return object[] all objects matching the criteria * - * @return array all objects matching the criteria + * @phpstan-param class-string $class + * @phpstan-return T[] */ - public function findBy($class, array $criteria = []); + public function findBy(string $class, array $criteria = []): array; /** - * @param string $class + * @template T of object + * + * @param array $criteria * * @return object|null an object matching the criteria or null if none match + * + * @phpstan-param class-string $class + * @phpstan-return T|null */ - public function findOneBy($class, array $criteria = []); + public function findOneBy(string $class, array $criteria = []): ?object; /** - * @param string $class - * @param mixed $id + * @template T of object + * + * @param mixed $id * * @return object|null the object with id or null if not found + * + * @phpstan-param class-string $class + * @phpstan-return T|null */ - public function find($class, $id); + public function find(string $class, $id): ?object; /** - * @param string $class - * * @throws ModelManagerException + * + * @phpstan-param class-string $class */ - public function batchDelete($class, ProxyQueryInterface $queryProxy); + public function batchDelete(string $class, ProxyQueryInterface $queryProxy): void; /** - * @param string $class - * @param string $alias - * - * @return ProxyQueryInterface + * @phpstan-param class-string $class */ - public function createQuery($class, $alias = 'o'); + public function createQuery(string $class, string $alias = 'o'): ProxyQueryInterface; /** * Get the identifiers of this model class. @@ -97,135 +102,159 @@ public function createQuery($class, $alias = 'o'); * composed of multiple columns. If you need a string representation, * use getNormalizedIdentifier resp. getUrlSafeIdentifier * - * @param object $model - * - * @return array list of all identifiers of this model + * @return mixed[] */ - public function getIdentifierValues($model); + public function getIdentifierValues(object $model): array; /** - * Get a list of the field names models of the specified class use to store - * the identifier. + * Get a list of the field names models of the specified fully qualified + * class name used to store the identifier. * - * @param string $class fully qualified class name + * @return string[] * - * @return array + * @phpstan-param class-string $class */ - public function getIdentifierFieldNames($class); + public function getIdentifierFieldNames(string $class): array; /** * Get the identifiers for this model class as a string. - * - * @param object $model - * - * @return string a string representation of the identifiers for this - * instance */ - public function getNormalizedIdentifier($model); + public function getNormalizedIdentifier(object $model): string; /** * Get the identifiers as a string that is safe to use in a url. * * This is similar to getNormalizedIdentifier but guarantees an id that can * be used in a URL. - * - * @param object $model - * - * @return string string representation of the id that is safe to use in a url */ - public function getUrlSafeIdentifier($model); + public function getUrlSafeIdentifier(object $model): string; /** * Create a new instance of the model of the specified class. * - * @param string $class + * @template T of object * - * @return object + * @phpstan-param class-string $class + * @phpstan-return T */ - public function getModelInstance($class); + public function getModelInstance(string $class): object; /** - * @param string $class + * NEXT_MAJOR: Remove this method. + * + * @deprecated since sonata-project/admin-bundle 3.x. To be removed in 4.0. Use doctrine/collections instead. * - * @return array|\ArrayAccess + * @template T of object + * + * @return Collection + * + * @phpstan-param class-string $class + * @phpstan-return Collection */ - public function getModelCollectionInstance($class); + public function getModelCollectionInstance(string $class): Collection; /** + * NEXT_MAJOR: Remove this method. + * + * @deprecated since sonata-project/admin-bundle 3.x. To be removed in 4.0. Use doctrine/collections instead. + * * Removes an element from the collection. * - * @param array $collection - * @param object $element + * @template T of object + * + * @param Collection $collection + * + * @phpstan-param Collection $collection + * @phpstan-param T $element */ - public function collectionRemoveElement(&$collection, &$element); + public function collectionRemoveElement(Collection $collection, object $element): void; /** + * NEXT_MAJOR: Remove this method. + * + * @deprecated since sonata-project/admin-bundle 3.x. To be removed in 4.0. Use doctrine/collections instead. + * * Add an element from the collection. * - * @param array $collection - * @param object $element + * @template T of object + * + * @param Collection $collection + * + * @phpstan-param Collection $collection + * @phpstan-param T $element */ - public function collectionAddElement(&$collection, &$element); + public function collectionAddElement(Collection $collection, object $element): void; /** + * NEXT_MAJOR: Remove this method. + * + * @deprecated since sonata-project/admin-bundle 3.x. To be removed in 4.0. Use doctrine/collections instead. + * * Check if the element exists in the collection. * - * @param array $collection - * @param object $element + * @template T of object + * + * @param Collection $collection * - * @return bool + * @phpstan-param Collection $collection + * @phpstan-param T $element */ - public function collectionHasElement(&$collection, &$element); + public function collectionHasElement(Collection $collection, object $element): bool; /** * Clear the collection. * - * @param array $collection + * @param Collection $collection + * + * @phpstan-param Collection $collection */ - public function collectionClear(&$collection); + public function collectionClear(Collection $collection): void; /** - * @param string $class + * @template T of object + * + * @param array $array * - * @return object + * @phpstan-param class-string $class + * @phpstan-return T */ - public function modelReverseTransform($class, array $array = []); + public function modelReverseTransform(string $class, array $array = []): object; /** - * @param string $class - * @param object $instance + * @template T of object * - * @return object + * @phpstan-param class-string $class + * @phpstan-param T $instance + * @phpstan-return T */ - public function modelTransform($class, $instance); + public function modelTransform(string $class, object $instance): object; /** - * @param mixed $query + * @return mixed */ - public function executeQuery($query); + public function executeQuery(object $query); /** - * @param int|null $firstResult - * @param int|null $maxResult - * - * @return SourceIteratorInterface + * @param string[] $fields */ public function getDataSourceIterator( DatagridInterface $datagrid, array $fields, - $firstResult = null, - $maxResult = null - ); + ?int $firstResult = null, + ?int $maxResult = null + ): SourceIteratorInterface; /** - * @param string $class - * * @return string[] + * + * @phpstan-param class-string $class */ - public function getExportFields($class); + public function getExportFields(string $class): array; /** - * @param string $class + * @param string[] $idx + * + * @phpstan-param class-string $class */ - public function addIdentifiersToQuery($class, ProxyQueryInterface $query, array $idx); + public function addIdentifiersToQuery(string $class, ProxyQueryInterface $query, array $idx): void; } diff --git a/src/Resources/config/core.xml b/src/Resources/config/core.xml index b5ec5438e3..4fcd723b6c 100644 --- a/src/Resources/config/core.xml +++ b/src/Resources/config/core.xml @@ -18,7 +18,7 @@ - + @@ -74,7 +74,6 @@ - %sonata.admin.configuration.global_search.case_sensitive% diff --git a/src/Resources/views/CRUD/base_list.html.twig b/src/Resources/views/CRUD/base_list.html.twig index cff1e0e624..f5cee2f188 100644 --- a/src/Resources/views/CRUD/base_list.html.twig +++ b/src/Resources/views/CRUD/base_list.html.twig @@ -192,7 +192,7 @@ file that was distributed with this source code.
    {% for format in export_formats %}
  • - + {{ ("export_format_" ~ format)|trans({}, 'SonataAdminBundle') }} diff --git a/src/Resources/views/Pager/base_links.html.twig b/src/Resources/views/Pager/base_links.html.twig index f16f9c07d6..273abc1a18 100644 --- a/src/Resources/views/Pager/base_links.html.twig +++ b/src/Resources/views/Pager/base_links.html.twig @@ -12,28 +12,28 @@ file that was distributed with this source code.
      {% if admin.datagrid.pager.page > 2 %} -
    • «
      • +
    • «
      • {% endif %} {% if admin.datagrid.pager.page != admin.datagrid.pager.previouspage %} -
    • ‹
      • +
    • ‹
      • {% endif %} {# Set the number of pages to display in the pager #} {% for page in admin.datagrid.pager.getLinks(admin_pool.getOption('pager_links')) %} {% if page == admin.datagrid.pager.page %} -
    • {{ page }}
      • +
    • {{ page }}
      • {% else %} -
    • {{ page }}
      • +
    • {{ page }}
      • {% endif %} {% endfor %} {% if admin.datagrid.pager.page != admin.datagrid.pager.nextpage %} -
    • ›
      • +
    • ›
      • {% endif %} {% if admin.datagrid.pager.page != admin.datagrid.pager.lastpage and admin.datagrid.pager.lastpage != admin.datagrid.pager.nextpage %} -
    • »
      • +
    • »
      • {% endif %}
    diff --git a/src/Route/RouteCollection.php b/src/Route/RouteCollection.php index 7969f91814..45723f45eb 100644 --- a/src/Route/RouteCollection.php +++ b/src/Route/RouteCollection.php @@ -21,7 +21,7 @@ final class RouteCollection implements RouteCollectionInterface { /** - * @var Route[] + * @var array */ private $elements = []; @@ -46,7 +46,7 @@ final class RouteCollection implements RouteCollectionInterface private $baseRoutePattern; /** - * @var Route[] + * @var array */ private $cachedElements = []; @@ -123,8 +123,10 @@ public function getElements(): array foreach ($this->elements as $code => $element) { $this->resolveElement($code); } + /** @var array $elements */ + $elements = $this->elements; - return $this->elements; + return $elements; } public function has(string $name): bool @@ -142,6 +144,7 @@ public function get(string $name): Route if ($this->has($name)) { $code = $this->getCode($name); $this->resolveElement($code); + \assert($this->elements[$code] instanceof Route); return $this->elements[$code]; } @@ -232,7 +235,7 @@ public function getBaseRoutePattern(): string } /** - * @param Route|callable $element + * @param Route|callable():Route $element */ private function addElement(string $code, $element): void { @@ -250,7 +253,17 @@ private function resolveElement(string $code): void $element = $this->elements[$code]; if (\is_callable($element)) { - $this->elements[$code] = $element(); + $resolvedElement = $element(); + if (!$resolvedElement instanceof Route) { + @trigger_error(sprintf( + 'Element resolved by code "%s" is not instance of "%s"; This is deprecated since sonata-project/admin-bundle 3.x and will be removed in 4.0.', + $code, + Route::class + ), E_USER_DEPRECATED); + // NEXT_MAJOR : remove the previous `trigger_error()` and throw exception + } + + $this->elements[$code] = $resolvedElement; $this->updateCachedElement($code); } } diff --git a/src/Search/SearchHandler.php b/src/Search/SearchHandler.php index 22cb00b324..cb113b8620 100644 --- a/src/Search/SearchHandler.php +++ b/src/Search/SearchHandler.php @@ -26,7 +26,7 @@ class SearchHandler { /** - * @var Pool + * @var Pool|null */ protected $pool; @@ -35,10 +35,27 @@ class SearchHandler */ private $caseSensitive; - public function __construct(Pool $pool, bool $caseSensitive) + /** + * NEXT_MAJOR: Change signature to __construct(bool $caseSensitive) and remove pool property. + * + * @param Pool|bool $deprecatedPoolOrCaseSensitive + * @param bool $caseSensitive + */ + public function __construct($deprecatedPoolOrCaseSensitive, $caseSensitive = true) { - $this->pool = $pool; - $this->caseSensitive = $caseSensitive; + if ($deprecatedPoolOrCaseSensitive instanceof Pool) { + @trigger_error(sprintf( + 'Passing %s as argument 1 to %s() is deprecated since sonata-project/admin-bundle 3.74.' + .' It will accept only bool in version 4.0.', + Pool::class, + __METHOD__ + ), E_USER_DEPRECATED); + + $this->pool = $deprecatedPoolOrCaseSensitive; + $this->caseSensitive = $caseSensitive; + } else { + $this->caseSensitive = $deprecatedPoolOrCaseSensitive; + } } /** diff --git a/src/Security/Handler/AclSecurityHandler.php b/src/Security/Handler/AclSecurityHandler.php index 6bc0dbe3d9..13b5a970fe 100644 --- a/src/Security/Handler/AclSecurityHandler.php +++ b/src/Security/Handler/AclSecurityHandler.php @@ -19,7 +19,6 @@ use Symfony\Component\Security\Acl\Domain\UserSecurityIdentity; use Symfony\Component\Security\Acl\Exception\AclNotFoundException; use Symfony\Component\Security\Acl\Exception\NotAllAclsFoundException; -use Symfony\Component\Security\Acl\Model\AclInterface; use Symfony\Component\Security\Acl\Model\MutableAclInterface; use Symfony\Component\Security\Acl\Model\MutableAclProviderInterface; use Symfony\Component\Security\Acl\Model\ObjectIdentityInterface; @@ -156,10 +155,12 @@ public function deleteObjectSecurity(AdminInterface $admin, $object): void $this->deleteAcl($objectIdentity); } - public function getObjectAcl(ObjectIdentityInterface $objectIdentity) + public function getObjectAcl(ObjectIdentityInterface $objectIdentity): ?MutableAclInterface { try { $acl = $this->aclProvider->findAcl($objectIdentity); + // todo - remove `assert` statement after https://github.com/phpstan/phpstan-symfony/pull/92 is released + \assert($acl instanceof MutableAclInterface); } catch (AclNotFoundException $e) { return null; } @@ -180,24 +181,16 @@ public function findObjectAcls(\Traversable $oids, array $sids = []) return $acls; } - public function addObjectOwner(AclInterface $acl, ?UserSecurityIdentity $securityIdentity = null): void + public function addObjectOwner(MutableAclInterface $acl, ?UserSecurityIdentity $securityIdentity = null): void { - if (!$acl instanceof MutableAclInterface) { - throw new \TypeError(sprintf( - 'Argument 1 passed to "%s()" must implement "%s".', - __METHOD__, - MutableAclInterface::class - )); - } if (false === $this->findClassAceIndexByUsername($acl, $securityIdentity->getUsername())) { // only add if not already exists $acl->insertObjectAce($securityIdentity, \constant("$this->maskBuilderClass::MASK_OWNER")); } } - public function addObjectClassAces(AclInterface $acl, array $roleInformation = []): void + public function addObjectClassAces(MutableAclInterface $acl, array $roleInformation = []): void { - \assert($acl instanceof MutableAclInterface); $builder = new $this->maskBuilderClass(); foreach ($roleInformation as $role => $permissions) { @@ -226,14 +219,13 @@ public function addObjectClassAces(AclInterface $acl, array $roleInformation = [ } } - public function createAcl(ObjectIdentityInterface $objectIdentity) + public function createAcl(ObjectIdentityInterface $objectIdentity): MutableAclInterface { return $this->aclProvider->createAcl($objectIdentity); } - public function updateAcl(AclInterface $acl): void + public function updateAcl(MutableAclInterface $acl): void { - \assert($acl instanceof MutableAclInterface); $this->aclProvider->updateAcl($acl); } @@ -242,7 +234,7 @@ public function deleteAcl(ObjectIdentityInterface $objectIdentity): void $this->aclProvider->deleteAcl($objectIdentity); } - public function findClassAceIndexByRole(AclInterface $acl, $role) + public function findClassAceIndexByRole(MutableAclInterface $acl, $role) { foreach ($acl->getClassAces() as $index => $entry) { if ($entry->getSecurityIdentity() instanceof RoleSecurityIdentity && $entry->getSecurityIdentity()->getRole() === $role) { @@ -253,7 +245,7 @@ public function findClassAceIndexByRole(AclInterface $acl, $role) return false; } - public function findClassAceIndexByUsername(AclInterface $acl, $username) + public function findClassAceIndexByUsername(MutableAclInterface $acl, $username) { foreach ($acl->getClassAces() as $index => $entry) { if ($entry->getSecurityIdentity() instanceof UserSecurityIdentity && $entry->getSecurityIdentity()->getUsername() === $username) { diff --git a/src/Security/Handler/AclSecurityHandlerInterface.php b/src/Security/Handler/AclSecurityHandlerInterface.php index 9e5b15e51a..ef6df9f1bd 100644 --- a/src/Security/Handler/AclSecurityHandlerInterface.php +++ b/src/Security/Handler/AclSecurityHandlerInterface.php @@ -14,7 +14,7 @@ namespace Sonata\AdminBundle\Security\Handler; use Symfony\Component\Security\Acl\Domain\UserSecurityIdentity; -use Symfony\Component\Security\Acl\Model\AclInterface; +use Symfony\Component\Security\Acl\Model\MutableAclInterface; use Symfony\Component\Security\Acl\Model\ObjectIdentityInterface; /** @@ -48,10 +48,8 @@ public function getObjectPermissions(); /** * Get the ACL for the passed object identity. - * - * @return AclInterface|null or NULL if not found */ - public function getObjectAcl(ObjectIdentityInterface $objectIdentity); + public function getObjectAcl(ObjectIdentityInterface $objectIdentity): ?MutableAclInterface; /** * Find the ACLs for the passed object identities. @@ -67,25 +65,29 @@ public function findObjectAcls(\Traversable $oids, array $sids = []); /** * Add an object owner ACE to the object ACL. + * + * @return void */ - public function addObjectOwner(AclInterface $acl, ?UserSecurityIdentity $securityIdentity = null); + public function addObjectOwner(MutableAclInterface $acl, ?UserSecurityIdentity $securityIdentity = null); /** * Add the object class ACE's to the object ACL. + * + * @return void */ - public function addObjectClassAces(AclInterface $acl, array $roleInformation = []); + public function addObjectClassAces(MutableAclInterface $acl, array $roleInformation = []); /** * Create an object ACL. - * - * @return AclInterface */ - public function createAcl(ObjectIdentityInterface $objectIdentity); + public function createAcl(ObjectIdentityInterface $objectIdentity): MutableAclInterface; /** * Update the ACL. + * + * @return void */ - public function updateAcl(AclInterface $acl); + public function updateAcl(MutableAclInterface $acl); /** * Delete the ACL. @@ -97,16 +99,16 @@ public function deleteAcl(ObjectIdentityInterface $objectIdentity); * * @param string $role * - * @return mixed index if found, FALSE if not found + * @return string|int|false index if found, FALSE if not found */ - public function findClassAceIndexByRole(AclInterface $acl, $role); + public function findClassAceIndexByRole(MutableAclInterface $acl, $role); /** * Helper method to find the index of a class ACE for a username. * * @param string $username * - * @return mixed index if found, FALSE if not found + * @return string|int|false index if found, FALSE if not found */ - public function findClassAceIndexByUsername(AclInterface $acl, $username); + public function findClassAceIndexByUsername(MutableAclInterface $acl, $username); } diff --git a/src/Util/AdminObjectAclData.php b/src/Util/AdminObjectAclData.php index bab1f5965c..12e5fc789c 100644 --- a/src/Util/AdminObjectAclData.php +++ b/src/Util/AdminObjectAclData.php @@ -16,7 +16,9 @@ use Sonata\AdminBundle\Admin\AdminInterface; use Sonata\AdminBundle\Security\Handler\AclSecurityHandlerInterface; use Symfony\Component\Form\Form; +use Symfony\Component\Form\FormInterface; use Symfony\Component\Security\Acl\Domain\Acl; +use Symfony\Component\Security\Acl\Model\MutableAclInterface; /** * AdminObjectAclData holds data manipulated by {@link AdminObjectAclManipulator}. @@ -58,17 +60,17 @@ class AdminObjectAclData protected $masks = []; /** - * @var Form + * @var FormInterface */ protected $aclUsersForm; /** - * @var Form + * @var FormInterface */ protected $aclRolesForm; /** - * @var Acl + * @var MutableAclInterface */ protected $acl; @@ -145,7 +147,7 @@ public function getAclRoles() * * @return AdminObjectAclData */ - public function setAcl(Acl $acl) + public function setAcl(MutableAclInterface $acl) { $this->acl = $acl; @@ -155,7 +157,7 @@ public function setAcl(Acl $acl) /** * Gets ACL. * - * @return Acl + * @return MutableAclInterface */ public function getAcl() { @@ -177,7 +179,7 @@ public function getMasks() * * @return AdminObjectAclData */ - public function setAclUsersForm(Form $form) + public function setAclUsersForm(FormInterface $form) { $this->aclUsersForm = $form; @@ -187,7 +189,7 @@ public function setAclUsersForm(Form $form) /** * Gets ACL users form. * - * @return Form + * @return FormInterface */ public function getAclUsersForm() { @@ -199,7 +201,7 @@ public function getAclUsersForm() * * @return AdminObjectAclData */ - public function setAclRolesForm(Form $form) + public function setAclRolesForm(FormInterface $form) { $this->aclRolesForm = $form; @@ -209,7 +211,7 @@ public function setAclRolesForm(Form $form) /** * Gets ACL roles form. * - * @return Form + * @return FormInterface */ public function getAclRolesForm() { diff --git a/src/Util/AdminObjectAclManipulator.php b/src/Util/AdminObjectAclManipulator.php index dfe69ff21c..9a9b440b1e 100644 --- a/src/Util/AdminObjectAclManipulator.php +++ b/src/Util/AdminObjectAclManipulator.php @@ -121,7 +121,7 @@ public function updateAclRoles(AdminObjectAclData $data): void /** * Builds ACL. */ - protected function buildAcl(AdminObjectAclData $data, Form $form, \Traversable $aclValues): void + protected function buildAcl(AdminObjectAclData $data, FormInterface $form, \Traversable $aclValues): void { $masks = $data->getMasks(); $acl = $data->getAcl(); diff --git a/tests/Admin/AdminHelperTest.php b/tests/Admin/AdminHelperTest.php index cfddc8d3d1..74865644a0 100644 --- a/tests/Admin/AdminHelperTest.php +++ b/tests/Admin/AdminHelperTest.php @@ -17,10 +17,8 @@ use Sonata\AdminBundle\Admin\AdminHelper; use Sonata\AdminBundle\Admin\AdminInterface; use Sonata\AdminBundle\Admin\FieldDescriptionInterface; -use Sonata\AdminBundle\Admin\Pool; use Sonata\AdminBundle\Tests\Fixtures\Entity\Bar; use Sonata\AdminBundle\Tests\Fixtures\Entity\Foo; -use Symfony\Component\DependencyInjection\Container; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\Form\DataMapperInterface; use Symfony\Component\Form\Extension\Core\Type\CheckboxType; @@ -30,7 +28,7 @@ use Symfony\Component\Form\FormView; use Symfony\Component\HttpFoundation\ParameterBag; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\PropertyAccess\PropertyAccessorBuilder; +use Symfony\Component\PropertyAccess\PropertyAccess; class AdminHelperTest extends TestCase { @@ -41,10 +39,7 @@ class AdminHelperTest extends TestCase protected function setUp(): void { - $container = new Container(); - - $pool = new Pool($container, 'title', 'logo.png'); - $this->helper = new AdminHelper($pool); + $this->helper = new AdminHelper(PropertyAccess::createPropertyAccessor()); } public function testGetChildFormBuilder(): void @@ -115,13 +110,6 @@ public function testItThrowsExceptionWhenDoesNotFindTheFullPath(): void public function testAppendFormFieldElement(): void { - $container = new Container(); - - $propertyAccessorBuilder = new PropertyAccessorBuilder(); - $propertyAccessor = $propertyAccessorBuilder->getPropertyAccessor(); - $pool = new Pool($container, 'title', 'logo.png', [], $propertyAccessor); - $helper = new AdminHelper($pool); - $admin = $this->createMock(AdminInterface::class); $admin ->method('getClass') @@ -211,7 +199,7 @@ public function testAppendFormFieldElement(): void $associationAdmin->expects($this->atLeastOnce())->method('setSubject')->with($bar); $admin->method('getFormBuilder')->willReturn($formBuilder); - $finalForm = $helper->appendFormFieldElement($admin, $foo, 'test_bar')[1]; + $finalForm = $this->helper->appendFormFieldElement($admin, $foo, 'test_bar')[1]; foreach ($finalForm->get($childFormBuilder->getName()) as $childField) { $this->assertFalse($childField->has('_delete')); @@ -220,7 +208,7 @@ public function testAppendFormFieldElement(): void $deleteFormBuilder = new FormBuilder('_delete', null, $eventDispatcher, $formFactory); $subChildFormBuilder->add($deleteFormBuilder, CheckboxType::class, ['delete' => false]); - $finalForm = $helper->appendFormFieldElement($admin, $foo, 'test_bar')[1]; + $finalForm = $this->helper->appendFormFieldElement($admin, $foo, 'test_bar')[1]; foreach ($finalForm->get($childFormBuilder->getName()) as $childField) { $this->assertTrue($childField->has('_delete')); diff --git a/tests/Admin/AdminTest.php b/tests/Admin/AdminTest.php index 15d81cb530..ed3127da12 100644 --- a/tests/Admin/AdminTest.php +++ b/tests/Admin/AdminTest.php @@ -1842,9 +1842,35 @@ public function testGetActionButtonsListCreateDisabled(): void ->willReturn(false); $admin->setSecurityHandler($securityHandler); + $routeGenerator = $this->createMock(RouteGeneratorInterface::class); + $routeGenerator + ->expects($this->once()) + ->method('hasAdminRoute') + ->with($admin, 'create') + ->willReturn(true); + $admin->setRouteGenerator($routeGenerator); + $this->assertSame([], $admin->getActionButtons('list', null)); } + public function testGetActionButtonsListWithoutExtraChecks(): void + { + $admin = $this->getMockBuilder(AbstractAdmin::class) + ->disableOriginalConstructor() + ->setMethodsExcept(['getActionButtons', 'configureActionButtons']) + ->getMockForAbstractClass(); + + $admin->method('isAclEnabled')->willReturn(true); + $admin->method('getExtensions')->willReturn([]); + + $admin->expects($this->exactly(9))->method('hasRoute')->willReturn(false); + $admin->expects($this->never())->method('hasAccess'); + $admin->expects($this->never())->method('getShow'); + + $this->assertSame([], $admin->getActionButtons('show')); + $this->assertSame([], $admin->getActionButtons('edit')); + } + public function testCantAccessObjectIfNullPassed(): void { $admin = new PostAdmin('sonata.post.admin.post', 'NewsBundle\Entity\Post', 'Sonata\NewsBundle\Controller\PostAdminController'); diff --git a/tests/Admin/BaseAdminModelManagerTest.php b/tests/Admin/BaseAdminModelManagerTest.php index 97fd122135..c2dbf52b1f 100644 --- a/tests/Admin/BaseAdminModelManagerTest.php +++ b/tests/Admin/BaseAdminModelManagerTest.php @@ -84,7 +84,7 @@ public function testId(): void $admin = new BaseAdminModelManager_Admin('code', 'class', 'controller'); $admin->setModelManager($modelManager); - $admin->id('Entity'); - $admin->getNormalizedIdentifier('Entity'); + $admin->id(new \stdClass()); + $admin->getNormalizedIdentifier(new \stdClass()); } } diff --git a/tests/Admin/Extension/LockExtensionTest.php b/tests/Admin/Extension/LockExtensionTest.php index fbc59873a3..6826f5f75d 100644 --- a/tests/Admin/Extension/LockExtensionTest.php +++ b/tests/Admin/Extension/LockExtensionTest.php @@ -83,9 +83,9 @@ public function testConfigureFormFields(): void $formMapper = $this->configureFormMapper(); $form = $this->configureForm(); $this->configureAdmin(null, null, $this->modelManager->reveal()); - $event = new FormEvent($form->reveal(), []); + $event = new FormEvent($form->reveal(), $this->object); - $this->modelManager->getLockVersion([])->willReturn(1); + $this->modelManager->getLockVersion($this->object)->willReturn(1); $form->add( '_lock_version', @@ -141,9 +141,9 @@ public function testConfigureFormFieldsWhenModelManagerHasNoLockedVersion(): voi $formMapper = $this->configureFormMapper(); $form = $this->configureForm(); $this->configureAdmin(null, null, $this->modelManager->reveal()); - $event = new FormEvent($form->reveal(), []); + $event = new FormEvent($form->reveal(), $this->object); - $this->modelManager->getLockVersion([])->willReturn(null); + $this->modelManager->getLockVersion($this->object)->willReturn(null); $form->add()->shouldNotBeCalled(); $this->lockExtension->configureFormFields($formMapper); diff --git a/tests/Admin/PoolTest.php b/tests/Admin/PoolTest.php index d11604f4bd..8d6c571369 100644 --- a/tests/Admin/PoolTest.php +++ b/tests/Admin/PoolTest.php @@ -340,7 +340,7 @@ public function testGetAdminByAdminCodeWithInvalidChildCode(string $adminId): vo ->willReturn($adminMock); $this->expectException(\InvalidArgumentException::class); - $this->expectExceptionMessageRegExp(sprintf( + $this->expectExceptionMessageMatches(sprintf( '{^Argument 1 passed to Sonata\\\AdminBundle\\\Admin\\\Pool::getAdminByAdminCode\(\) must contain a valid admin reference, "[^"]+" found at "%s"\.$}', $adminId )); diff --git a/tests/App/Datagrid/Datagrid.php b/tests/App/Datagrid/Datagrid.php index 8c68596233..d28b32030e 100644 --- a/tests/App/Datagrid/Datagrid.php +++ b/tests/App/Datagrid/Datagrid.php @@ -60,8 +60,9 @@ public function buildPager(): void { } - public function addFilter(FilterInterface $filter): void + public function addFilter(FilterInterface $filter): FilterInterface { + return $filter; } public function getFilters(): array diff --git a/tests/App/Datagrid/ProxyQuery.php b/tests/App/Datagrid/ProxyQuery.php index f8cb8a93af..76d2296e55 100644 --- a/tests/App/Datagrid/ProxyQuery.php +++ b/tests/App/Datagrid/ProxyQuery.php @@ -23,42 +23,50 @@ public function __call(string $name, array $args) public function execute(array $params = [], ?int $hydrationMode = null) { + throw new \BadMethodCallException('Not implemented.'); } - public function setSortBy(array $parentAssociationMappings, array $fieldMapping): void + public function setSortBy(array $parentAssociationMappings, array $fieldMapping): ProxyQueryInterface { + throw new \BadMethodCallException('Not implemented.'); } - public function getSortBy(): string + public function getSortBy(): ?string { return 'e.id'; } - public function setSortOrder(string $sortOrder): void + public function setSortOrder(string $sortOrder): ProxyQueryInterface { + throw new \BadMethodCallException('Not implemented.'); } - public function getSortOrder(): string + public function getSortOrder(): ?string { return 'ASC'; } - public function getSingleScalarResult(): ?int + /** + * NEXT_MAJOR: Remove this method. + */ + public function getSingleScalarResult() { return 0; } - public function setFirstResult(?int $firstResult): void + public function setFirstResult(?int $firstResult): ProxyQueryInterface { + throw new \BadMethodCallException('Not implemented.'); } - public function getFirstResult(): ?object + public function getFirstResult(): ?int { throw new \BadMethodCallException('Not implemented.'); } - public function setMaxResults(?int $maxResults): void + public function setMaxResults(?int $maxResults): ProxyQueryInterface { + throw new \BadMethodCallException('Not implemented.'); } public function getMaxResults(): ?int diff --git a/tests/App/Model/ModelManager.php b/tests/App/Model/ModelManager.php index 25f0f9ce2d..5a8f3c408f 100644 --- a/tests/App/Model/ModelManager.php +++ b/tests/App/Model/ModelManager.php @@ -13,12 +13,15 @@ namespace Sonata\AdminBundle\Tests\App\Model; +use Doctrine\Common\Collections\ArrayCollection; +use Doctrine\Common\Collections\Collection; use Sonata\AdminBundle\Admin\FieldDescriptionInterface; use Sonata\AdminBundle\Datagrid\DatagridInterface; use Sonata\AdminBundle\Datagrid\ProxyQueryInterface; use Sonata\AdminBundle\Model\LockInterface; use Sonata\AdminBundle\Model\ModelManagerInterface; use Sonata\AdminBundle\Tests\App\Admin\FieldDescription; +use Sonata\Exporter\Source\SourceIteratorInterface; class ModelManager implements ModelManagerInterface, LockInterface { @@ -32,7 +35,7 @@ public function __construct(FooRepository $repository) $this->repository = $repository; } - public function getNewFieldDescriptionInstance($class, $name, array $options = []) + public function getNewFieldDescriptionInstance(string $class, string $name, array $options = []): FieldDescriptionInterface { if (!isset($options['route']['name'])) { $options['route']['name'] = 'edit'; @@ -49,73 +52,63 @@ public function getNewFieldDescriptionInstance($class, $name, array $options = [ return $fieldDescription; } - public function create($object): void + public function create(object $object): void { } - public function update($object): void + public function update(object $object): void { } - public function delete($object): void + public function delete(object $object): void { } - public function findBy($class, array $criteria = []) + public function findBy(string $class, array $criteria = []): array { return []; } - public function findOneBy($class, array $criteria = []) + public function findOneBy(string $class, array $criteria = []): ?object { return null; } - public function find($class, $id) + public function find(string $class, $id): ?object { return $this->repository->byId($id); } - public function batchDelete($class, ProxyQueryInterface $queryProxy): void + public function batchDelete(string $class, ProxyQueryInterface $queryProxy): void { } - public function getParentFieldDescription($parentAssociationMapping, $class): FieldDescriptionInterface + public function createQuery(string $class, string $alias = 'o'): ProxyQueryInterface { throw new \BadMethodCallException('Not implemented.'); } - public function createQuery($class, $alias = 'o'): ProxyQueryInterface - { - throw new \BadMethodCallException('Not implemented.'); - } - - public function getModelIdentifier($class) - { - return 'id'; - } - - public function getIdentifierValues($model) + public function getIdentifierValues(object $model): array { return []; } - public function getIdentifierFieldNames($class) + public function getIdentifierFieldNames(string $class): array { return []; } - public function getNormalizedIdentifier($model) + public function getNormalizedIdentifier(object $model): string { return $model->getId(); } - public function getUrlSafeIdentifier($model) + public function getUrlSafeIdentifier(object $model): string { return $this->getNormalizedIdentifier($model); } - public function getModelInstance($class) + public function getModelInstance(string $class): object { switch ($class) { case Translated::class: @@ -125,33 +118,44 @@ public function getModelInstance($class) } } - public function getModelCollectionInstance($class) - { - return []; - } - - public function collectionRemoveElement(&$collection, &$element): void + /** + * NEXT_MAJOR: Remove this method. + */ + public function getModelCollectionInstance(string $class): Collection { + return new ArrayCollection(); } - public function collectionAddElement(&$collection, &$element): void + /** + * NEXT_MAJOR: Remove this method. + */ + public function collectionRemoveElement(Collection $collection, object $element): void { } - public function collectionHasElement(&$collection, &$element): void + /** + * NEXT_MAJOR: Remove this method. + */ + public function collectionAddElement(Collection $collection, object $element): void { } - public function collectionClear(&$collection): void + /** + * NEXT_MAJOR: Remove this method. + */ + public function collectionHasElement(Collection $collection, object $element): bool { + return true; } - public function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid) + /** + * NEXT_MAJOR: Remove this method. + */ + public function collectionClear(Collection $collection): void { - return []; } - public function getDefaultSortValues($class) + public function getDefaultSortValues(string $class): array { return []; } @@ -161,44 +165,40 @@ public function getDefaultPerPageOptions(string $class): array return []; } - public function modelReverseTransform($class, array $array = []): object + public function modelReverseTransform(string $class, array $array = []): object { throw new \BadMethodCallException('Not implemented.'); } - public function modelTransform($class, $instance): object + public function modelTransform(string $class, object $instance): object { throw new \BadMethodCallException('Not implemented.'); } - public function executeQuery($query): void - { - } - - public function getDataSourceIterator(DatagridInterface $datagrid, array $fields, $firstResult = null, $maxResult = null): void + public function executeQuery(object $query): void { } - public function getExportFields($class) + public function getDataSourceIterator(DatagridInterface $datagrid, array $fields, ?int $firstResult = null, ?int $maxResult = null): SourceIteratorInterface { - return []; + throw new \BadMethodCallException('Not implemented.'); } - public function getPaginationParameters(DatagridInterface $datagrid, $page) + public function getExportFields(string $class): array { return []; } - public function addIdentifiersToQuery($class, ProxyQueryInterface $query, array $idx): void + public function addIdentifiersToQuery(string $class, ProxyQueryInterface $query, array $idx): void { } - public function getLockVersion($object) + public function getLockVersion(object $object) { return null; } - public function lock($object, $expectedVersion) + public function lock(object $object, ?int $expectedVersion): void { } } diff --git a/tests/Command/GenerateObjectAclCommandTest.php b/tests/Command/GenerateObjectAclCommandTest.php index 0e264c0024..40dc639d6a 100644 --- a/tests/Command/GenerateObjectAclCommandTest.php +++ b/tests/Command/GenerateObjectAclCommandTest.php @@ -13,7 +13,7 @@ namespace Sonata\AdminBundle\Tests\Command; -use Doctrine\Common\Persistence\ManagerRegistry; +use Doctrine\Persistence\ManagerRegistry; use PHPUnit\Framework\TestCase; use Prophecy\Argument; use Sonata\AdminBundle\Admin\AbstractAdmin; diff --git a/tests/Controller/CRUDControllerTest.php b/tests/Controller/CRUDControllerTest.php index 2528a8ce9d..91d9fc368c 100644 --- a/tests/Controller/CRUDControllerTest.php +++ b/tests/Controller/CRUDControllerTest.php @@ -3209,8 +3209,7 @@ public function testBatchActionWithoutConfirmation(): void $modelManager->expects($this->once()) ->method('addIdentifiersToQuery') - ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])) - ->willReturn(true); + ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])); $this->expectTranslate('flash_batch_delete_success', [], 'SonataAdminBundle'); @@ -3218,8 +3217,11 @@ public function testBatchActionWithoutConfirmation(): void $this->request->request->set('data', json_encode(['action' => 'delete', 'idx' => ['123', '456'], 'all_elements' => false])); $this->request->request->set('_sonata_csrf_token', 'csrf-token-123_sonata.batch'); + $this->assertNull($this->request->get('idx')); + $result = $this->controller->batchAction($this->request); + $this->assertNull($this->request->get('idx'), 'Ensure original request is not modified by calling `CRUDController::batchAction()`.'); $this->assertInstanceOf(RedirectResponse::class, $result); $this->assertSame(['flash_batch_delete_success'], $this->session->getFlashBag()->get('sonata_flash_success')); $this->assertSame('list', $result->getTargetUrl()); @@ -3260,8 +3262,7 @@ public function testBatchActionWithoutConfirmation2(): void $modelManager->expects($this->once()) ->method('addIdentifiersToQuery') - ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])) - ->willReturn(true); + ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])); $this->expectTranslate('flash_batch_delete_success', [], 'SonataAdminBundle'); @@ -3348,8 +3349,11 @@ public function testBatchActionNonRelevantAction(): void $this->request->request->set('idx', ['789']); $this->request->request->set('_sonata_csrf_token', 'csrf-token-123_sonata.batch'); + $this->assertNull($this->request->get('all_elements')); + $result = $controller->batchAction($this->request); + $this->assertNull($this->request->get('all_elements'), 'Ensure original request is not modified by calling `CRUDController::batchAction()`.'); $this->assertInstanceOf(RedirectResponse::class, $result); $this->assertSame(['flash_batch_empty'], $this->session->getFlashBag()->get('sonata_flash_info')); $this->assertSame('list', $result->getTargetUrl()); @@ -3526,8 +3530,7 @@ public function testBatchActionWithRequesData(): void $modelManager->expects($this->once()) ->method('addIdentifiersToQuery') - ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])) - ->willReturn(true); + ->with($this->equalTo('Foo'), $this->equalTo($query), $this->equalTo(['123', '456'])); $this->expectTranslate('flash_batch_delete_success', [], 'SonataAdminBundle'); diff --git a/tests/Form/DataTransformer/ModelToIdTransformerTest.php b/tests/Form/DataTransformer/ModelToIdTransformerTest.php index 6ed190c5e6..1034b1fed3 100644 --- a/tests/Form/DataTransformer/ModelToIdTransformerTest.php +++ b/tests/Form/DataTransformer/ModelToIdTransformerTest.php @@ -33,15 +33,15 @@ public function testReverseTransformWhenPassing0AsId(): void $this->modelManager ->expects($this->exactly(2)) ->method('find') - ->willReturn(true); + ->willReturn(new \stdClass()); $this->assertFalse(\in_array(false, ['0', 0], true)); // we pass 0 as integer - $this->assertTrue($transformer->reverseTransform(0)); + $this->assertNotNull($transformer->reverseTransform(0)); // we pass 0 as string - $this->assertTrue($transformer->reverseTransform('0')); + $this->assertNotNull($transformer->reverseTransform('0')); // we pass null must return null $this->assertNull($transformer->reverseTransform(null)); @@ -76,7 +76,7 @@ public function testTransform(): void { $this->modelManager->expects($this->once()) ->method('getNormalizedIdentifier') - ->willReturn(123); + ->willReturn('123'); $transformer = new ModelToIdTransformer($this->modelManager, 'TEST'); @@ -85,6 +85,6 @@ public function testTransform(): void $this->assertNull($transformer->transform(0)); $this->assertNull($transformer->transform('0')); - $this->assertSame(123, $transformer->transform(new \stdClass())); + $this->assertSame('123', $transformer->transform(new \stdClass())); } } diff --git a/tests/Form/Type/ModelListTypeTest.php b/tests/Form/Type/ModelListTypeTest.php index 5f2bbe4a60..5e37c8124a 100644 --- a/tests/Form/Type/ModelListTypeTest.php +++ b/tests/Form/Type/ModelListTypeTest.php @@ -50,7 +50,9 @@ public function testGetDefaultOptions(): void public function testSubmitValidData(): void { - $formData = 42; + $model = new \stdClass(); + $this->modelManager->find('My\Entity', 42)->willReturn($model); + $this->modelManager->getNormalizedIdentifier($model)->willReturn('42'); $form = $this->factory->create( ModelListType::class, @@ -60,8 +62,8 @@ public function testSubmitValidData(): void 'class' => 'My\Entity', ] ); - $this->modelManager->find('My\Entity', 42)->shouldBeCalled(); - $form->submit($formData); + + $form->submit(42); $this->assertTrue($form->isSynchronized()); } } diff --git a/tests/Form/Widget/FormChoiceWidgetTest.php b/tests/Form/Widget/FormChoiceWidgetTest.php index 512d21e4d1..35fda30218 100644 --- a/tests/Form/Widget/FormChoiceWidgetTest.php +++ b/tests/Form/Widget/FormChoiceWidgetTest.php @@ -14,7 +14,6 @@ namespace Sonata\AdminBundle\Tests\Form\Widget; use Symfony\Component\Form\Extension\Core\Type\ChoiceType; -use Symfony\Component\Form\FormTypeInterface; class FormChoiceWidgetTest extends BaseWidgetTest { @@ -27,10 +26,7 @@ protected function setUp(): void public function testLabelRendering(): void { - $choices = ['some', 'choices']; - if (!method_exists(FormTypeInterface::class, 'setDefaultOptions')) { - $choices = array_flip($choices); - } + $choices = array_flip(['some', 'choices']); $choice = $this->factory->create( $this->getChoiceClass(), diff --git a/tests/Manipulator/ObjectManipulatorTest.php b/tests/Manipulator/ObjectManipulatorTest.php index b33d2c8298..114bb32dc5 100644 --- a/tests/Manipulator/ObjectManipulatorTest.php +++ b/tests/Manipulator/ObjectManipulatorTest.php @@ -88,7 +88,7 @@ public function testSetObject(): void ObjectManipulator::setObject($instance, $object, $fieldDescription); } - public function testSetObjectWithoutMappedBy(): void + public function testSetObjectWithNullMapped(): void { $fieldDescription = $this->createMock(FieldDescriptionInterface::class); $fieldDescription->expects($this->once())->method('getAssociationMapping')->willReturn(['mappedBy' => null]); @@ -96,6 +96,14 @@ public function testSetObjectWithoutMappedBy(): void ObjectManipulator::setObject(new \stdClass(), new \stdClass(), $fieldDescription); } + public function testSetObjectWithoutMappedBy(): void + { + $fieldDescription = $this->createMock(FieldDescriptionInterface::class); + $fieldDescription->expects($this->once())->method('getAssociationMapping')->willReturn([]); + + ObjectManipulator::setObject(new \stdClass(), new \stdClass(), $fieldDescription); + } + public function testSetObjectWithParentAssociation(): void { $fieldDescription = $this->createMock(FieldDescriptionInterface::class); diff --git a/tests/Search/SearchHandlerTest.php b/tests/Search/SearchHandlerTest.php index 15626835af..ae41f1bc70 100644 --- a/tests/Search/SearchHandlerTest.php +++ b/tests/Search/SearchHandlerTest.php @@ -15,30 +15,13 @@ use PHPUnit\Framework\TestCase; use Sonata\AdminBundle\Admin\AdminInterface; -use Sonata\AdminBundle\Admin\Pool; use Sonata\AdminBundle\Datagrid\DatagridInterface; use Sonata\AdminBundle\Datagrid\PagerInterface; use Sonata\AdminBundle\Filter\FilterInterface; use Sonata\AdminBundle\Search\SearchHandler; -use Symfony\Component\DependencyInjection\ContainerInterface; -use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException; class SearchHandlerTest extends TestCase { - public function getPool(?AdminInterface $admin = null): Pool - { - $container = $this->getMockForAbstractClass(ContainerInterface::class); - $container->method('get')->willReturnCallback(static function (string $id) use ($admin): AdminInterface { - if ('fake' === $id) { - throw new ServiceNotFoundException('Fake service does not exist'); - } - - return $admin; - }); - - return new Pool($container, 'title', 'logo', ['asd']); - } - public function testBuildPagerWithNoGlobalSearchField(): void { $filter = $this->getMockForAbstractClass(FilterInterface::class); @@ -51,16 +34,14 @@ public function testBuildPagerWithNoGlobalSearchField(): void $admin = $this->getMockForAbstractClass(AdminInterface::class); $admin->expects($this->once())->method('getDatagrid')->willReturn($datagrid); - $handler = new SearchHandler($this->getPool($admin), true); + $handler = new SearchHandler(true); $this->assertFalse($handler->search($admin, 'myservice')); } /** - * @test - * * @dataProvider buildPagerWithGlobalSearchFieldProvider */ - public function buildPagerWithGlobalSearchField(bool $caseSensitive): void + public function testBuildPagerWithGlobalSearchField(bool $caseSensitive): void { $filter = $this->getMockForAbstractClass(FilterInterface::class); $filter->expects($this->once())->method('getFormName')->willReturn('formName'); @@ -79,7 +60,7 @@ public function buildPagerWithGlobalSearchField(bool $caseSensitive): void $admin = $this->getMockForAbstractClass(AdminInterface::class); $admin->expects($this->once())->method('getDatagrid')->willReturn($datagrid); - $handler = new SearchHandler($this->getPool($admin), $caseSensitive); + $handler = new SearchHandler($caseSensitive); $this->assertInstanceOf(PagerInterface::class, $handler->search($admin, 'myservice')); } diff --git a/tests/Security/Handler/AclSecurityHandlerTest.php b/tests/Security/Handler/AclSecurityHandlerTest.php index 4696b4730b..e821e4e067 100644 --- a/tests/Security/Handler/AclSecurityHandlerTest.php +++ b/tests/Security/Handler/AclSecurityHandlerTest.php @@ -17,7 +17,6 @@ use Sonata\AdminBundle\Admin\AdminInterface; use Sonata\AdminBundle\Security\Acl\Permission\MaskBuilder; use Sonata\AdminBundle\Security\Handler\AclSecurityHandler; -use Symfony\Component\Security\Acl\Model\AclInterface; use Symfony\Component\Security\Acl\Model\MutableAclInterface; use Symfony\Component\Security\Acl\Model\MutableAclProviderInterface; use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface; @@ -125,40 +124,7 @@ public function testWithNonAuthenticationCredentialsNotFoundException(): void $this->assertFalse($handler->isGranted($admin, 'raise exception', $admin)); } - public function testAddObjectOwnerParamMustBeMutableAclInterface(): void - { - $this->expectException(\TypeError::class); - $this->expectExceptionMessage(sprintf( - 'Argument 1 passed to "%s::addObjectOwner()" must implement "%s".', - AclSecurityHandler::class, - MutableAclInterface::class - )); - $handler = new AclSecurityHandler( - $this->getTokenStorageMock(), - $this->getAuthorizationCheckerMock(), - $this->getMockForAbstractClass(MutableAclProviderInterface::class), - MaskBuilder::class, - [] - ); - $handler->addObjectOwner($this->createStub(AclInterface::class)); - } - - public function testUpdateAclMustOnlyAcceptMutableAclInterface(): void - { - $this->expectWarning(); - $this->expectWarningMessage('assert(): assert($acl instanceof MutableAclInterface) failed'); - $handler = new AclSecurityHandler( - $this->getTokenStorageMock(), - $this->getAuthorizationCheckerMock(), - $this->getMockForAbstractClass(MutableAclProviderInterface::class), - MaskBuilder::class, - [] - ); - $acl = $this->createStub(AclInterface::class); - $handler->updateAcl($acl); - } - - public function testSuccerfulUpdateAcl(): void + public function testSuccessfulUpdateAcl(): void { $acl = $this->createStub(MutableAclInterface::class); $aclProvider = $this->getMockForAbstractClass(MutableAclProviderInterface::class); diff --git a/tests/Util/ObjectAclManipulatorTest.php b/tests/Util/ObjectAclManipulatorTest.php index 11f05f3c11..11b4d18102 100644 --- a/tests/Util/ObjectAclManipulatorTest.php +++ b/tests/Util/ObjectAclManipulatorTest.php @@ -20,7 +20,7 @@ use Sonata\AdminBundle\Tests\Fixtures\Util\DummyObjectAclManipulator; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Security\Acl\Domain\UserSecurityIdentity; -use Symfony\Component\Security\Acl\Model\AclInterface; +use Symfony\Component\Security\Acl\Model\MutableAclInterface; use Symfony\Component\Security\Acl\Model\ObjectIdentityInterface; /** @@ -66,7 +66,7 @@ public function testConfigureAcls(): void $acls->contains(Argument::type(ObjectIdentityInterface::class)) ->shouldBeCalled() ->willReturn(false, true); - $acl = $this->prophesize(AclInterface::class)->reveal(); + $acl = $this->prophesize(MutableAclInterface::class)->reveal(); $acls->offsetGet(Argument::type(ObjectIdentityInterface::class)) ->shouldBeCalled() ->willReturn($acl); diff --git a/tests/autoload.php.dist b/tests/autoload.php.dist index cbba404890..3a2b7e8661 100644 --- a/tests/autoload.php.dist +++ b/tests/autoload.php.dist @@ -1,5 +1,11 @@