ENGCOM-4194: Fixing returning types #21095

magento · Feb 13, 2019 · 3938e68 · 3938e68
2 parents bda7a95 + dbb6565
commit 3938e68
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 11 deletions.
diff --git a/app/code/Magento/Backend/Block/Template/Context.php b/app/code/Magento/Backend/Block/Template/Context.php
@@ -17,6 +17,7 @@
  * the classes they were introduced for.
  *
  * @api
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @since 100.0.2
  */
@@ -173,6 +174,8 @@ public function getAuthorization()
     }
 
     /**
+     * Get Backend Session
+     *
      * @return \Magento\Backend\Model\Session
      */
     public function getBackendSession()
@@ -181,6 +184,8 @@ public function getBackendSession()
     }
 
     /**
+     * Get Math Random
+     *
      * @return \Magento\Framework\Math\Random
      */
     public function getMathRandom()
@@ -189,6 +194,8 @@ public function getMathRandom()
     }
 
     /**
+     * Get Form Key
+     *
      * @return \Magento\Framework\Data\Form\FormKey
      */
     public function getFormKey()
@@ -197,7 +204,9 @@ public function getFormKey()
     }
 
     /**
-     * @return \Magento\Framework\Data\Form\FormKey
+     * Get Class Name Builder
+     *
+     * @return \Magento\Framework\Code\NameBuilder
      */
     public function getNameBuilder()
     {

diff --git a/app/code/Magento/Backup/Model/Backup.php b/app/code/Magento/Backup/Model/Backup.php
@@ -14,6 +14,7 @@
  * @method string getPath()
  * @method string getName()
  * @method string getTime()
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @api
  * @since 100.0.2
@@ -80,6 +81,7 @@ class Backup extends \Magento\Framework\DataObject implements \Magento\Framework
      * @param \Magento\Framework\Encryption\EncryptorInterface $encryptor
      * @param \Magento\Framework\Filesystem $filesystem
      * @param array $data
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
     public function __construct(
         \Magento\Backup\Helper\Data $helper,
@@ -242,7 +244,7 @@ public function setFile(&$content)
     /**
      * Return content of backup file
      *
-     * @return string
+     * @return array
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function &getFile()
@@ -275,8 +277,9 @@ public function deleteFile()
      *
      * @param bool $write
      * @return $this
-     * @throws \Magento\Framework\Exception\InputException
      * @throws \Magento\Framework\Backup\Exception\NotEnoughPermissions
+     * @throws \Magento\Framework\Exception\FileSystemException
+     * @throws \Magento\Framework\Exception\InputException
      */
     public function open($write = false)
     {
@@ -330,6 +333,7 @@ protected function _getStream()
      *
      * @param int $length
      * @return string
+     * @throws \Magento\Framework\Exception\InputException
      */
     public function read($length)
     {
@@ -340,6 +344,7 @@ public function read($length)
      * Check end of file.
      *
      * @return bool
+     * @throws \Magento\Framework\Exception\InputException
      */
     public function eof()
     {
@@ -370,6 +375,7 @@ public function write($string)
      * Close open backup file
      *
      * @return $this
+     * @throws \Magento\Framework\Exception\InputException
      */
     public function close()
     {
@@ -383,6 +389,8 @@ public function close()
      * Print output
      *
      * @return string
+     * @return \Magento\Framework\Filesystem\Directory\ReadInterface|string|void
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
     public function output()
     {
@@ -398,6 +406,8 @@ public function output()
     }
 
     /**
+     * Get Size
+     *
      * @return int|mixed
      */
     public function getSize()
@@ -419,6 +429,7 @@ public function getSize()
      *
      * @param string $password
      * @return bool
+     * @throws \Exception
      */
     public function validateUserPassword($password)
     {

diff --git a/app/code/Magento/Ui/Component/Wysiwyg/Config.php b/app/code/Magento/Ui/Component/Wysiwyg/Config.php
@@ -13,7 +13,7 @@ class Config implements ConfigInterface
     /**
      * Return WYSIWYG configuration
      *
-     * @return \Magento\Framework\DataObject
+     * @return array
      */
     public function getConfig()
     {

diff --git a/app/code/Magento/Widget/Block/Adminhtml/Widget/Catalog/Category/Chooser.php b/app/code/Magento/Widget/Block/Adminhtml/Widget/Catalog/Category/Chooser.php
@@ -3,22 +3,19 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+namespace Magento\Widget\Block\Adminhtml\Widget\Catalog\Category;
 
 /**
  * Category chooser for widget's layout updates
- *
- * @author     Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\Widget\Block\Adminhtml\Widget\Catalog\Category;
-
 class Chooser extends \Magento\Catalog\Block\Adminhtml\Category\Widget\Chooser
 {
     /**
      * Get JSON of a tree node or an associative array
      *
      * @param \Magento\Framework\Data\Tree\Node|array $node
      * @param int $level
-     * @return string
+     * @return array
      */
     protected function _getNodeJson($node, $level = 0)
     {

diff --git a/lib/internal/Magento/Framework/Code/NameBuilder.php b/lib/internal/Magento/Framework/Code/NameBuilder.php
@@ -1,12 +1,15 @@
 <?php
 /**
- * Name builder
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Framework\Code;
 
+/**
+ * Name builder.
+ *
+ * @api
+ */
 class NameBuilder
 {
     /**