From 50ce14ee82f9a6b7a2da2668b13df7fd25dac162 Mon Sep 17 00:00:00 2001 From: Aleksey Gorbulin Date: Fri, 21 Dec 2018 16:57:33 +0200 Subject: [PATCH 1/2] Refactoring-Magento_SalesSequence - remove unused classes - enrich/fix PHPDocs --- app/code/Magento/SalesRule/Model/Coupon.php | 6 +++--- app/code/Magento/SalesSequence/Model/Manager.php | 4 +++- .../SalesSequence/Model/ResourceModel/Meta.php | 11 +++++++++-- .../SalesSequence/Model/ResourceModel/Profile.php | 1 - .../Observer/SequenceCreatorObserver.php | 8 ++++++-- .../Magento/SalesSequence/Setup/SequenceCreator.php | 2 ++ 6 files changed, 23 insertions(+), 9 deletions(-) diff --git a/app/code/Magento/SalesRule/Model/Coupon.php b/app/code/Magento/SalesRule/Model/Coupon.php index ee1eaff08303c..3c579e29a4264 100644 --- a/app/code/Magento/SalesRule/Model/Coupon.php +++ b/app/code/Magento/SalesRule/Model/Coupon.php @@ -39,10 +39,10 @@ protected function _construct() /** * Set rule instance * - * @param \Magento\SalesRule\Model\Rule $rule + * @param Rule $rule * @return $this */ - public function setRule(\Magento\SalesRule\Model\Rule $rule) + public function setRule(Rule $rule) { $this->setRuleId($rule->getId()); return $this; @@ -51,7 +51,7 @@ public function setRule(\Magento\SalesRule\Model\Rule $rule) /** * Load primary coupon for specified rule * - * @param \Magento\SalesRule\Model\Rule|int $rule + * @param Rule|int $rule * @return $this */ public function loadPrimaryByRule($rule) diff --git a/app/code/Magento/SalesSequence/Model/Manager.php b/app/code/Magento/SalesSequence/Model/Manager.php index d18a872bf3b62..95c7847bf9769 100644 --- a/app/code/Magento/SalesSequence/Model/Manager.php +++ b/app/code/Magento/SalesSequence/Model/Manager.php @@ -41,7 +41,9 @@ public function __construct( * * @param string $entityType * @param int $storeId - * @return \Magento\Framework\DB\Sequence\SequenceInterface + * + * @return \Magento\SalesSequence\Model\Sequence + * @throws \Magento\Framework\Exception\LocalizedException */ public function getSequence($entityType, $storeId) { diff --git a/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php b/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php index 10cf903d0baed..5975e635198dc 100644 --- a/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php +++ b/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php @@ -95,7 +95,9 @@ public function loadByEntityTypeAndStore($entityType, $storeId) * Using for load sequence profile and setting it into metadata * * @param \Magento\Framework\Model\AbstractModel $object - * @return $this + * + * @return $this|\Magento\Framework\Model\ResourceModel\Db\AbstractDb + * @throws \Magento\Framework\Exception\LocalizedException */ protected function _afterLoad(\Magento\Framework\Model\AbstractModel $object) { @@ -131,7 +133,12 @@ protected function _beforeSave(\Magento\Framework\Model\AbstractModel $object) } /** - * @inheritdoc + * Perform actions after object save + * + * @param \Magento\Framework\Model\AbstractModel $object + * + * @return $this|\Magento\Framework\Model\ResourceModel\Db\AbstractDb + * @throws \Magento\Framework\Exception\AlreadyExistsException */ protected function _afterSave(\Magento\Framework\Model\AbstractModel $object) { diff --git a/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php b/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php index 368bdf6c26f16..4f1788b0ca353 100644 --- a/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php +++ b/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php @@ -5,7 +5,6 @@ */ namespace Magento\SalesSequence\Model\ResourceModel; -use Magento\SalesSequence\Model\Meta as ModelMeta; use Magento\Framework\Model\ResourceModel\Db\Context as DatabaseContext; use Magento\SalesSequence\Model\ProfileFactory; diff --git a/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php b/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php index cc828e7d36a45..22f8095fc319c 100644 --- a/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php +++ b/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php @@ -49,8 +49,12 @@ public function __construct( } /** - * @param EventObserver $observer - * @return $this + * Observer triggered during adding new store + * + * @param \Magento\Framework\Event\Observer $observer + * + * @return $this|void + * @throws \Magento\Framework\Exception\AlreadyExistsException */ public function execute(EventObserver $observer) { diff --git a/app/code/Magento/SalesSequence/Setup/SequenceCreator.php b/app/code/Magento/SalesSequence/Setup/SequenceCreator.php index b0cbf545957bd..14df80224e2ce 100644 --- a/app/code/Magento/SalesSequence/Setup/SequenceCreator.php +++ b/app/code/Magento/SalesSequence/Setup/SequenceCreator.php @@ -49,6 +49,8 @@ public function __construct( /** * Creates sales sequences. + * + * @throws \Magento\Framework\Exception\AlreadyExistsException */ public function create() { From a5b4dcb670b707de61df946469a2bd3f539c4065 Mon Sep 17 00:00:00 2001 From: Aleksey Gorbulin Date: Fri, 21 Dec 2018 17:02:19 +0200 Subject: [PATCH 2/2] Refactoring-Magento_SalesSequence --- app/code/Magento/SalesSequence/Model/Manager.php | 2 +- .../Magento/SalesSequence/Observer/SequenceCreatorObserver.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/app/code/Magento/SalesSequence/Model/Manager.php b/app/code/Magento/SalesSequence/Model/Manager.php index 95c7847bf9769..95b26ba425cf6 100644 --- a/app/code/Magento/SalesSequence/Model/Manager.php +++ b/app/code/Magento/SalesSequence/Model/Manager.php @@ -42,7 +42,7 @@ public function __construct( * @param string $entityType * @param int $storeId * - * @return \Magento\SalesSequence\Model\Sequence + * @return \Magento\Framework\DB\Sequence\SequenceInterface * @throws \Magento\Framework\Exception\LocalizedException */ public function getSequence($entityType, $storeId) diff --git a/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php b/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php index 22f8095fc319c..cf56c96fb1710 100644 --- a/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php +++ b/app/code/Magento/SalesSequence/Observer/SequenceCreatorObserver.php @@ -51,7 +51,7 @@ public function __construct( /** * Observer triggered during adding new store * - * @param \Magento\Framework\Event\Observer $observer + * @param EventObserver $observer * * @return $this|void * @throws \Magento\Framework\Exception\AlreadyExistsException