Avoid CustomerSaveManager\LegacyTrait methods and trigger deprecations (#340)

* Avoid CustomerSaveManager\LegacyTrait methods and trigger deprecations
* Update phpstan-baseline.neon

Author: blankse

phpstan-baseline.neon

@@ -205,16 +205,6 @@ parameters:
 			count: 1
 			path: src/SegmentBuilder/AgeSegmentBuilder.php
 
-		-
-			message: "#^Call to an undefined method CustomerManagementFrameworkBundle\\\\CustomerSaveManager\\\\CustomerSaveManagerInterface\\:\\:getSegmentBuildingHookEnabled\\(\\)\\.$#"
-			count: 1
-			path: src/SegmentManager/SegmentBuilderExecutor/DefaultSegmentBuilderExecutor.php
-
-		-
-			message: "#^Call to an undefined method CustomerManagementFrameworkBundle\\\\CustomerSaveManager\\\\CustomerSaveManagerInterface\\:\\:setSegmentBuildingHookEnabled\\(\\)\\.$#"
-			count: 2
-			path: src/SegmentManager/SegmentBuilderExecutor/DefaultSegmentBuilderExecutor.php
-
 		-
 			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
 			count: 1

src/CustomerSaveManager/LegacyTrait.php

@@ -19,28 +19,38 @@
 
 /**
  * @property SaveOptions $saveOptions
+ *
+ * @deprecated
  */
 trait LegacyTrait
 {
     /**
      * @return bool
-     *
-     * @deprecated
      */
     public function getSegmentBuildingHookEnabled()
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         return $this->saveOptions->isOnSaveSegmentBuildersEnabled();
     }
 
     /**
      * @param bool $segmentBuildingHookEnabled
      *
      * @return $this
-     *
-     * @deprecated
      */
     public function setSegmentBuildingHookEnabled($segmentBuildingHookEnabled)
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         if ($segmentBuildingHookEnabled) {
             $this->saveOptions->enableOnSaveSegmentBuilders();
         } else {
@@ -52,23 +62,31 @@ public function setSegmentBuildingHookEnabled($segmentBuildingHookEnabled)
 
     /**
      * @return bool
-     *
-     * @deprecated
      */
     public function getCustomerSaveValidatorEnabled()
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         return $this->saveOptions->isValidatorEnabled();
     }
 
     /**
      * @param bool $customerSaveValidatorEnabled
      *
      * @return $this
-     *
-     * @deprecated
      */
     public function setCustomerSaveValidatorEnabled($customerSaveValidatorEnabled)
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         if ($customerSaveValidatorEnabled) {
             $this->saveOptions->enableValidator();
         } else {
@@ -80,23 +98,31 @@ public function setCustomerSaveValidatorEnabled($customerSaveValidatorEnabled)
 
     /**
      * @return bool
-     *
-     * @deprecated
      */
     public function isDisableSaveHandlers()
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         return !$this->saveOptions->isSaveHandlersExecutionEnabled();
     }
 
     /**
      * @param bool $disableSaveHandlers
      *
      * @return $this
-     *
-     * @deprecated
      */
     public function setDisableSaveHandlers($disableSaveHandlers)
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         if ($disableSaveHandlers) {
             $this->saveOptions->disableSaveHandlers();
         } else {
@@ -108,23 +134,31 @@ public function setDisableSaveHandlers($disableSaveHandlers)
 
     /**
      * @return bool
-     *
-     * @deprecated
      */
     public function isDisableDuplicateIndex()
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         return !$this->saveOptions->isDuplicatesIndexEnabled();
     }
 
     /**
      * @param bool $disableDuplicateIndex
      *
      * @return $this
-     *
-     * @deprecated
      */
     public function setDisableDuplicateIndex($disableDuplicateIndex)
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         if ($disableDuplicateIndex) {
             $this->saveOptions->disableDuplicatesIndex();
         } else {
@@ -136,23 +170,31 @@ public function setDisableDuplicateIndex($disableDuplicateIndex)
 
     /**
      * @return bool
-     *
-     * @deprecated
      */
     public function isDisableQueue()
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         return !$this->saveOptions->isSegmentBuilderQueueEnabled();
     }
 
     /**
      * @param bool $disableQueue
      *
      * @return $this
-     *
-     * @deprecated
      */
     public function setDisableQueue($disableQueue)
     {
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         if ($disableQueue) {
             $this->saveOptions->disableSegmentBuilderQueue();
         } else {
@@ -167,14 +209,15 @@ public function setDisableQueue($disableQueue)
      * @param bool $disableVersions
      *
      * @return mixed
-     *
-     * @deprecated
      */
     public function saveWithDisabledHooks(CustomerInterface $customer, $disableVersions = false)
     {
-        /**
-         * @var SaveOptions $options
-         */
+        trigger_deprecation(
+            'pimcore/customer-data-framework',
+            '1.3.17',
+            sprintf('%s is deprecated.', __METHOD__)
+        );
+
         $options = $this->getSaveOptions(true);
         $options
             ->disableValidator()

src/SegmentManager/SegmentBuilderExecutor/DefaultSegmentBuilderExecutor.php

@@ -97,8 +97,9 @@ public function buildCalculatedSegments(
         $logger = $this->getLogger();
         $logger->notice('start segment building');
 
-        $backup = $this->customerSaveManager->getSegmentBuildingHookEnabled();
-        $this->customerSaveManager->setSegmentBuildingHookEnabled(false);
+        $saveOptions = $this->customerSaveManager->getSaveOptions();
+        $backup = $saveOptions->isOnSaveSegmentBuildersEnabled();
+        $saveOptions->disableOnSaveSegmentBuilders();
 
         if (!is_null($segmentBuilderServiceId)) {
             $segmentBuilders = [\Pimcore::getContainer()->get($segmentBuilderServiceId)];
@@ -330,7 +331,11 @@ public function buildCalculatedSegments(
             $flushQueue($customerQueueRemoval);
         }
 
-        $this->customerSaveManager->setSegmentBuildingHookEnabled($backup);
+        if ($backup) {
+            $saveOptions->enableOnSaveSegmentBuilders();
+        } else {
+            $saveOptions->disableOnSaveSegmentBuilders();
+        }
     }
 
     protected function getIntOption(array $options, $option)