Merge remote-tracking branch 'git-36978/no-author/review' into bluetooth_delivery

Author: engcom-Echo

app/code/Magento/Review/Block/Adminhtml/Add.php

@@ -8,8 +8,6 @@
 
 /**
  * Adminhtml add Review main block
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Add extends \Magento\Backend\Block\Widget\Form\Container
 {

app/code/Magento/Review/Block/Adminhtml/Add/Form.php

@@ -10,14 +10,10 @@
 
 /**
  * Adminhtml add product review form
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Form extends \Magento\Backend\Block\Widget\Form\Generic
 {
     /**
-     * Review data
-     *
      * @var \Magento\Review\Helper\Data
      */
     protected $_reviewData = null;

app/code/Magento/Review/Block/Adminhtml/Grid/Filter/Type.php

@@ -7,8 +7,6 @@
 
 /**
  * Adminhtml review grid filter by type
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Type extends \Magento\Backend\Block\Widget\Grid\Column\Filter\Select
 {

app/code/Magento/Review/Block/Adminhtml/Grid/Renderer/Type.php

@@ -7,8 +7,6 @@
 
 /**
  * Adminhtml review grid item renderer for item type
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Type extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {

app/code/Magento/Review/Block/Adminhtml/Product/Grid.php

@@ -8,7 +8,6 @@
 /**
  * Adminhtml product grid block
  *
- * @author      Magento Core Team <[email protected]>
  * @SuppressWarnings(PHPMD.DepthOfInheritance)
  */
 class Grid extends \Magento\Catalog\Block\Adminhtml\Product\Grid

app/code/Magento/Review/Block/Adminhtml/Rating.php

@@ -9,12 +9,13 @@
  * Ratings grid
  *
  * @api
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class Rating extends \Magento\Backend\Block\Widget\Grid\Container
 {
     /**
+     * Initialise the block
+     *
      * @return void
      */
     protected function _construct()

app/code/Magento/Review/Block/Adminhtml/Rating/Edit/Form.php

@@ -7,12 +7,12 @@
 
 /**
  * Rating edit form block
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Form extends \Magento\Backend\Block\Widget\Form\Generic
 {
     /**
+     * Prepare the form
+     *
      * @return $this
      */
     protected function _prepareForm()

app/code/Magento/Review/Block/Adminhtml/Rating/Edit/Tabs.php

@@ -7,12 +7,12 @@
 
 /**
  * Admin rating left menu
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Tabs extends \Magento\Backend\Block\Widget\Tabs
 {
     /**
+     * Initialise the block
+     *
      * @return void
      */
     protected function _construct()
@@ -24,6 +24,8 @@ protected function _construct()
     }
 
     /**
+     * Add rating information tab
+     *
      * @return $this
      */
     protected function _beforeToHtml()

app/code/Magento/Review/Block/Customer/View.php

@@ -14,7 +14,6 @@
  * Customer Review detailed view block
  *
  * @api
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class View extends \Magento\Catalog\Block\Product\AbstractProduct
@@ -162,6 +161,7 @@ public function getRating()
      * Get rating summary
      *
      * @deprecated 100.3.3
+     * @see f72f74d3
      * @return array
      */
     public function getRatingSummary()
@@ -183,11 +183,14 @@ public function getTotalReviews()
     {
         if (!$this->getTotalReviewsCache()) {
             $this->setTotalReviewsCache(
-                $this->_reviewFactory->create()->getTotalReviews($this->getProductData()->getId()),
-                false,
-                $this->_storeManager->getStore()->getId()
+                $this->_reviewFactory->create()->getTotalReviews(
+                    $this->getProductData()->getId(),
+                    false,
+                    $this->_storeManager->getStore()->getId()
+                )
             );
         }
+
         return $this->getTotalReviewsCache();
     }
 

app/code/Magento/Review/Block/Form.php

@@ -14,15 +14,12 @@
  * Review form block
  *
  * @api
- * @author      Magento Core Team <[email protected]>
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @since 100.0.2
  */
 class Form extends \Magento\Framework\View\Element\Template
 {
     /**
-     * Review data
-     *
      * @var \Magento\Review\Helper\Data
      */
     protected $_reviewData = null;
@@ -74,8 +71,6 @@ class Form extends \Magento\Framework\View\Element\Template
     private $serializer;
 
     /**
-     * Form constructor.
-     *
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Framework\Url\EncoderInterface $urlEncoder
      * @param \Magento\Review\Helper\Data $reviewData
@@ -143,6 +138,8 @@ protected function _construct()
     }
 
     /**
+     * Return JavaScript layout object
+     *
      * @return string
      */
     public function getJsLayout()

app/code/Magento/Review/Block/Form/Configure.php

@@ -9,7 +9,6 @@
  * Review form block
  *
  * @api
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class Configure extends \Magento\Review\Block\Form

app/code/Magento/Review/Block/Product/Review.php

@@ -12,14 +12,11 @@
  * Product Review Tab
  *
  * @api
- * @author     Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class Review extends Template implements IdentityInterface
 {
     /**
-     * Core registry
-     *
      * @var \Magento\Framework\Registry
      */
     protected $_coreRegistry;

app/code/Magento/Review/Block/Product/View.php

@@ -11,7 +11,6 @@
 /**
  * Product Reviews Page
  *
- * @author     Magento Core Team <[email protected]>
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class View extends \Magento\Catalog\Block\Product\View

app/code/Magento/Review/Block/Rating/Entity/Detailed.php

@@ -7,8 +7,6 @@
 
 /**
  * Entity rating block
- *
- * @author      Magento Core Team <[email protected]>
  */
 class Detailed extends \Magento\Framework\View\Element\Template
 {

app/code/Magento/Review/Block/View.php

@@ -9,7 +9,6 @@
  * Review detailed view block
  *
  * @api
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class View extends \Magento\Catalog\Block\Product\AbstractProduct
@@ -121,6 +120,7 @@ public function getRating()
      * Retrieve rating summary for current product
      *
      * @deprecated 100.3.3
+     * @see f72f74d3
      * @return string
      */
     public function getRatingSummary()

app/code/Magento/Review/Model/Rating.php

@@ -17,19 +17,18 @@
  * @method \Magento\Review\Model\Rating setStores(array $value)
  * @method string getRatingCode()
  *
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  */
 class Rating extends \Magento\Framework\Model\AbstractModel implements IdentityInterface
 {
     /**
      * rating entity codes
      */
-    const ENTITY_PRODUCT_CODE = 'product';
+    public const ENTITY_PRODUCT_CODE = 'product';
 
-    const ENTITY_PRODUCT_REVIEW_CODE = 'product_review';
+    public const ENTITY_PRODUCT_REVIEW_CODE = 'product_review';
 
-    const ENTITY_REVIEW_CODE = 'review';
+    public const ENTITY_REVIEW_CODE = 'review';
 
     /**
      * @var \Magento\Review\Model\Rating\OptionFactory
@@ -75,6 +74,8 @@ protected function _construct()
     }
 
     /**
+     * Add a vote to an option
+     *
      * @param int $optionId
      * @param int $entityPkValue
      * @return $this
@@ -94,6 +95,8 @@ public function addOptionVote($optionId, $entityPkValue)
     }
 
     /**
+     * Update a vote for an option
+     *
      * @param int $optionId
      * @return $this
      */
@@ -112,7 +115,7 @@ public function updateOptionVote($optionId)
     }
 
     /**
-     * retrieve rating options
+     * Retrieve rating options
      *
      * @return array
      */
@@ -143,6 +146,8 @@ public function getEntitySummary($entityPkValue, $onlyForCurrentStore = true)
     }
 
     /**
+     * Get summary of review
+     *
      * @param int $reviewId
      * @param bool $onlyForCurrentStore
      * @return array

app/code/Magento/Review/Model/Rating/Entity.php

@@ -11,12 +11,13 @@
  * @method string getEntityCode()
  * @method \Magento\Review\Model\Rating\Entity setEntityCode(string $value)
  *
- * @author      Magento Core Team <[email protected]>
  * @codeCoverageIgnore
  */
 class Entity extends \Magento\Framework\Model\AbstractModel
 {
     /**
+     * Initialise the model
+     *
      * @return void
      */
     protected function _construct()
@@ -25,6 +26,8 @@ protected function _construct()
     }
 
     /**
+     * Return the ID for the specified code
+     *
      * @param string $entityCode
      * @return int
      */

app/code/Magento/Review/Model/Rating/Option.php

@@ -18,13 +18,14 @@
  * @method int getPosition()
  * @method \Magento\Review\Model\Rating\Option setPosition(int $value)
  *
- * @author      Magento Core Team <[email protected]>
  * @codeCoverageIgnore
  * @since 100.0.2
  */
 class Option extends \Magento\Framework\Model\AbstractModel
 {
     /**
+     * Initialise the model
+     *
      * @return void
      */
     protected function _construct()
@@ -33,6 +34,8 @@ protected function _construct()
     }
 
     /**
+     * Add a vote
+     *
      * @return $this
      */
     public function addVote()
@@ -42,6 +45,8 @@ public function addVote()
     }
 
     /**
+     * Set the identifier
+     *
      * @param mixed $id
      * @return $this
      */

app/code/Magento/Review/Model/Rating/Option/Vote.php

@@ -9,14 +9,14 @@
  * Rating vote model
  *
  * @api
- *
- * @author      Magento Core Team <[email protected]>
  * @codeCoverageIgnore
  * @since 100.0.2
  */
 class Vote extends \Magento\Framework\Model\AbstractModel
 {
     /**
+     * Initialise the class
+     *
      * @return void
      */
     protected function _construct()

app/code/Magento/Review/Model/ResourceModel/Rating.php

@@ -12,18 +12,14 @@
  * Rating resource model
  *
  * @api
- *
- * @author      Magento Core Team <[email protected]>
  * @since 100.0.2
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Rating extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
-    const RATING_STATUS_APPROVED = 'Approved';
+    public const RATING_STATUS_APPROVED = 'Approved';
 
     /**
-     * Store manager
-     *
      * @var \Magento\Store\Model\StoreManagerInterface
      */
     protected $_storeManager;