Codeception/Symfony: Fix deprecations (#339)

blankse · dvesh3 · web-flow · commit 33b42377f0fd · 2022-10-18T13:34:21.000+02:00
* Codeception: Fix deprecations

* Inline PhpDoc without variable name makes no effect

* More specific array docs

* Fix deprecations from Symfony Toolbar

* Fix PhpStan

* Apply suggestions from code review

Co-authored-by: Divesh Pahuja &lt;divesh.pahuja@pimcore.com&gt;

Co-authored-by: Divesh Pahuja &lt;divesh.pahuja@pimcore.com&gt;
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -190,11 +190,6 @@ parameters:
 			count: 1
 			path: src/Security/SsoIdentity/DefaultSsoIdentityService.php
 
-		-
-			message: "#^Method CustomerManagementFrameworkBundle\\\\Security\\\\UserProvider\\\\CustomerObjectUserProvider\\:\\:refreshUser\\(\\) should return Symfony\\\\Component\\\\Security\\\\Core\\\\User\\\\UserInterface but returns CustomerManagementFrameworkBundle\\\\Model\\\\CustomerInterface\\|null\\.$#"
-			count: 1
-			path: src/Security/UserProvider/CustomerObjectUserProvider.php
-
 		-
 			message: "#^Binary operation \"\\|\" between string and 0 results in an error\\.$#"
 			count: 1
diff --git a/src/Command/ActionTriggerQueueCommand.php b/src/Command/ActionTriggerQueueCommand.php
@@ -49,8 +49,10 @@ protected function configure()
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
+     *
+     * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $this->lock(self::LOCK_KEY);
 
diff --git a/src/Command/BuildSegmentsCommand.php b/src/Command/BuildSegmentsCommand.php
@@ -81,8 +81,10 @@ protected function configure()
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
+     *
+     * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $customQueue = null;
         if ($input->getOption('customer')) {
diff --git a/src/Command/CronTriggerCommand.php b/src/Command/CronTriggerCommand.php
@@ -45,8 +45,10 @@ protected function configure()
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
+     *
+     * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $logger = $this->getLogger();
 
diff --git a/src/Command/DuplicatesIndexCommand.php b/src/Command/DuplicatesIndexCommand.php
@@ -47,8 +47,10 @@ protected function configure()
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
+     *
+     * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $logger = $this->getLogger();
 
diff --git a/src/Command/MaintenanceCommand.php b/src/Command/MaintenanceCommand.php
@@ -51,7 +51,7 @@ protected function configure()
      *
      * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $this->maintenanceWorker->execute();
 
diff --git a/src/Command/SegmentAssignmentIndexCommand.php b/src/Command/SegmentAssignmentIndexCommand.php
@@ -41,7 +41,13 @@ protected function configure()
             ->setDescription('Processes entries from segment assignment queue, use this for manually updating the index, which is usually done during cmf:maintenance');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)//: int
     {
         $this->indexer->processQueue();
 
diff --git a/src/Controller/Rest/AbstractRestController.php b/src/Controller/Rest/AbstractRestController.php
@@ -34,8 +34,10 @@ abstract class AbstractRestController extends AdminController
 
     /**
      * @inheritDoc
+     *
+     * @return bool
      */
-    public function needsSessionDoubleAuthenticationCheck()
+    public function needsSessionDoubleAuthenticationCheck()//: bool
     {
         // do not double-check session as api key auth is possible
         return false;
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -23,7 +23,10 @@
 
 class Configuration implements ConfigurationInterface
 {
-    public function getConfigTreeBuilder()
+    /**
+     * @return TreeBuilder
+     */
+    public function getConfigTreeBuilder()//: TreeBuilder
     {
         $treeBuilder = new TreeBuilder('pimcore_customer_management_framework');
         $rootNode = $treeBuilder->getRootNode();
diff --git a/src/Event/Frontend/UrlActivityTracker.php b/src/Event/Frontend/UrlActivityTracker.php
@@ -28,8 +28,10 @@ class UrlActivityTracker implements EventSubscriberInterface
 
     /**
      * @inheritDoc
+     *
+     * @return array<string, string>
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents()//: array
     {
         return [
             KernelEvents::REQUEST => 'onKernelRequest',
diff --git a/src/Installer.php b/src/Installer.php
@@ -44,8 +44,10 @@ public function install()
 
     /**
      * {@inheritdoc}
+     *
+     * @return bool
      */
-    public function needsReloadAfterInstall()
+    public function needsReloadAfterInstall()//: bool
     {
         return true;
     }
diff --git a/src/Model/ActionTrigger/Rule/Listing.php b/src/Model/ActionTrigger/Rule/Listing.php
@@ -23,15 +23,20 @@
  */
 class Listing extends AbstractListing
 {
-    public function isValidOrderKey($key)
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
+    public function isValidOrderKey(/* string */ $key)//: bool
     {
         return true;
     }
 
     /**
      * @return Rule[]
      */
-    public function load()
+    public function load()//: array
     {
         return $this->getDao()->load();
     }
diff --git a/src/Model/ActionTrigger/Rule/Listing/Dao.php b/src/Model/ActionTrigger/Rule/Listing/Dao.php
@@ -20,7 +20,10 @@
 
 class Dao extends Model\Listing\Dao\AbstractDao
 {
-    public function load()
+    /**
+     * @return Rule[]
+     */
+    public function load()//: array
     {
         $rules = [];
 
@@ -39,7 +42,7 @@ public function load()
     /**
      * @return int
      */
-    public function getTotalCount()
+    public function getTotalCount()//: int
     {
         return (int)$this->db->fetchOne(
             'SELECT COUNT(*) as amount FROM '.Rule\Dao::TABLE_NAME.' '.$this->getCondition(),
diff --git a/src/Model/ActivityList/DefaultMariaDbActivityList.php b/src/Model/ActivityList/DefaultMariaDbActivityList.php
@@ -17,6 +17,7 @@
 
 use CustomerManagementFrameworkBundle\Model\ActivityInterface;
 use CustomerManagementFrameworkBundle\Model\ActivityList\DefaultMariaDbActivityList\MariaDbDao;
+use CustomerManagementFrameworkBundle\Model\ActivityStoreEntry\ActivityStoreEntryInterface;
 use Pimcore\Model\Listing\AbstractListing;
 
 class DefaultMariaDbActivityList extends AbstractListing implements ActivityListInterface
@@ -197,7 +198,10 @@ public function rewind()/* : void */
         reset($this->activities);
     }
 
-    public function load()
+    /**
+     * @return ActivityStoreEntryInterface[]
+     */
+    public function load()//: array
     {
         $raw = $this->dao->load();
 
@@ -214,7 +218,12 @@ public function load()
         return $activities;
     }
 
-    public function isValidOrderKey($key)
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
+    public function isValidOrderKey(/* string */ $key)//: bool
     {
         return true;
     }
diff --git a/src/Model/CustomerInterface.php b/src/Model/CustomerInterface.php
@@ -39,19 +39,19 @@ public static function classId();
     public function getPublished();
 
     /**
-     * @return bool
+     * @return bool|null
      */
     public function getActive(): ?bool;
 
     /**
-     * @param bool $active
+     * @param bool|null $active
      *
      * @return void
      */
     public function setActive(?bool $active);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getGender(): ?string;
 
@@ -63,7 +63,7 @@ public function getGender(): ?string;
     public function setGender(?string $gender);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getFirstname(): ?string;
 
@@ -75,7 +75,7 @@ public function getFirstname(): ?string;
     public function setFirstname(?string $firstname);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getLastname(): ?string;
 
@@ -87,7 +87,7 @@ public function getLastname(): ?string;
     public function setLastname(?string $lastname);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getStreet(): ?string;
 
@@ -99,7 +99,7 @@ public function getStreet(): ?string;
     public function setStreet(?string $street);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getZip(): ?string;
 
@@ -111,7 +111,7 @@ public function getZip(): ?string;
     public function setZip(?string $zip);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getCity(): ?string;
 
@@ -123,7 +123,7 @@ public function getCity(): ?string;
     public function setCity(?string $city);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getCountryCode(): ?string;
 
@@ -135,7 +135,7 @@ public function getCountryCode(): ?string;
     public function setCountryCode(?string $countryCode);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getEmail(): ?string;
 
@@ -147,7 +147,7 @@ public function getEmail(): ?string;
     public function setEmail(?string $email);
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getPhone(): ?string;
 
@@ -193,7 +193,7 @@ public function setCalculatedSegments(?array $segments);
     public function getAllSegments();
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getIdEncoded(): ?string;
 
diff --git a/src/Model/CustomerView/FilterDefinition/Listing.php b/src/Model/CustomerView/FilterDefinition/Listing.php
@@ -55,7 +55,12 @@ public function setFilterDefinitions($filterDefinitions)
         return $this;
     }
 
-    public function isValidOrderKey($key)
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
+    public function isValidOrderKey(/* string */ $key)//: bool
     {
         return $key != 'definition';
     }
diff --git a/src/Newsletter/Queue/DefaultNewsletterQueue.php b/src/Newsletter/Queue/DefaultNewsletterQueue.php
@@ -203,9 +203,6 @@ public function getQueueSize()
      */
     protected function processAllItems(array $newsletterProviderHandlers, $forceUpdate)
     {
-        /**
-         * @var CustomerProviderInterface
-         */
         $customerProvider = \Pimcore::getContainer()->get('cmf.customer_provider');
 
         $list = $customerProvider->getList();
@@ -346,9 +343,6 @@ protected function createUpdateItem(CustomerInterface $customer)
      */
     protected function createItemFromData(array $data)
     {
-        /**
-         * @var CustomerProviderInterface
-         */
         $customerProvider = \Pimcore::getContainer()->get('cmf.customer_provider');
 
         $customer = $customerProvider->getById($data['customerId']);
diff --git a/src/Security/Guard/WebserviceAuthenticator.php b/src/Security/Guard/WebserviceAuthenticator.php
diff --git a/src/Security/UserProvider/CustomerObjectUserProvider.php b/src/Security/UserProvider/CustomerObjectUserProvider.php
diff --git a/src/Targeting/EventListener/ElementSegmentsListener.php b/src/Targeting/EventListener/ElementSegmentsListener.php
diff --git a/src/Targeting/EventListener/TargetingToolbarListener.php b/src/Targeting/EventListener/TargetingToolbarListener.php

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ protected function configure()`
`51`	`51`	`*`
`52`	`52`	`* @return int`
`53`	`53`	`*/`
`54`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`54`	`+ protected function execute(InputInterface $input, OutputInterface $output)//: int`
`55`	`55`	`{`
`56`	`56`	`$this->maintenanceWorker->execute();`
`57`	`57`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,13 @@ protected function configure()`
`41`	`41`	`->setDescription('Processes entries from segment assignment queue, use this for manually updating the index, which is usually done during cmf:maintenance');`
`42`	`42`	`}`
`43`	`43`
`44`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`44`	`+ /**`
	`45`	`+ * @param InputInterface $input`
	`46`	`+ * @param OutputInterface $output`
	`47`	`+ *`
	`48`	`+ * @return int`
	`49`	`+ */`
	`50`	`+ protected function execute(InputInterface $input, OutputInterface $output)//: int`
`45`	`51`	`{`
`46`	`52`	`$this->indexer->processQueue();`
`47`	`53`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,10 @@`
`23`	`23`
`24`	`24`	`class Configuration implements ConfigurationInterface`
`25`	`25`	`{`
`26`		`- public function getConfigTreeBuilder()`
	`26`	`+ /**`
	`27`	`+ * @return TreeBuilder`
	`28`	`+ */`
	`29`	`+ public function getConfigTreeBuilder()//: TreeBuilder`
`27`	`30`	`{`
`28`	`31`	`$treeBuilder = new TreeBuilder('pimcore_customer_management_framework');`
`29`	`32`	`$rootNode = $treeBuilder->getRootNode();`