Clean code

mageplaza · Jul 18, 2019 · 560aec7 · 560aec7
1 parent 79fff61
commit 560aec7
Show file tree

Hide file tree

Showing 138 changed files with 1,147 additions and 865 deletions.
diff --git a/Block/Adminhtml/Author/Edit.php b/Block/Adminhtml/Author/Edit.php
@@ -24,6 +24,7 @@
 use Magento\Backend\Block\Widget\Context;
 use Magento\Backend\Block\Widget\Form\Container;
 use Magento\Framework\Registry;
+use Mageplaza\Blog\Model\Author;
 
 /**
  * Class Edit
@@ -32,15 +33,15 @@
 class Edit extends Container
 {
     /**
-     * @var \Magento\Framework\Registry
+     * @var Registry
      */
     public $coreRegistry;
 
     /**
      * Edit constructor.
      *
-     * @param \Magento\Backend\Block\Widget\Context $context
-     * @param \Magento\Framework\Registry $coreRegistry
+     * @param Context $context
+     * @param Registry $coreRegistry
      * @param array $data
      */
     public function __construct(
@@ -89,7 +90,7 @@ protected function _construct()
      */
     public function getHeaderText()
     {
-        /** @var \Mageplaza\Blog\Model\Author $author */
+        /** @var Author $author */
         $author = $this->coreRegistry->registry('mageplaza_blog_author');
         if ($author->getId()) {
             return __("Edit Author '%1'", $this->escapeHtml($author->getName()));

diff --git a/Block/Adminhtml/Category/Edit.php b/Block/Adminhtml/Category/Edit.php
@@ -21,9 +21,10 @@
 
 namespace Mageplaza\Blog\Block\Adminhtml\Category;
 
+use Magento\Backend\Block\Widget\Context;
 use Magento\Backend\Block\Widget\Form\Container;
 use Magento\Framework\Registry;
-use Magento\Backend\Block\Widget\Context;
+use Mageplaza\Blog\Model\Category;
 
 /**
  * Class Edit
@@ -40,6 +41,7 @@ class Edit extends Container
 
     /**
      * Edit constructor.
+     *
      * @param Context $context
      * @param array $data
      */
@@ -64,15 +66,15 @@ protected function _construct()
 
         parent::_construct();
 
-        /** @var \Mageplaza\Blog\Model\Category $category */
+        /** @var Category $category */
         $category = $this->coreRegistry->registry('category');
 
         if ($category->getId() && !$category->getDuplicate()) {
             $this->buttonList->add(
                 'duplicate',
                 [
-                    'label' => __('Duplicate'),
-                    'class' => 'duplicate',
+                    'label'   => __('Duplicate'),
+                    'class'   => 'duplicate',
                     'onclick' => sprintf("location.href = '%s';", $this->getDuplicateUrl()),
                 ],
                 -101
@@ -90,8 +92,12 @@ protected function _construct()
      */
     protected function getDuplicateUrl()
     {
-        /** @var \Mageplaza\Blog\Model\Category $category */
+        /** @var Category $category */
         $category = $this->coreRegistry->registry('category');
-        return $this->getUrl('*/*/duplicate', ['id' => $category->getId(), 'duplicate' => true, 'parent'=> $category->getParentId()]);
+
+        return $this->getUrl(
+            '*/*/duplicate',
+            ['id' => $category->getId(), 'duplicate' => true, 'parent' => $category->getParentId()]
+        );
     }
 }
diff --git a/Block/Adminhtml/Category/Edit/Form.php b/Block/Adminhtml/Category/Edit/Form.php
@@ -26,8 +26,11 @@
 use Magento\Catalog\Model\Category;
 use Magento\Catalog\Model\CategoryFactory;
 use Magento\Catalog\Model\ResourceModel\Category\Tree;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Json\EncoderInterface;
+use Magento\Framework\Phrase;
 use Magento\Framework\Registry;
+use Magento\Framework\View\Element\BlockInterface;
 use Mageplaza\Blog\Model\CategoryFactory as BlogCategoryFactory;
 use Mageplaza\Blog\Model\ResourceModel\Category\Tree as BlogResourceTree;
 
@@ -48,7 +51,7 @@ class Form extends AbstractCategory
     protected $_template = 'category/edit/form.phtml';
 
     /**
-     * @var \Magento\Framework\Json\EncoderInterface
+     * @var EncoderInterface
      */
     public $jsonEncoder;
 
@@ -61,7 +64,7 @@ class Form extends AbstractCategory
      * @param CategoryFactory $categoryFactory
      * @param BlogResourceTree $blogCategoryTree
      * @param BlogCategoryFactory $blogCategoryFactory
-     * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
+     * @param EncoderInterface $jsonEncoder
      * @param array $data
      */
     public function __construct(
@@ -96,13 +99,13 @@ protected function _prepareLayout()
 
         // Save button
         $this->addButton('save', [
-            'id' => 'save',
-            'label' => __('Save Category'),
-            'class' => 'save primary save-category',
+            'id'             => 'save',
+            'label'          => __('Save Category'),
+            'class'          => 'save primary save-category',
             'data_attribute' => [
                 'mage-init' => [
                     'Mageplaza_Blog/category/edit' => [
-                        'url' => $this->getSaveUrl(),
+                        'url'  => $this->getSaveUrl(),
                         'ajax' => true
                     ]
                 ]
@@ -112,23 +115,23 @@ protected function _prepareLayout()
         // Delete button
         if ($categoryId && !in_array($categoryId, $this->getRootIds()) && !$this->getRequest()->getParam('duplicate')) {
             $this->addButton('delete', [
-                'id' => 'delete',
-                'label' => __('Delete Category'),
+                'id'      => 'delete',
+                'label'   => __('Delete Category'),
                 'onclick' => "categoryDelete('" . $this->getUrl(
-                        'mageplaza_blog/*/delete',
-                        ['_current' => true]
-                    ) . "')",
-                'class' => 'delete'
+                    'mageplaza_blog/*/delete',
+                    ['_current' => true]
+                ) . "')",
+                'class'   => 'delete'
             ]);
         }
 
         // Reset button
         $resetPath = $categoryId ? 'mageplaza_blog/*/edit' : 'mageplaza_blog/*/add';
         $this->addButton('reset', [
-            'id' => 'reset',
-            'label' => __('Reset'),
+            'id'      => 'reset',
+            'label'   => __('Reset'),
             'onclick' => "categoryReset('" . $this->getUrl($resetPath, ['_current' => true]) . "',false)",
-            'class' => 'reset'
+            'class'   => 'reset'
         ]);
 
         return parent::_prepareLayout();
@@ -188,7 +191,7 @@ public function getEditUrl()
      * @param $config
      *
      * @return $this
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function addAdditionalButton($alias, $config)
     {
@@ -234,7 +237,7 @@ public function getTabsHtml()
     }
 
     /**
-     * @return \Magento\Framework\Phrase|string
+     * @return Phrase|string
      */
     public function getHeader()
     {
@@ -302,7 +305,7 @@ public function getCategoryId()
      * @param $buttonId
      * @param array $data
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function addButton($buttonId, array $data)
     {
@@ -319,7 +322,7 @@ public function addButton($buttonId, array $data)
 
     /**
      * @return bool
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function hasToolbarBlock()
     {
@@ -330,8 +333,8 @@ public function hasToolbarBlock()
      * @param $childId
      * @param null $blockClassName
      *
-     * @return \Magento\Framework\View\Element\BlockInterface
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @return BlockInterface
+     * @throws LocalizedException
      */
     public function getButtonChildBlock($childId, $blockClassName = null)
     {

diff --git a/Block/Adminhtml/Category/Edit/Tab/Category.php b/Block/Adminhtml/Category/Edit/Tab/Category.php
@@ -28,6 +28,7 @@
 use Magento\Config\Model\Config\Source\Design\Robots;
 use Magento\Config\Model\Config\Source\Enabledisable;
 use Magento\Config\Model\Config\Source\Yesno;
+use Magento\Framework\Data\Form\Element\Renderer\RendererInterface;
 use Magento\Framework\Data\FormFactory;
 use Magento\Framework\Registry;
 use Magento\Store\Model\System\Store;
@@ -41,43 +42,43 @@ class Category extends Generic implements TabInterface
     /**
      * Wysiwyg config
      *
-     * @var \Magento\Cms\Model\Wysiwyg\Config
+     * @var Config
      */
     protected $wysiwygConfig;
 
     /**
      * Country options
      *
-     * @var \Magento\Config\Model\Config\Source\Yesno
+     * @var Yesno
      */
     protected $booleanOptions;
 
     /**
-     * @var \Magento\Config\Model\Config\Source\Enabledisable
+     * @var Enabledisable
      */
     protected $enableDisable;
 
     /**
-     * @var \Magento\Config\Model\Config\Source\Design\Robots
+     * @var Robots
      */
     protected $metaRobotsOptions;
 
     /**
-     * @var \Magento\Store\Model\System\Store
+     * @var Store
      */
     protected $systemStore;
 
     /**
      * Category constructor.
      *
-     * @param \Magento\Backend\Block\Template\Context $context
-     * @param \Magento\Framework\Registry $registry
-     * @param \Magento\Framework\Data\FormFactory $formFactory
-     * @param \Magento\Cms\Model\Wysiwyg\Config $wysiwygConfig
-     * @param \Magento\Config\Model\Config\Source\Yesno $booleanOptions
-     * @param \Magento\Config\Model\Config\Source\Enabledisable $enableDisable
-     * @param \Magento\Config\Model\Config\Source\Design\Robots $metaRobotsOptions
-     * @param \Magento\Store\Model\System\Store $systemStore
+     * @param Context $context
+     * @param Registry $registry
+     * @param FormFactory $formFactory
+     * @param Config $wysiwygConfig
+     * @param Yesno $booleanOptions
+     * @param Enabledisable $enableDisable
+     * @param Robots $metaRobotsOptions
+     * @param Store $systemStore
      * @param array $data
      */
     public function __construct(
@@ -142,7 +143,7 @@ protected function _prepareForm()
         ]);
 
         if (!$this->_storeManager->isSingleStoreMode()) {
-            /** @var \Magento\Framework\Data\Form\Element\Renderer\RendererInterface $rendererBlock */
+            /** @var RendererInterface $rendererBlock */
             $rendererBlock = $this->getLayout()->createBlock('Magento\Backend\Block\Store\Switcher\Form\Renderer\Fieldset\Element');
             $fieldset->addField('store_ids', 'multiselect', [
                 'name'   => 'store_ids',

diff --git a/Block/Adminhtml/Category/Edit/Tab/Post.php b/Block/Adminhtml/Category/Edit/Tab/Post.php
@@ -21,12 +21,17 @@
 
 namespace Mageplaza\Blog\Block\Adminhtml\Category\Edit\Tab;
 
+use Exception;
 use Magento\Backend\Block\Template\Context;
+use Magento\Backend\Block\Widget\Grid\Column;
 use Magento\Backend\Block\Widget\Grid\Extended;
 use Magento\Backend\Block\Widget\Tab\TabInterface;
 use Magento\Backend\Helper\Data;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Object;
 use Magento\Framework\Registry;
 use Mageplaza\Blog\Model\PostFactory;
+use Mageplaza\Blog\Model\ResourceModel\Post\Collection;
 use Mageplaza\Blog\Model\ResourceModel\Post\CollectionFactory;
 
 /**
@@ -36,28 +41,28 @@
 class Post extends Extended implements TabInterface
 {
     /**
-     * @var \Mageplaza\Blog\Model\ResourceModel\Post\CollectionFactory
+     * @var CollectionFactory
      */
     public $postCollectionFactory;
 
     /**
-     * @var \Magento\Framework\Registry
+     * @var Registry
      */
     public $coreRegistry;
 
     /**
-     * @var \Mageplaza\Blog\Model\PostFactory
+     * @var PostFactory
      */
     public $postFactory;
 
     /**
      * Post constructor.
      *
-     * @param \Magento\Backend\Block\Template\Context $context
-     * @param \Magento\Framework\Registry $coreRegistry
-     * @param \Magento\Backend\Helper\Data $backendHelper
-     * @param \Mageplaza\Blog\Model\PostFactory $postFactory
-     * @param \Mageplaza\Blog\Model\ResourceModel\Post\CollectionFactory $postCollectionFactory
+     * @param Context $context
+     * @param Registry $coreRegistry
+     * @param Data $backendHelper
+     * @param PostFactory $postFactory
+     * @param CollectionFactory $postCollectionFactory
      * @param array $data
      */
     public function __construct(
@@ -96,7 +101,7 @@ public function _construct()
      */
     protected function _prepareCollection()
     {
-        /** @var \Mageplaza\Blog\Model\ResourceModel\Post\Collection $collection */
+        /** @var Collection $collection */
         $collection = $this->postCollectionFactory->create();
         $collection->getSelect()->joinLeft(
             ['related' => $collection->getTable('mageplaza_blog_post_category')],
@@ -114,7 +119,7 @@ protected function _prepareCollection()
 
     /**
      * @return $this
-     * @throws \Exception
+     * @throws Exception
      */
     protected function _prepareColumns()
     {
@@ -188,7 +193,7 @@ public function getSelectedPosts()
     }
 
     /**
-     * @param \Mageplaza\Blog\Model\Post|\Magento\Framework\Object $item
+     * @param \Mageplaza\Blog\Model\Post|Object $item
      *
      * @return string
      */
@@ -216,10 +221,10 @@ public function getCategory()
     }
 
     /**
-     * @param \Magento\Backend\Block\Widget\Grid\Column $column
+     * @param Column $column
      *
      * @return $this
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     protected function _addColumnFilterToCollection($column)
     {