Added illustration; refs #46049 (#36)

* Added illustration; refs #46049

* Some fixes; refs #46049

* Fixed illustration; refs #46049

Author: denys202

202/build.xml

@@ -23,7 +23,7 @@
     <property name="src-dir" value="${basedir}"/>
     <property name="TARGETNAME" value="axeptiocookies"/>
     <property name="TARGETBRANCH" value="${env.GIT_BRANCH}"/>
-    <property name="TARGETVERSION" value="2.0.7"/>
+    <property name="TARGETVERSION" value="2.0.8"/>
 
     <target name="build" depends="build-common,package-zip,psvalidator"/>
 

202/test/AxeptiocookiesAddon/Service/ConfigurationServiceTest.php

@@ -200,6 +200,8 @@ protected function getEditConfigurationObject()
                     ]
                 ]
             ))
+            ->setPaint(false)
+            ->setIllustration('test.png')
             ->setModules([
                 [
                     'name' => 'ps_shoppingcart',

config/partials/service.yml

@@ -34,6 +34,7 @@ services:
       - '@AxeptiocookiesAddon\Service\ModuleService'
       - '@AxeptiocookiesAddon\Validator\ConfigurationValidator'
       - '@AxeptiocookiesAddon\Service\HookService'
+      - '@AxeptiocookiesAddon\Service\ImageService'
 
   AxeptiocookiesAddon\Cache\ProjectCache:
     class: AxeptiocookiesAddon\Cache\ProjectCache
@@ -47,6 +48,7 @@ services:
       - '@AxeptiocookiesAddon\Service\ProjectService'
       - '@AxeptiocookiesAddon\Repository\ConfigurationRepository'
       - '@AxeptiocookiesAddon\Service\ModuleService'
+      - '@AxeptiocookiesAddon\Service\ImageService'
 
   AxeptiocookiesAddon\Service\CookieService:
     class: AxeptiocookiesAddon\Service\CookieService
@@ -56,4 +58,8 @@ services:
 
   AxeptiocookiesAddon\API\Response\Factory\ResponseFactory:
     class: AxeptiocookiesAddon\API\Response\Factory\ResponseFactory
+    public: true
+
+  AxeptiocookiesAddon\Service\ImageService:
+    class: AxeptiocookiesAddon\Service\ImageService
     public: true

controllers/admin/AdminAxeptiocookiesConfiguration.php

@@ -130,6 +130,12 @@ protected function getJsVariables()
                         'modules' => $this->l('Modules', $this->controller_name),
                         'consentv2' => $this->l('Consent Mode V2', $this->controller_name),
                     ],
+                    'illustration' => $this->l('Illustration', $this->controller_name),
+                    'illustration_choose' => $this->l('Choose illustration...', $this->controller_name),
+                    'illustration_custom' => $this->l('I would like a 
+                        personalised illustration', $this->controller_name),
+                    'no_illustration' => $this->l('I don\'t want an illustration', $this->controller_name),
+                    'paint' => $this->l('Activate the paint task', $this->controller_name),
                     'project_title' => $this->l('Project ID', $this->controller_name),
                     'configuration_title' => $this->l('Configuration', $this->controller_name),
                     'shop_title' => $this->l('Shops', $this->controller_name),

controllers/admin/AdminAxeptiocookiesConfigurationAjax.php

@@ -183,6 +183,11 @@ public function displayAjaxEditConfiguration()
                 ->setMessage($configuration['message'])
                 ->setTitle($configuration['title'])
                 ->setSubtitle($configuration['subtitle'])
+                ->setHasIllustration(!empty($configuration['has_illustration']) && $configuration['has_illustration'] == 'true')
+                ->setPaint(!empty($configuration['paint']) && $configuration['paint'] == 'true')
+                ->setIllustration(!empty($configuration['illustration'])
+                    && !empty($configuration['has_illustration'])
+                    && $configuration['has_illustration'] == 'true' ? $configuration['illustration'] : null)
                 ->setIsConsentV2(!empty($configuration['is_consent_v2']) && $configuration['is_consent_v2'] == 'true')
                 ->setAnalyticsStorage(!empty($configuration['analytics_storage']) && $configuration['analytics_storage'] == 'true')
                 ->setAdStorage(!empty($configuration['ad_storage']) && $configuration['ad_storage'] == 'true')

src/Entity/AxeptioConfiguration.php

@@ -85,6 +85,16 @@ class AxeptioConfiguration extends \ObjectModel
      */
     public $ad_personalization = false;
 
+    /**
+     * @var bool
+     */
+    public $paint = true;
+
+    /**
+     * @var string|null
+     */
+    public $illustration;
+
     public function __construct($id = null, $id_lang = null, $id_shop = null, $translator = null)
     {
         parent::__construct($id, $id_lang, $id_shop, $translator);
@@ -152,6 +162,19 @@ public function __construct($id = null, $id_lang = null, $id_shop = null, $trans
                 'required' => false,
                 'validate' => 'isBool',
             ],
+            'paint' => [
+                'type' => self::TYPE_BOOL,
+                'required' => false,
+                'validate' => 'isBool',
+                'default' => '1',
+            ],
+            'illustration' => [
+                'type' => self::TYPE_STRING,
+                'required' => false,
+                'size' => 255,
+                'validate' => 'isCleanHtml',
+                'allow_null' => true,
+            ],
         ],
     ];
 
@@ -171,6 +194,8 @@ public function toArray()
             'ad_storage' => $this->ad_storage,
             'ad_user_data' => $this->ad_user_data,
             'ad_personalization' => $this->ad_personalization,
+            'paint' => $this->paint,
+            'illustration' => $this->illustration,
         ];
     }
 }

src/Model/EditConfigurationModel.php

@@ -73,6 +73,11 @@ class EditConfigurationModel implements \JsonSerializable
      */
     protected $subtitle;
 
+    /**
+     * @var string|null
+     */
+    protected $illustration;
+
     /**
      * @var bool
      */
@@ -98,6 +103,16 @@ class EditConfigurationModel implements \JsonSerializable
      */
     public $ad_personalization = false;
 
+    /**
+     * @var bool
+     */
+    public $has_illustration = false;
+
+    /**
+     * @var bool
+     */
+    public $paint = true;
+
     /**
      * @var array
      */
@@ -403,6 +418,66 @@ public function setAdPersonalization($ad_personalization)
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getIllustration()
+    {
+        return $this->illustration;
+    }
+
+    /**
+     * @param string|null $illustration
+     *
+     * @return EditConfigurationModel
+     */
+    public function setIllustration($illustration)
+    {
+        $this->illustration = $illustration;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasIllustration()
+    {
+        return $this->has_illustration;
+    }
+
+    /**
+     * @param bool $has_illustration
+     *
+     * @return EditConfigurationModel
+     */
+    public function setHasIllustration($has_illustration)
+    {
+        $this->has_illustration = $has_illustration;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getPaint()
+    {
+        return $this->paint;
+    }
+
+    /**
+     * @param bool $paint
+     *
+     * @return EditConfigurationModel
+     */
+    public function setPaint($paint)
+    {
+        $this->paint = $paint;
+
+        return $this;
+    }
+
     public function jsonSerialize()
     {
         return get_object_vars($this);

src/Model/Integration/StepModel.php

@@ -67,6 +67,11 @@ class StepModel implements \JsonSerializable
      */
     protected $subTitle = '';
 
+    /**
+     * @var bool
+     */
+    protected $disablePaint = false;
+
     /**
      * @var array<VendorModel>
      */
@@ -272,6 +277,26 @@ public function setVendors($vendors)
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function getDisablePaint()
+    {
+        return $this->disablePaint;
+    }
+
+    /**
+     * @param bool $disablePaint
+     *
+     * @return StepModel
+     */
+    public function setDisablePaint($disablePaint)
+    {
+        $this->disablePaint = $disablePaint;
+
+        return $this;
+    }
+
     public static function __set_state($array)
     {
         $obj = new StepModel();
@@ -285,6 +310,7 @@ public static function __set_state($array)
         $obj->setSubTitle($array['subTitle']);
         $obj->setTitle($array['title']);
         $obj->setVendors($array['vendors']);
+        $obj->setDisablePaint(isset($array['disablePaint']) && (bool) $array['disablePaint']);
 
         return $obj;
     }
@@ -301,6 +327,7 @@ public function toArray()
             'showToggleAllSwitch' => $this->isShowToggleAllSwitch(),
             'subTitle' => $this->getSubTitle(),
             'title' => $this->getTitle(),
+            'disablePaint' => $this->getDisablePaint(),
             'vendors' => array_map(function (VendorModel $vendorModel) {
                 return $vendorModel->toArray();
             }, $this->getVendors()),

src/Service/ConfigurationService.php

@@ -57,26 +57,33 @@ class ConfigurationService
      * @var HookService
      */
     protected $hookService;
+    /**
+     * @var ImageService
+     */
+    protected $imageService;
 
     /**
      * @param ConfigurationRepository $configurationRepository
      * @param ProjectService $projectService
      * @param ModuleService $moduleService
      * @param ConfigurationValidator $configurationValidator
      * @param HookService $hookService
+     * @param ImageService $imageService
      */
     public function __construct(
         ConfigurationRepository $configurationRepository,
         ProjectService $projectService,
         ModuleService $moduleService,
         ConfigurationValidator $configurationValidator,
-        HookService $hookService
+        HookService $hookService,
+        ImageService $imageService
     ) {
         $this->configurationRepository = $configurationRepository;
         $this->projectService = $projectService;
         $this->moduleService = $moduleService;
         $this->configurationValidator = $configurationValidator;
         $this->hookService = $hookService;
+        $this->imageService = $imageService;
     }
 
     public function createConfiguration(CreateConfigurationModel $configurationModel)
@@ -122,6 +129,14 @@ public function editConfiguration(EditConfigurationModel $configurationModel)
         $configuration->message = $configurationModel->getMessage();
         $configuration->title = $configurationModel->getTitle();
         $configuration->subtitle = $configurationModel->getSubtitle();
+        $configuration->paint = $configurationModel->getPaint();
+
+        if (!empty($configuration->illustration)) {
+            $this->imageService->deleteImage($configuration->illustration);
+        }
+        if (!empty($configurationModel->getIllustration()) && $configurationModel->hasIllustration()) {
+            $configuration->illustration = $this->imageService->saveImage($configurationModel->getIllustration());
+        }
 
         if ($configurationModel->getIsConsentV2()) {
             $configuration->is_consent_v2 = $configurationModel->getIsConsentV2();
@@ -243,6 +258,8 @@ public function getById($idObject)
             return $carry;
         });
 
+        $illustration = $this->imageService->getIllustration($moduleConfiguration);
+
         return (new EditConfigurationModel())
             ->setIdObject((int) $idObject)
             ->setLanguage(\Language::getLanguage($moduleConfiguration->id_lang))
@@ -256,6 +273,9 @@ public function getById($idObject)
             }, $moduleConfiguration->getAssociatedShops()))
             ->setModules($modules)
             ->setProject($project)
+            ->setPaint((bool) $moduleConfiguration->paint)
+            ->setHasIllustration(!empty($illustration))
+            ->setIllustration($this->imageService->getIllustration($moduleConfiguration))
             ->setIsConsentV2((bool) $moduleConfiguration->is_consent_v2)
             ->setAnalyticsStorage((bool) $moduleConfiguration->analytics_storage)
             ->setAdStorage((bool) $moduleConfiguration->ad_storage)

src/Service/HookService.php

@@ -62,22 +62,30 @@ class HookService
      */
     protected $moduleService;
 
+    /**
+     * @var ImageService
+     */
+    protected $imageService;
+
     /**
      * @param ProjectCache $projectCache
      * @param ProjectService $projectService
      * @param ConfigurationRepository $configurationRepository
      * @param ModuleService $moduleService
+     * @param ImageService $imageService
      */
     public function __construct(
         ProjectCache $projectCache,
         ProjectService $projectService,
         ConfigurationRepository $configurationRepository,
-        ModuleService $moduleService
+        ModuleService $moduleService,
+        ImageService $imageService
     ) {
         $this->projectCache = $projectCache;
         $this->projectService = $projectService;
         $this->configurationRepository = $configurationRepository;
         $this->moduleService = $moduleService;
+        $this->imageService = $imageService;
     }
 
     public function getIntegrationModelFromContext()
@@ -127,7 +135,14 @@ public function getIntegrationModelFromContext()
             $stepModel->setTitle($axeptioConfiguration->title);
             $stepModel->setSubTitle($axeptioConfiguration->subtitle);
             $stepModel->setVendors($vendors);
-
+            $stepModel->setDisablePaint(empty($axeptioConfiguration->paint));
+            $illustration = $this->imageService->getIllustration($axeptioConfiguration);
+            if (!empty($illustration)) {
+                $illustrationUrl = $this->imageService->getImageUrl($axeptioConfiguration->illustration, \Context::getContext()->shop->id);
+                if (!empty($illustrationUrl)) {
+                    $stepModel->setImage($illustrationUrl);
+                }
+            }
             $integrationModel->setModuleStep($stepModel);
         }
         if (!$axeptioConfiguration->is_consent_v2) {