Mage_Widget - DOC block update

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Chooser.php

@@ -30,8 +30,15 @@
  * @category   Mage
  * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
+ *
+ * @method $this setConfig(Varien_Object $value)
+ * @method $this setElement(Varien_Data_Form_Element_Abstract $value)
+ * @method $this setFieldsetId(string $value)
+ * @method string getLabel()
+ * @method $this setTranslationHelper(Mage_Core_Helper_Abstract $value)
+ * @method $this setSourceUrl(string $value)
+ * @method $this setUniqId(string $value)
  */
-
 class Mage_Widget_Block_Adminhtml_Widget_Chooser extends Mage_Adminhtml_Block_Template
 {
     /**
@@ -143,7 +150,7 @@ public function getHiddenEnabled()
     protected function _toHtml()
     {
         $element   = $this->getElement();
-        /* @var $fieldset Varien_Data_Form_Element_Fieldset */
+        /* @var Varien_Data_Form_Element_Fieldset $fieldset */
         $fieldset  = $element->getForm()->getElement($this->getFieldsetId());
         $chooserId = $this->getUniqId();
         $config    = $this->getConfig();

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Form.php

@@ -93,6 +93,7 @@ protected function _getWidgetSelectAfterHtml()
     /**
      * Return array of available widgets based on configuration
      *
+     * @param bool $withEmptyElement
      * @return array
      */
     protected function _getAvailableWidgets($withEmptyElement = false)

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit.php

@@ -59,7 +59,7 @@ public function getWidgetInstance()
      * Prepare layout.
      * Adding save_and_continue button
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _preparelayout()
     {
@@ -88,8 +88,7 @@ public function getHeaderText()
     {
         if ($this->getWidgetInstance()->getId()) {
             return Mage::helper('widget')->__('Widget "%s"', $this->escapeHtml($this->getWidgetInstance()->getTitle()));
-        }
-        else {
+        } else {
             return Mage::helper('widget')->__('New Widget Instance');
         }
     }

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Chooser/Block.php

@@ -30,14 +30,25 @@
  * @category    Mage
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
+ *
+ * @method $this setArea(string $value)
+ * @method $this setPackage(string $value)
+ * @method string getSelected()
+ * @method $this setSelected(string $value)
+ * @method $this setTheme(string $value)
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Block
-    extends Mage_Adminhtml_Block_Widget
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Block extends Mage_Adminhtml_Block_Widget
 {
     protected $_layoutHandlesXml = null;
 
+    /**
+     * @var Varien_Simplexml_Element[]
+     */
     protected $_layoutHandleUpdates = array();
 
+    /**
+     * @var SimpleXMLElement
+     */
     protected $_layoutHandleUpdatesXml = null;
 
     protected $_layoutHandle = array();
@@ -170,13 +181,12 @@ protected function _toHtml()
     public function getBlocks()
     {
         if (empty($this->_blocks)) {
-            /* @var $update Mage_Core_Model_Layout_Update */
             $update = Mage::getModel('core/layout')->getUpdate();
-            /* @var $layoutHandles Mage_Core_Model_Layout_Element */
             $this->_layoutHandlesXml = $update->getFileLayoutUpdatesXml(
                 $this->getArea(),
                 $this->getPackage(),
-                $this->getTheme());
+                $this->getTheme()
+            );
             $this->_collectLayoutHandles();
             $this->_collectBlocks();
             array_unshift($this->_blocks, array(
@@ -189,7 +199,6 @@ public function getBlocks()
 
     /**
      * Merging layout handles and create xml of merged layout handles
-     *
      */
     protected function _collectLayoutHandles()
     {
@@ -224,7 +233,7 @@ public function _mergeLayoutHandles($handle)
     protected function _collectBlocks()
     {
         if ($blocks = $this->_layoutHandleUpdatesXml->xpath('//block/label/..')) {
-            /* @var $block Mage_Core_Model_Layout_Element */
+            /* @var Mage_Core_Model_Layout_Element $block */
             foreach ($blocks as $block) {
                 if ((string)$block->getAttribute('name') && $this->_filterBlock($block)) {
                     $helper = Mage::helper(Mage_Core_Model_Layout::findTranslationModuleName($block));

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Chooser/Layout.php

@@ -30,9 +30,14 @@
  * @category    Mage
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
+ *
+ * @method $this setArea(string $value)
+ * @method $this setPackage(string $value)
+ * @method string getSelectName()
+ * @method $this setSelectName(string $value)
+ * @method $this setTheme(string $value)
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Layout
-    extends Mage_Adminhtml_Block_Widget
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Layout extends Mage_Adminhtml_Block_Widget
 {
     protected $_layoutHandles = array();
 
@@ -133,7 +138,8 @@ protected function _toHtml()
             ->setOptions($this->getLayoutHandles(
                 $this->getArea(),
                 $this->getPackage(),
-                $this->getTheme()));
+                $this->getTheme()
+            ));
         return parent::_toHtml().$selectBlock->toHtml();
     }
 
@@ -148,7 +154,7 @@ protected function _toHtml()
     public function getLayoutHandles($area, $package, $theme)
     {
         if (empty($this->_layoutHandles)) {
-            /* @var $update Mage_Core_Model_Layout_Update */
+            /* @var Mage_Core_Model_Layout_Update $update */
             $update = Mage::getModel('core/layout')->getUpdate();
             $this->_layoutHandles[''] = Mage::helper('widget')->__('-- Please Select --');
             $this->_collectLayoutHandles($update->getFileLayoutUpdatesXml($area, $package, $theme));

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Chooser/Template.php

@@ -30,9 +30,13 @@
  * @category    Mage
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
+ *
+ * @method string getSelected()
+ * @method $this setSelected(string $value)
+ * @method array getWidgetTemplates()
+ * @method $this setWidgetTemplates(array $value)
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Template
-    extends Mage_Adminhtml_Block_Widget
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Template extends Mage_Adminhtml_Block_Widget
 {
     /**
      * Prepare html output

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Form.php

@@ -36,7 +36,7 @@ class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Form extends Mage_Adminht
     /**
      * Prepare form before rendering HTML
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareForm()
     {
@@ -45,5 +45,4 @@ protected function _prepareForm()
         $this->setForm($form);
         return parent::_prepareForm();
     }
-
 }

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Main.php

@@ -31,9 +31,7 @@
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main
-    extends Mage_Adminhtml_Block_Widget_Form
-    implements Mage_Adminhtml_Block_Widget_Tab_Interface
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main extends Mage_Adminhtml_Block_Widget_Form implements Mage_Adminhtml_Block_Widget_Tab_Interface
 {
     /**
      * Internal constructor
@@ -88,7 +86,7 @@ public function isHidden()
     /**
      * Getter
      *
-     * @return Widget_Model_Widget_Instance
+     * @return Mage_Widget_Model_Widget_Instance
      */
     public function getWidgetInstance()
     {
@@ -98,7 +96,7 @@ public function getWidgetInstance()
     /**
      * Prepare form before rendering HTML
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareForm()
     {
@@ -109,7 +107,8 @@ protected function _prepareForm()
             'method' => 'post'
         ));
 
-        $fieldset = $form->addFieldset('base_fieldset',
+        $fieldset = $form->addFieldset(
+            'base_fieldset',
             array('legend' => Mage::helper('widget')->__('Frontend Properties'))
         );
 
@@ -168,11 +167,11 @@ protected function _prepareForm()
             'note' => Mage::helper('widget')->__('Sort Order of widget instances in the same block reference')
         ));
 
-        /* @var $layoutBlock Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main_Layout */
         $layoutBlock = $this->getLayout()
             ->createBlock('widget/adminhtml_widget_instance_edit_tab_main_layout')
             ->setWidgetInstance($widgetInstance);
-        $fieldset = $form->addFieldset('layout_updates_fieldset',
+        $fieldset = $form->addFieldset(
+            'layout_updates_fieldset',
             array('legend' => Mage::helper('widget')->__('Layout Updates'))
         );
         $fieldset->addField('layout_updates', 'note', array(
@@ -207,7 +206,7 @@ public function getPackegeThemeOptionsArray()
     /**
      * Initialize form fileds values
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _initFormValues()
     {

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Main/Layout.php

@@ -30,9 +30,11 @@
  * @category    Mage
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
+ *
+ * @method Mage_Widget_Model_Widget_Instance getWidgetInstance()
+ * @method $this setWidgetInstance(Mage_Widget_Model_Widget_Instance $value)
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main_Layout
-    extends Mage_Adminhtml_Block_Template implements Varien_Data_Form_Element_Renderer_Interface
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main_Layout extends Mage_Adminhtml_Block_Template implements Varien_Data_Form_Element_Renderer_Interface
 {
     /**
      * @var Varien_Data_Form_Element_Abstract
@@ -51,6 +53,7 @@ protected function _construct()
     /**
      * Render given element (return html of element)
      *
+     * @param Varien_Data_Form_Element_Abstract $element
      * @return string
      */
     public function render(Varien_Data_Form_Element_Abstract $element)

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Properties.php

@@ -30,10 +30,11 @@
  * @category    Mage
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
+ *
+ * @method $this setWidgetType(string $value)
+ * @method $this setWidgetValues(array $value)
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Properties
-    extends Mage_Widget_Block_Adminhtml_Widget_Options
-    implements Mage_Adminhtml_Block_Widget_Tab_Interface
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Properties extends Mage_Widget_Block_Adminhtml_Widget_Options implements Mage_Adminhtml_Block_Widget_Tab_Interface
 {
     /**
      * Prepare label for tab
@@ -78,7 +79,7 @@ public function isHidden()
     /**
      * Getter
      *
-     * @return age_Widget_Model_Widget_Instance
+     * @return Mage_Widget_Model_Widget_Instance
      */
     public function getWidgetInstance()
     {
@@ -89,7 +90,7 @@ public function getWidgetInstance()
      * Prepare block children and data.
      * Set widget type and widget parameters if available
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _preparelayout()
     {
@@ -102,7 +103,7 @@ protected function _preparelayout()
      * Add field to Options form based on option configuration
      *
      * @param Varien_Object $parameter
-     * @return Varien_Data_Form_Element_Abstract
+     * @return Varien_Data_Form_Element_Abstract|false
      */
     protected function _addField($parameter)
     {

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Settings.php

@@ -31,9 +31,7 @@
  * @package     Mage_Widget
  * @author      Magento Core Team <core@magentocommerce.com>
  */
-class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Settings
-    extends Mage_Adminhtml_Block_Widget_Form
-    implements Mage_Adminhtml_Block_Widget_Tab_Interface
+class Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Settings extends Mage_Adminhtml_Block_Widget_Form implements Mage_Adminhtml_Block_Widget_Tab_Interface
 {
     protected function _construct()
     {
@@ -94,7 +92,7 @@ public function getWidgetInstance()
     /**
      * Prepare form before rendering HTML
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareForm()
     {
@@ -105,7 +103,8 @@ protected function _prepareForm()
             'method' => 'post'
         ));
 
-        $fieldset = $form->addFieldset('base_fieldset',
+        $fieldset = $form->addFieldset(
+            'base_fieldset',
             array('legend'=>Mage::helper('widget')->__('Settings'))
         );
 

app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Grid.php

@@ -48,11 +48,11 @@ protected function _construct()
     /**
      * Prepare grid collection object
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareCollection()
     {
-        /* @var $collection Mage_Widget_Model_Mysql4_Widget_Instance_Collection */
+        /* @var Mage_Widget_Model_Mysql4_Widget_Instance_Collection $collection */
         $collection = Mage::getModel('widget/widget_instance')->getCollection();
         $this->setCollection($collection);
         return parent::_prepareCollection();
@@ -61,7 +61,7 @@ protected function _prepareCollection()
     /**
      * Prepare grid columns
      *
-     * @return $this
+     * @inheritDoc
      */
     protected function _prepareColumns()
     {
@@ -143,6 +143,7 @@ public function getPackageThemeOptionsArray()
     /**
      * Row click url
      *
+     * @param Mage_Widget_Model_Widget_Instance $row
      * @return string
      */
     public function getRowUrl($row)