Mage_Cms - DOC block update

app/code/core/Mage/Cms/Block/Block.php

@@ -24,17 +24,17 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-
 /**
  * Cms block content block
  *
+ * @method int getBlockId()
+ *
  * @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 +63,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());

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());

app/code/core/Mage/Cms/Block/Widget/Block.php

@@ -31,6 +31,9 @@
  * @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 +81,7 @@ protected function _beforeToHtml()
                 ->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();
                 $this->setText($processor->filter($block->getContent()));

app/code/core/Mage/Cms/Block/Widget/Page/Link.php

@@ -39,7 +39,7 @@ class Mage_Cms_Block_Widget_Page_Link
     /**
      * Prepared href attribute
      *
-     * @var string
+     * @var string|null
      */
     protected $_href;
 

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
  *

app/code/core/Mage/Cms/Helper/Data.php

@@ -41,7 +41,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
      */
     public function getPageTemplateProcessor()
     {
@@ -52,7 +52,7 @@ public function getPageTemplateProcessor()
     /**
      * Retrieve Template processor for Block Content
      *
-     * @return Varien_Filter_Template
+     * @return Mage_Core_Model_Abstract
      */
     public function getBlockTemplateProcessor()
     {

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)
     {

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()
     {
@@ -251,7 +251,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 +273,7 @@ public function idEncode($string)
      * Revert opration to idEncode
      *
      * @param string $string
-     * @return string
+     * @return string|false
      */
     public function idDecode($string)
     {

app/code/core/Mage/Cms/Model/Block.php

@@ -30,17 +30,20 @@
  * @method Mage_Cms_Model_Resource_Block _getResource()
  * @method Mage_Cms_Model_Resource_Block getResource()
  * @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

app/code/core/Mage/Cms/Model/Observer.php

@@ -37,7 +37,7 @@ class Mage_Cms_Model_Observer
     /**
      * Modify No Route Forward object
      *
-     * @param Varien_Event_Observer $observer
+     * @param Varien_Event_Observer|Mage_Core_Helper_Object_Observer_Controller_Action $observer
      * @return $this
      */
     public function noRoute(Varien_Event_Observer $observer)

app/code/core/Mage/Cms/Model/Page.php

@@ -31,39 +31,44 @@
  * @method Mage_Cms_Model_Resource_Page _getResource()
  * @method Mage_Cms_Model_Resource_Page getResource()
  * @method string getTitle()
- * @method Mage_Cms_Model_Page setTitle(string $value)
+ * @method $this setTitle(string $value)
  * @method string getRootTemplate()
- * @method Mage_Cms_Model_Page setRootTemplate(string $value)
+ * @method $this setRootTemplate(string $value)
  * @method string getMetaKeywords()
- * @method Mage_Cms_Model_Page setMetaKeywords(string $value)
+ * @method $this setMetaKeywords(string $value)
  * @method string getMetaDescription()
- * @method Mage_Cms_Model_Page setMetaDescription(string $value)
+ * @method $this setMetaDescription(string $value)
  * @method string getIdentifier()
- * @method Mage_Cms_Model_Page setIdentifier(string $value)
+ * @method $this setIdentifier(string $value)
  * @method string getContentHeading()
- * @method Mage_Cms_Model_Page setContentHeading(string $value)
+ * @method $this setContentHeading(string $value)
  * @method string getContent()
- * @method Mage_Cms_Model_Page setContent(string $value)
+ * @method $this setContent(string $value)
  * @method string getCreationTime()
- * @method Mage_Cms_Model_Page setCreationTime(string $value)
+ * @method $this setCreationTime(string $value)
  * @method string getUpdateTime()
- * @method Mage_Cms_Model_Page setUpdateTime(string $value)
+ * @method $this setUpdateTime(string $value)
  * @method int getIsActive()
- * @method Mage_Cms_Model_Page setIsActive(int $value)
+ * @method $this setIsActive(int $value)
  * @method int getSortOrder()
- * @method Mage_Cms_Model_Page setSortOrder(int $value)
+ * @method $this setSortOrder(int $value)
  * @method string getLayoutUpdateXml()
- * @method Mage_Cms_Model_Page setLayoutUpdateXml(string $value)
+ * @method $this setLayoutUpdateXml(string $value)
  * @method string getCustomTheme()
- * @method Mage_Cms_Model_Page setCustomTheme(string $value)
+ * @method $this setCustomTheme(string $value)
  * @method string getCustomRootTemplate()
- * @method Mage_Cms_Model_Page setCustomRootTemplate(string $value)
+ * @method $this setCustomRootTemplate(string $value)
  * @method string getCustomLayoutUpdateXml()
- * @method Mage_Cms_Model_Page setCustomLayoutUpdateXml(string $value)
+ * @method $this setCustomLayoutUpdateXml(string $value)
  * @method string getCustomThemeFrom()
- * @method Mage_Cms_Model_Page setCustomThemeFrom(string $value)
+ * @method $this setCustomThemeFrom(string $value)
  * @method string getCustomThemeTo()
- * @method Mage_Cms_Model_Page setCustomThemeTo(string $value)
+ * @method $this setCustomThemeTo(string $value)
+ * @method $this setStoreId(int $value)
+ * @method bool hasCreationTime()
+ * @method bool hasStores()
+ * @method string getStoreId()
+ * @method array getStores()
  *
  * @category    Mage
  * @package     Mage_Cms
@@ -99,11 +104,7 @@ protected function _construct()
     }
 
     /**
-     * Load object data
-     *
-     * @param mixed $id
-     * @param string $field
-     * @return $this
+     * @inheritDoc
      */
     public function load($id, $field=null)
     {
@@ -129,7 +130,7 @@ public function noRoutePage()
      *
      * @param string $identifier
      * @param int $storeId
-     * @return int
+     * @return string
      */
     public function checkIdentifier($identifier, $storeId)
     {

app/code/core/Mage/Cms/Model/Resource/Block.php

@@ -44,10 +44,7 @@ protected function _construct()
     }
 
     /**
-     * Process block data before deleting
-     *
-     * @param Mage_Core_Model_Abstract $object
-     * @return Mage_Cms_Model_Resource_Page
+     * @inheritDoc
      */
     protected function _beforeDelete(Mage_Core_Model_Abstract $object)
     {
@@ -80,10 +77,7 @@ protected function _beforeSave(Mage_Core_Model_Abstract $object)
     }
 
     /**
-     * Perform operations after object save
-     *
-     * @param Mage_Core_Model_Abstract $object
-     * @return $this
+     * @inheritDoc
      */
     protected function _afterSave(Mage_Core_Model_Abstract $object)
     {
@@ -121,12 +115,7 @@ protected function _afterSave(Mage_Core_Model_Abstract $object)
     }
 
     /**
-     * Load an object using 'identifier' field if there's no field specified and value is not numeric
-     *
-     * @param Mage_Core_Model_Abstract $object
-     * @param mixed $value
-     * @param string $field
-     * @return $this
+     * @inheritDoc
      */
     public function load(Mage_Core_Model_Abstract $object, $value, $field = null)
     {
@@ -138,10 +127,7 @@ public function load(Mage_Core_Model_Abstract $object, $value, $field = null)
     }
 
     /**
-     * Perform operations after object load
-     *
-     * @param Mage_Core_Model_Abstract $object
-     * @return $this
+     * @inheritDoc
      */
     protected function _afterLoad(Mage_Core_Model_Abstract $object)
     {