fix save files & validation & i18n

thomas-kl1 · thomas-kl1 · commit bec3e4536561 · 2020-12-14T17:35:37.000+01:00
diff --git a/Controller/Adminhtml/Index/MassDelete.php b/Controller/Adminhtml/Index/MassDelete.php
@@ -64,7 +64,7 @@ public function execute()
         } catch (LocalizedException $e) {
             $this->messageManager->addErrorMessage($e->getMessage());
         } catch (Exception $e) {
-            $this->messageManager->addExceptionMessage($e, $e->getMessage());
+            $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.'));
         }
 
         return $resultRedirect;
diff --git a/Controller/Adminhtml/Index/Save.php b/Controller/Adminhtml/Index/Save.php
@@ -68,7 +68,7 @@ public function execute()
         try {
             $entityId = $this->saveHandler->execute($this->getRequest(), $this->resolveDocument())->getId();
             $this->dataPersistor->clear('document_post_data');
-            $this->messageManager->addSuccessMessage('The document has been successfully saved.');
+            $this->messageManager->addSuccessMessage(new Phrase('The document has been successfully saved.'));
         } catch (CouldNotSaveException $e) {
             $this->messageManager->addErrorMessage($e->getPrevious()->getMessage());
             $this->saveHandler->rollback($this->getRequest());
@@ -84,7 +84,7 @@ public function execute()
         $resultRedirect = $this->resultRedirectFactory->create();
         $resultRedirect->setPath('*/*/');
 
-        if ($this->getRequest()->getParam('back')) {
+        if ($this->dataPersistor->get('document_post_data') || $this->getRequest()->getParam('back')) {
             $resultRedirect->setPath('*/*/edit', ['id' => $entityId]);
         }
 
diff --git a/Controller/Adminhtml/Index/Save/FileHandler.php b/Controller/Adminhtml/Index/Save/FileHandler.php
@@ -94,7 +94,10 @@ private function processFile(DocumentTypeInterface $documentType, RequestInterfa
         $data = [];
         $fileUploader = $request->getParam('file_uploader');
 
-        if (isset($fileUploader[0]['path'], $fileUploader[0]['file'])) {
+        if (!$fileUploader) {
+            $data['file_name'] = null;
+            $data['file_path'] = null;
+        } elseif (isset($fileUploader[0]['path'], $fileUploader[0]['file'])) {
             $fileSrcPath = $fileUploader[0]['path'] . $fileUploader[0]['file'];
 
             $this->validator->validate($fileSrcPath, $documentType->getFileAllowedExtensions());
@@ -120,7 +123,9 @@ private function processImage(DocumentTypeInterface $documentType, RequestInterf
         $data = [];
         $imageUploader = $request->getParam('image_uploader');
 
-        if (isset($imageUploader[0]['path'], $imageUploader[0]['file'])) {
+        if (!$imageUploader) {
+            $data['image_file_name'] = null;
+        } elseif (isset($imageUploader[0]['path'], $imageUploader[0]['file'])) {
             $imageSrcPath = $imageUploader[0]['path'] . $imageUploader[0]['file'];
 
             $destImagePath = $this->fileHelper->getImageDestPath($documentType, $imageSrcPath);
diff --git a/Controller/Adminhtml/Type/MassDelete.php b/Controller/Adminhtml/Type/MassDelete.php
@@ -72,7 +72,7 @@ public function execute()
         } catch (LocalizedException $e) {
             $this->messageManager->addErrorMessage($e->getMessage());
         } catch (Exception $e) {
-            $this->messageManager->addExceptionMessage($e, $e->getMessage());
+            $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.'));
         }
 
         return $resultRedirect;
diff --git a/Controller/Adminhtml/Type/Save.php b/Controller/Adminhtml/Type/Save.php
@@ -68,7 +68,7 @@ public function execute()
         try {
             $entityId = $this->saveHandler->execute($this->getRequest(), $this->resolveDocumentType())->getId();
             $this->dataPersistor->clear('document_type_post_data');
-            $this->messageManager->addSuccessMessage('The document type has been successfully saved.');
+            $this->messageManager->addSuccessMessage(new Phrase('The document type has been successfully saved.'));
         } catch (CouldNotSaveException $e) {
             $this->messageManager->addErrorMessage($e->getPrevious()->getMessage());
         } catch (LocalizedException $e) {
@@ -81,7 +81,7 @@ public function execute()
         $resultRedirect = $this->resultRedirectFactory->create();
         $resultRedirect->setPath('*/*/');
 
-        if ($this->getRequest()->getParam('back')) {
+        if ($this->dataPersistor->get('document_type_post_data') || $this->getRequest()->getParam('back')) {
             $resultRedirect->setPath('*/*/edit', ['id' => $entityId]);
         }
 
diff --git a/Controller/Adminhtml/Type/Save/FileHandler.php b/Controller/Adminhtml/Type/Save/FileHandler.php
@@ -43,12 +43,16 @@ public function execute(RequestInterface $request, DocumentTypeInterface $docume
         $this->rollbackData = [];
         $imageUploader = $request->getParam('image_uploader');
 
-        if (isset($imageUploader[0]['path'], $imageUploader[0]['file'])) {
+        if (!$imageUploader) {
+            $data['default_image_file_name'] = null;
+        } elseif (isset($imageUploader[0]['path'], $imageUploader[0]['file'])) {
             $imageSrcPath = $imageUploader[0]['path'] . $imageUploader[0]['file'];
             $destImagePath = $this->fileHelper->getImageDestPath($documentType, $imageSrcPath);
             $this->rollbackData['destImagePath'] = $destImagePath;
             $this->fileHelper->moveFile($imageSrcPath, $destImagePath);
             $data['default_image_file_name'] = $this->fileHelper->getRelativeFilePath($destImagePath);
+        }
+        if ($data) {
             $documentType = $this->hydratorPool->getHydrator(DocumentTypeInterface::class)->hydrate($documentType, $data);
         }
 
diff --git a/Model/Document.php b/Model/Document.php
@@ -29,6 +29,7 @@ public function getIdentities(): array
     {
         return [
             self::CACHE_TAG . '_' . $this->getId(),
+            self::CACHE_TAG . '_' . $this->getCode(),
             DocumentType::CACHE_TAG . '_' . $this->getTypeId(),
         ];
     }
diff --git a/Model/Document/Validator/Code.php b/Model/Document/Validator/Code.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Model\Document\Validator;
+
+use Magento\Framework\Phrase;
+use Magento\Framework\Validator\AbstractValidator;
+use Opengento\Document\Api\Data\DocumentInterface;
+use Opengento\Document\Model\Validator\Code as CodeValidator;
+
+final class Code extends AbstractValidator
+{
+    /**
+     * @var CodeValidator
+     */
+    private $codeValidator;
+
+    public function __construct(
+        CodeValidator $codeValidator
+    ) {
+        $this->codeValidator = $codeValidator;
+    }
+
+    public function isValid($value): bool
+    {
+        $this->_clearMessages();
+
+        if ($value instanceof DocumentInterface) {
+            if (!$this->codeValidator->isValid($value->getCode())) {
+                $this->_addMessages($this->codeValidator->getMessages());
+            }
+        } else {
+            $this->_addMessages([new Phrase('The entity must implements "%1".', [DocumentInterface::class])]);
+        }
+
+        return !$this->hasMessages();
+    }
+}
diff --git a/Model/DocumentType.php b/Model/DocumentType.php
@@ -28,7 +28,7 @@ protected function _construct(): void
 
     public function getIdentities(): array
     {
-        return [self::CACHE_TAG . '_' . $this->getId()];
+        return [self::CACHE_TAG . '_' . $this->getId(), self::CACHE_TAG . '_' . $this->getCode()];
     }
 
     public function getId(): ?int
diff --git a/Model/DocumentType/Validator/Code.php b/Model/DocumentType/Validator/Code.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Model\DocumentType\Validator;
+
+use Magento\Framework\Phrase;
+use Magento\Framework\Validator\AbstractValidator;
+use Opengento\Document\Api\Data\DocumentTypeInterface;
+use Opengento\Document\Model\Validator\Code as CodeValidator;
+
+final class Code extends AbstractValidator
+{
+    /**
+     * @var CodeValidator
+     */
+    private $codeValidator;
+
+    public function __construct(
+        CodeValidator $codeValidator
+    ) {
+        $this->codeValidator = $codeValidator;
+    }
+
+    public function isValid($value): bool
+    {
+        $this->_clearMessages();
+
+        if ($value instanceof DocumentTypeInterface) {
+            if (!$this->codeValidator->isValid($value->getCode())) {
+                $this->_addMessages($this->codeValidator->getMessages());
+            }
+        } else {
+            $this->_addMessages([new Phrase('The entity must implements "%1".', [DocumentTypeInterface::class])]);
+        }
+
+        return !$this->hasMessages();
+    }
+}
diff --git a/Model/ResourceModel/Document.php b/Model/ResourceModel/Document.php
@@ -7,10 +7,35 @@
 
 namespace Opengento\Document\Model\ResourceModel;
 
+use Magento\Framework\Model\ResourceModel\Db\Context;
 use Magento\Framework\Model\ResourceModel\Db\VersionControl\AbstractDb;
+use Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite;
+use Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot;
+use Magento\Framework\Validator\ValidatorInterface;
 
 class Document extends AbstractDb
 {
+    /**
+     * @var ValidatorInterface
+     */
+    private $validator;
+
+    public function __construct(
+        Context $context,
+        Snapshot $entitySnapshot,
+        RelationComposite $entityRelationComposite,
+        ValidatorInterface $validator,
+        ?string $connectionName = null
+    ) {
+        $this->validator = $validator;
+        parent::__construct($context, $entitySnapshot, $entityRelationComposite, $connectionName);
+    }
+
+    public function getValidationRulesBeforeSave(): ValidatorInterface
+    {
+        return $this->validator;
+    }
+
     protected function _construct(): void
     {
         $this->_init('opengento_document', 'entity_id');
diff --git a/Model/ResourceModel/DocumentType.php b/Model/ResourceModel/DocumentType.php
@@ -7,10 +7,35 @@
 
 namespace Opengento\Document\Model\ResourceModel;
 
+use Magento\Framework\Model\ResourceModel\Db\Context;
 use Magento\Framework\Model\ResourceModel\Db\VersionControl\AbstractDb;
+use Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite;
+use Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot;
+use Magento\Framework\Validator\ValidatorInterface;
 
 class DocumentType extends AbstractDb
 {
+    /**
+     * @var ValidatorInterface
+     */
+    private $validator;
+
+    public function __construct(
+        Context $context,
+        Snapshot $entitySnapshot,
+        RelationComposite $entityRelationComposite,
+        ValidatorInterface $validator,
+        ?string $connectionName = null
+    ) {
+        $this->validator = $validator;
+        parent::__construct($context, $entitySnapshot, $entityRelationComposite, $connectionName);
+    }
+
+    public function getValidationRulesBeforeSave(): ValidatorInterface
+    {
+        return $this->validator;
+    }
+
     protected function _construct(): void
     {
         $this->_init('opengento_document_type', 'entity_id');
diff --git a/Model/Validator.php b/Model/Validator.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Model;
+
+use Magento\Framework\Validator\AbstractValidator;
+use Magento\Framework\Validator\ValidatorInterface;
+
+final class Validator extends AbstractValidator
+{
+    /**
+     * @var ValidatorInterface[]
+     */
+    private $validators;
+
+    public function __construct(
+        array $validators
+    ) {
+        $this->validators = $validators;
+    }
+
+    public function isValid($value): bool
+    {
+        $this->_clearMessages();
+
+        foreach ($this->validators as $validator) {
+            if (!$validator->isValid($value)) {
+                $this->_addMessages($validator->getMessages());
+            }
+        }
+
+        return !$this->hasMessages();
+    }
+}
diff --git a/Model/Validator/Code.php b/Model/Validator/Code.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Model\Validator;
+
+use Magento\Framework\Translate\AdapterInterface;
+use Magento\Framework\Validator\Regex;
+use Magento\Framework\Validator\ValidatorInterface;
+
+final class Code implements ValidatorInterface
+{
+    /**
+     * @var Regex
+     */
+    private $regex;
+
+    public function __construct(
+        Regex $regex
+    ) {
+        $this->regex = $regex;
+    }
+
+    public function isValid($value): bool
+    {
+        return $this->regex->isValid($value);
+    }
+
+    public function getMessages(): array
+    {
+        return $this->regex->getMessages();
+    }
+
+    public function setTranslator($translator = null): ValidatorInterface
+    {
+        return $this->regex->setTranslator($translator);
+    }
+
+    public function getTranslator(): ?AdapterInterface
+    {
+        return $this->regex->getTranslator();
+    }
+
+    public function hasTranslator(): bool
+    {
+        return $this->regex->hasTranslator();
+    }
+}
diff --git a/etc/di.xml b/etc/di.xml
diff --git a/view/adminhtml/ui_component/document_form.xml b/view/adminhtml/ui_component/document_form.xml
diff --git a/view/adminhtml/ui_component/document_type_form.xml b/view/adminhtml/ui_component/document_type_form.xml

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function execute()`
`64`	`64`	`} catch (LocalizedException $e) {`
`65`	`65`	`$this->messageManager->addErrorMessage($e->getMessage());`
`66`	`66`	`} catch (Exception $e) {`
`67`		`- $this->messageManager->addExceptionMessage($e, $e->getMessage());`
	`67`	`+ $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.'));`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`return $resultRedirect;`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function execute()`
`72`	`72`	`} catch (LocalizedException $e) {`
`73`	`73`	`$this->messageManager->addErrorMessage($e->getMessage());`
`74`	`74`	`} catch (Exception $e) {`
`75`		`- $this->messageManager->addExceptionMessage($e, $e->getMessage());`
	`75`	`+ $this->messageManager->addExceptionMessage($e, new Phrase('An error occurred on the server.'));`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`return $resultRedirect;`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ public function getIdentities(): array`
`29`	`29`	`{`
`30`	`30`	`return [`
`31`	`31`	`self::CACHE_TAG . '_' . $this->getId(),`
	`32`	`+ self::CACHE_TAG . '_' . $this->getCode(),`
`32`	`33`	`DocumentType::CACHE_TAG . '_' . $this->getTypeId(),`
`33`	`34`	`];`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ protected function _construct(): void`
`28`	`28`
`29`	`29`	`public function getIdentities(): array`
`30`	`30`	`{`
`31`		`- return [self::CACHE_TAG . '_' . $this->getId()];`
	`31`	`+ return [self::CACHE_TAG . '_' . $this->getId(), self::CACHE_TAG . '_' . $this->getCode()];`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public function getId(): ?int`