Mage_Cms - DOC block update (#694)

* Mage_Cms - DOC block update * Some DOC updates, PSR2 * Grouped @method together * Improved return types
OpenMage · May 14, 2020 · f968f21 · f968f21
1 parent 22bca85
commit f968f21
Show file tree

Hide file tree

Showing 35 changed files with 222 additions and 210 deletions.
diff --git a/app/code/core/Mage/Cms/Block/Block.php b/app/code/core/Mage/Cms/Block/Block.php
@@ -24,17 +24,18 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Cms block content block
  *
+ * @method int getBlockId()
+ * @method $this setBlockId(int $int)
+ *
  * @category   Mage
  * @package    Mage_Cms
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 class Mage_Cms_Block_Block extends Mage_Core_Block_Abstract
 {
-
     /**
      * Initialize cache
      *
@@ -63,7 +64,7 @@ protected function _toHtml()
                 ->setStoreId(Mage::app()->getStore()->getId())
                 ->load($blockId);
             if ($block->getIsActive()) {
-                /* @var $helper Mage_Cms_Helper_Data */
+                /* @var Mage_Cms_Helper_Data $helper */
                 $helper = Mage::helper('cms');
                 $processor = $helper->getBlockTemplateProcessor();
                 $html = $processor->filter($block->getContent());

diff --git a/app/code/core/Mage/Cms/Block/Page.php b/app/code/core/Mage/Cms/Block/Page.php
@@ -24,10 +24,11 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Cms page content block
  *
+ * @method int getPageId()
+ *
  * @category   Mage
  * @package    Mage_Cms
  * @author     Magento Core Team <core@magentocommerce.com>
@@ -56,9 +57,7 @@ public function getPage()
     }
 
     /**
-     * Prepare global layout
-     *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareLayout()
     {
@@ -120,7 +119,7 @@ protected function _prepareLayout()
      */
     protected function _toHtml()
     {
-        /* @var $helper Mage_Cms_Helper_Data */
+        /* @var Mage_Cms_Helper_Data $helper */
         $helper = Mage::helper('cms');
         $processor = $helper->getPageTemplateProcessor();
         $html = $processor->filter($this->getPage()->getContent());

diff --git a/app/code/core/Mage/Cms/Block/Widget/Block.php b/app/code/core/Mage/Cms/Block/Widget/Block.php
@@ -24,13 +24,15 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Cms Static Block Widget
  *
  * @category   Mage
  * @package    Mage_Cms
  * @author     Magento Core Team <core@magentocommerce.com>
+ *
+ * @method int getBlockId()
+ * @method $this setText(string $value)
  */
 class Mage_Cms_Block_Widget_Block extends Mage_Core_Block_Template implements Mage_Widget_Block_Interface
 {
@@ -78,7 +80,6 @@ protected function _beforeToHtml()
                 ->setStoreId(Mage::app()->getStore()->getId())
                 ->load($blockId);
             if ($block->getIsActive()) {
-                /* @var $helper Mage_Cms_Helper_Data */
                 $helper = Mage::helper('cms');
                 $processor = $helper->getBlockTemplateProcessor();
                 if ($this->isRequestFromAdminArea()) {

diff --git a/app/code/core/Mage/Cms/Block/Widget/Page/Link.php b/app/code/core/Mage/Cms/Block/Widget/Page/Link.php
@@ -32,14 +32,12 @@
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 
-class Mage_Cms_Block_Widget_Page_Link
-    extends Mage_Core_Block_Html_Link
-    implements Mage_Widget_Block_Interface
+class Mage_Cms_Block_Widget_Page_Link extends Mage_Core_Block_Html_Link implements Mage_Widget_Block_Interface
 {
     /**
      * Prepared href attribute
      *
-     * @var string
+     * @var string|null
      */
     protected $_href;
 
@@ -69,7 +67,7 @@ public function getHref()
             $this->_href = '';
             if ($this->getData('href')) {
                 $this->_href = $this->getData('href');
-            } else if ($this->getData('page_id')) {
+            } elseif ($this->getData('page_id')) {
                 $this->_href = Mage::helper('cms/page')->getPageUrl($this->getData('page_id'));
             }
         }
@@ -90,9 +88,9 @@ public function getTitle()
             if ($this->getData('title') !== null) {
                 // compare to null used here bc user can specify blank title
                 $this->_title = $this->getData('title');
-            } else if ($this->getData('page_id')) {
+            } elseif ($this->getData('page_id')) {
                 $this->_title = Mage::getResourceSingleton('cms/page')->getCmsPageTitleById($this->getData('page_id'));
-            } else if ($this->getData('href')) {
+            } elseif ($this->getData('href')) {
                 $this->_title = Mage::getResourceSingleton('cms/page')->setStore(Mage::app()->getStore())
                     ->getCmsPageTitleByIdentifier($this->getData('href'));
             }
@@ -112,12 +110,12 @@ public function getAnchorText()
     {
         if ($this->getData('anchor_text')) {
             $this->_anchorText = $this->getData('anchor_text');
-        } else if ($this->getTitle()) {
+        } elseif ($this->getTitle()) {
             $this->_anchorText = $this->getTitle();
-        } else if ($this->getData('href')) {
+        } elseif ($this->getData('href')) {
             $this->_anchorText = Mage::getResourceSingleton('cms/page')->setStore(Mage::app()->getStore())
                 ->getCmsPageTitleByIdentifier($this->getData('href'));
-        } else if ($this->getData('page_id')) {
+        } elseif ($this->getData('page_id')) {
             $this->_anchorText = Mage::getResourceSingleton('cms/page')->getCmsPageTitleById($this->getData('page_id'));
         } else {
             $this->_anchorText = $this->getData('href');

diff --git a/app/code/core/Mage/Cms/Controller/Router.php b/app/code/core/Mage/Cms/Controller/Router.php
@@ -24,7 +24,6 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Cms Controller Router
  *
@@ -41,7 +40,7 @@ class Mage_Cms_Controller_Router extends Mage_Core_Controller_Varien_Router_Abst
      */
     public function initControllerRouters($observer)
     {
-        /* @var $front Mage_Core_Controller_Varien_Front */
+        /* @var Mage_Core_Controller_Varien_Front $front */
         $front = $observer->getEvent()->getFront();
 
         $front->addRouter('cms', $this);

diff --git a/app/code/core/Mage/Cms/Helper/Data.php b/app/code/core/Mage/Cms/Helper/Data.php
@@ -42,7 +42,7 @@ class Mage_Cms_Helper_Data extends Mage_Core_Helper_Abstract
     /**
      * Retrieve Template processor for Page Content
      *
-     * @return Varien_Filter_Template
+     * @return Mage_Core_Model_Abstract|Varien_Filter_Template
      */
     public function getPageTemplateProcessor()
     {
@@ -53,7 +53,7 @@ public function getPageTemplateProcessor()
     /**
      * Retrieve Template processor for Block Content
      *
-     * @return Varien_Filter_Template
+     * @return Mage_Core_Model_Abstract|Varien_Filter_Template
      */
     public function getBlockTemplateProcessor()
     {

diff --git a/app/code/core/Mage/Cms/Helper/Page.php b/app/code/core/Mage/Cms/Helper/Page.php
@@ -44,7 +44,7 @@ class Mage_Cms_Helper_Page extends Mage_Core_Helper_Abstract
     * Call from controller action
     *
     * @param Mage_Core_Controller_Front_Action $action
-    * @param integer $pageId
+    * @param string $pageId
     * @return boolean
     */
     public function renderPage(Mage_Core_Controller_Front_Action $action, $pageId = null)
@@ -55,14 +55,13 @@ public function renderPage(Mage_Core_Controller_Front_Action $action, $pageId =
    /**
     * Renders CMS page
     *
-    * @param Mage_Core_Controller_Front_Action $action
-    * @param integer $pageId
+    * @param Mage_Core_Controller_Varien_Action $action
+    * @param string $pageId
     * @param bool $renderLayout
     * @return boolean
     */
     protected function _renderPage(Mage_Core_Controller_Varien_Action  $action, $pageId = null, $renderLayout = true)
     {
-
         $page = Mage::getSingleton('cms/page');
         if (!is_null($pageId) && $pageId!==$page->getId()) {
             $delimeterPosition = strrpos($pageId, '|');
@@ -146,8 +145,8 @@ protected function _renderPage(Mage_Core_Controller_Varien_Action  $action, $pag
      * Also takes third parameter which allows not run renderLayout method.
      *
      * @param Mage_Core_Controller_Varien_Action $action
-     * @param $pageId
-     * @param $renderLayout
+     * @param string $pageId
+     * @param bool $renderLayout
      * @return bool
      */
     public function renderPageExtended(Mage_Core_Controller_Varien_Action $action, $pageId = null, $renderLayout = true)
@@ -159,7 +158,7 @@ public function renderPageExtended(Mage_Core_Controller_Varien_Action $action, $
      * Retrieve page direct URL
      *
      * @param string $pageId
-     * @return string
+     * @return string|null
      */
     public function getPageUrl($pageId = null)
     {

diff --git a/app/code/core/Mage/Cms/Helper/Wysiwyg/Images.php b/app/code/core/Mage/Cms/Helper/Wysiwyg/Images.php
@@ -29,10 +29,9 @@
  */
 class Mage_Cms_Helper_Wysiwyg_Images extends Mage_Core_Helper_Abstract
 {
-
     /**
      * Current directory path
-     * @var string
+     * @var string|false
      */
     protected $_currentPath;
 
@@ -51,14 +50,15 @@ class Mage_Cms_Helper_Wysiwyg_Images extends Mage_Core_Helper_Abstract
 
     /**
      * Image Storage root directory
-     * @var string
+     * @var string|false
      */
     protected $_storageRoot;
 
     /**
      * Set a specified store ID value
      *
-     * @param <type> $store
+     * @param int $store
+     * @return $this
      */
     public function setStoreId($store)
     {
@@ -207,7 +207,7 @@ public function getImageHtmlDeclaration($filename, $renderAsTag = false)
      * Try to create target directory if it doesn't exist
      *
      * @throws Mage_Core_Exception
-     * @return string
+     * @return string|false
      */
     public function getCurrentPath()
     {
@@ -222,8 +222,10 @@ public function getCurrentPath()
             }
             $io = new Varien_Io_File();
             if (!$io->isWriteable($currentPath) && !$io->mkdir($currentPath)) {
-                $message = Mage::helper('cms')->__('The directory %s is not writable by server.',
-                    $io->getFilteredPath($currentPath));
+                $message = Mage::helper('cms')->__(
+                    'The directory %s is not writable by server.',
+                    $io->getFilteredPath($currentPath)
+                );
                 Mage::throwException($message);
             }
             $this->_currentPath = $currentPath;
@@ -251,7 +253,7 @@ public function getCurrentUrl()
     /**
      * Storage model singleton
      *
-     * @return Mage_Cms_Model_Page_Wysiwyg_Images_Storage
+     * @return Mage_Cms_Model_Wysiwyg_Images_Storage
      */
     public function getStorage()
     {
@@ -273,7 +275,7 @@ public function idEncode($string)
      * Revert opration to idEncode
      *
      * @param string $string
-     * @return string
+     * @return string|false
      */
     public function idDecode($string)
     {

diff --git a/app/code/core/Mage/Cms/Model/Block.php b/app/code/core/Mage/Cms/Model/Block.php
@@ -29,18 +29,23 @@
  *
  * @method Mage_Cms_Model_Resource_Block _getResource()
  * @method Mage_Cms_Model_Resource_Block getResource()
+ * @method Mage_Cms_Model_Resource_Block_Collection getCollection()
+ *
  * @method string getTitle()
- * @method Mage_Cms_Model_Block setTitle(string $value)
+ * @method $this setTitle(string $value)
  * @method string getIdentifier()
- * @method Mage_Cms_Model_Block setIdentifier(string $value)
+ * @method $this setIdentifier(string $value)
  * @method string getContent()
- * @method Mage_Cms_Model_Block setContent(string $value)
+ * @method $this setContent(string $value)
  * @method string getCreationTime()
- * @method Mage_Cms_Model_Block setCreationTime(string $value)
+ * @method $this setCreationTime(string $value)
  * @method string getUpdateTime()
- * @method Mage_Cms_Model_Block setUpdateTime(string $value)
+ * @method $this setUpdateTime(string $value)
  * @method int getIsActive()
- * @method Mage_Cms_Model_Block setIsActive(int $value)
+ * @method $this setIsActive(int $value)
+ * @method $this setStoreId(int $storeId)
+ * @method int getStoreId()
+ * @method int getBlockId()
  *
  * @category    Mage
  * @package     Mage_Cms

diff --git a/app/code/core/Mage/Cms/Model/Observer.php b/app/code/core/Mage/Cms/Model/Observer.php
@@ -65,8 +65,7 @@ public function noCookies(Varien_Event_Observer $observer)
 
         if ($pageUrl) {
             $redirect->setRedirectUrl($pageUrl);
-        }
-        else {
+        } else {
             $redirect->setRedirect(true)
                 ->setPath('cms/index/noCookies')
                 ->setArguments(array());