Mage_Eav - DOC block update

app/code/core/Mage/Eav/Block/Adminhtml/Attribute/Edit/Main/Abstract.php

@@ -36,12 +36,19 @@ abstract class Mage_Eav_Block_Adminhtml_Attribute_Edit_Main_Abstract extends Mag
 {
     protected $_attribute = null;
 
+    /**
+     * @param Mage_Catalog_Model_Resource_Eav_Attribute $attribute
+     * @return $this
+     */
     public function setAttributeObject($attribute)
     {
         $this->_attribute = $attribute;
         return $this;
     }
 
+    /**
+     * @return Mage_Catalog_Model_Resource_Eav_Attribute
+     */
     public function getAttributeObject()
     {
         if (null === $this->_attribute) {
@@ -53,7 +60,7 @@ public function getAttributeObject()
     /**
      * Preparing default form elements for editing attribute
      *
-     * @return Mage_Eav_Block_Adminhtml_Attribute_Edit_Main_Abstract
+     * @inheritDoc
      */
     protected function _prepareForm()
     {
@@ -65,7 +72,8 @@ protected function _prepareForm()
             'method' => 'post'
         ));
 
-        $fieldset = $form->addFieldset('base_fieldset',
+        $fieldset = $form->addFieldset(
+            'base_fieldset',
             array('legend'=>Mage::helper('eav')->__('Attribute Properties'))
         );
         if ($attributeObject->getAttributeId()) {
@@ -78,8 +86,10 @@ protected function _prepareForm()
 
         $yesno = Mage::getModel('adminhtml/system_config_source_yesno')->toOptionArray();
 
-        $validateClass = sprintf('validate-code validate-length maximum-length-%d',
-            Mage_Eav_Model_Entity_Attribute::ATTRIBUTE_CODE_MAX_LENGTH);
+        $validateClass = sprintf(
+            'validate-code validate-length maximum-length-%d',
+            Mage_Eav_Model_Entity_Attribute::ATTRIBUTE_CODE_MAX_LENGTH
+        );
         $fieldset->addField('attribute_code', 'text', array(
             'name'  => 'attribute_code',
             'label' => Mage::helper('eav')->__('Attribute Code'),
@@ -169,7 +179,7 @@ protected function _prepareForm()
     /**
      * Initialize form fileds values
      *
-     * @return Mage_Eav_Block_Adminhtml_Attribute_Edit_Main_Abstract
+     * @inheritDoc
      */
     protected function _initFormValues()
     {
@@ -217,5 +227,4 @@ protected function _afterToHtml($html)
             ->createBlock('eav/adminhtml_attribute_edit_js')->toHtml();
         return $html.$jsScripts;
     }
-
 }

app/code/core/Mage/Eav/Block/Adminhtml/Attribute/Edit/Options/Abstract.php

@@ -43,24 +43,28 @@ public function __construct()
     /**
      * Preparing layout, adding buttons
      *
-     * @return Mage_Eav_Block_Adminhtml_Attribute_Edit_Options_Abstract
+     * @inheritDoc
      */
     protected function _prepareLayout()
     {
-        $this->setChild('delete_button',
+        $this->setChild(
+            'delete_button',
             $this->getLayout()->createBlock('adminhtml/widget_button')
                 ->setData(array(
                     'label' => Mage::helper('eav')->__('Delete'),
                     'class' => 'delete delete-option'
-                )));
+                ))
+        );
 
-        $this->setChild('add_button',
+        $this->setChild(
+            'add_button',
             $this->getLayout()->createBlock('adminhtml/widget_button')
                 ->setData(array(
                     'label' => Mage::helper('eav')->__('Add Option'),
                     'class' => 'add',
                     'id'    => 'add_new_option_button'
-                )));
+                ))
+        );
         return parent::_prepareLayout();
     }
 
@@ -138,6 +142,7 @@ public function getOptionValues()
                 ->load();
 
             $helper = Mage::helper('core');
+            /** @var Mage_Eav_Model_Entity_Attribute_Option $option */
             foreach ($optionCollection as $option) {
                 $value = array();
                 if (in_array($option->getId(), $defaultValues)) {
@@ -199,6 +204,7 @@ public function getStoreOptionValues($storeId)
                 ->setAttributeFilter($this->getAttributeObject()->getId())
                 ->setStoreFilter($storeId, false)
                 ->load();
+            /** @var Mage_Eav_Model_Entity_Attribute_Option $item */
             foreach ($valuesCollection as $item) {
                 $values[$item->getId()] = $item->getValue();
             }
@@ -216,5 +222,4 @@ public function getAttributeObject()
     {
         return Mage::registry('entity_attribute');
     }
-
 }

app/code/core/Mage/Eav/Block/Adminhtml/Attribute/Grid/Abstract.php

@@ -93,11 +93,11 @@ protected function _prepareColumns()
     /**
      * Return url of given row
      *
+     * @param Mage_Catalog_Model_Resource_Eav_Attribute $row
      * @return string
      */
     public function getRowUrl($row)
     {
         return $this->getUrl('*/*/edit', array('attribute_id' => $row->getAttributeId()));
     }
-
 }

app/code/core/Mage/Eav/Exception.php

@@ -24,7 +24,7 @@
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-class Mage_Eav_Exception extends Mage_Core_Exception 
+class Mage_Eav_Exception extends Mage_Core_Exception
 {
 
 }

app/code/core/Mage/Eav/Model/Adminhtml/System/Config/Source/Inputtype.php

@@ -25,6 +25,9 @@
  */
 class Mage_Eav_Model_Adminhtml_System_Config_Source_Inputtype
 {
+    /**
+     * @return array
+     */
     public function toOptionArray()
     {
         return array(

app/code/core/Mage/Eav/Model/Adminhtml/System/Config/Source/Inputtype/Validator.php

@@ -40,7 +40,7 @@ class Mage_Eav_Model_Adminhtml_System_Config_Source_Inputtype_Validator extends
     public function __construct()
     {
         //set data haystack
-        /** @var $helper Mage_Eav_Helper_Data */
+        /** @var Mage_Eav_Helper_Data $helper */
         $helper = Mage::helper('eav');
         $haystack = $helper->getInputTypesValidatorData();
 
@@ -58,7 +58,7 @@ public function __construct()
     /**
      * Initialize message templates with translating
      *
-     * @return Mage_Adminhtml_Model_Core_File_Validator_SavePath_Available
+     * @return Mage_Eav_Model_Adminhtml_System_Config_Source_Inputtype_Validator
      */
     protected function _initMessageTemplates()
     {

app/code/core/Mage/Eav/Model/Attribute.php

@@ -82,7 +82,7 @@ public function getWebsite()
     /**
      * Processing object after save data
      *
-     * @return Mage_Eav_Model_Attribute
+     * @inheritDoc
      */
     protected function _afterSave()
     {
@@ -115,7 +115,7 @@ public function getValidateRules()
         $rules = $this->getData('validate_rules');
         if (is_array($rules)) {
             return $rules;
-        } else if (!empty($rules)) {
+        } elseif (!empty($rules)) {
             return unserialize($rules);
         }
         return array();
@@ -131,7 +131,7 @@ public function setValidateRules($rules)
     {
         if (empty($rules)) {
             $rules = null;
-        } else if (is_array($rules)) {
+        } elseif (is_array($rules)) {
             $rules = serialize($rules);
         }
         $this->setData('validate_rules', $rules);

app/code/core/Mage/Eav/Model/Attribute/Data.php

@@ -58,7 +58,7 @@ class Mage_Eav_Model_Attribute_Data
      */
     public static function factory(Mage_Eav_Model_Attribute $attribute, Mage_Core_Model_Abstract $entity)
     {
-        /* @var $dataModel Mage_Eav_Model_Attribute_Data_Abstract */
+        /* @var Mage_Eav_Model_Attribute_Data_Abstract $dataModel */
         $dataModelClass = $attribute->getDataModel();
         if (!empty($dataModelClass)) {
             if (empty(self::$_dataModels[$dataModelClass])) {

app/code/core/Mage/Eav/Model/Attribute/Data/Abstract.php

@@ -243,7 +243,7 @@ protected function _dateFilterFormat($format = null)
                 $this->_dateFilterFormat = Mage_Core_Model_Locale::FORMAT_TYPE_SHORT;
             }
             return Mage::app()->getLocale()->getDateFormat($this->_dateFilterFormat);
-        } else if ($format === false) {
+        } elseif ($format === false) {
             // reset value
             $this->_dateFilterFormat = null;
             return $this;
@@ -273,7 +273,7 @@ protected function _applyOutputFilter($value)
      * Validate value by attribute input validation rule
      *
      * @param string $value
-     * @return string
+     * @return string|array|true
      */
     protected function _validateInputRule($value)
     {
@@ -453,7 +453,7 @@ protected function _validateInputRule($value)
                         Zend_Validate_Date::FALSEFORMAT
                     );
                     if (!$validator->isValid($value)) {
-                       return array_unique($validator->getMessages());
+                        return array_unique($validator->getMessages());
                     }
 
                     break;

app/code/core/Mage/Eav/Model/Attribute/Data/Datetime.php

@@ -47,10 +47,11 @@ protected function _getFormFilter()
             if ($filterCode == 'datetime') {
                 $filter = new $filterClass(
                     $this->_getLocale()->getDateTimeFormat(Mage_Core_Model_Locale::FORMAT_TYPE_SHORT),
-                    $this->_getLocale()->getLocale());
-                } else {
-                    $filter = new $filterClass();
-                }
+                    $this->_getLocale()->getLocale()
+                );
+            } else {
+                $filter = new $filterClass();
+            }
             return $filter;
         }
         return false;
@@ -61,7 +62,8 @@ protected function _getFormFilter()
      *
      * @return Mage_Core_Model_Locale
      */
-    protected function _getLocale(){
+    protected function _getLocale()
+    {
         return Mage::app()->getLocale();
     }
 }

app/code/core/Mage/Eav/Model/Attribute/Data/File.php

@@ -123,7 +123,7 @@ protected function _validateByRules($value)
         /**
          * Check protected file extension
          */
-        /** @var $validator Mage_Core_Model_File_Validator_NotProtectedExtension */
+        /** @var Mage_Core_Model_File_Validator_NotProtectedExtension $validator */
         $validator = Mage::getSingleton('core/file_validator_notProtectedExtension');
         if (!$validator->isValid($extension)) {
             return $validator->getMessages();
@@ -152,7 +152,7 @@ protected function _validateByRules($value)
      *
      * @param array|string $value
      * @throws Mage_Core_Exception
-     * @return boolean
+     * @return true|array
      */
     public function validateValue($value)
     {
@@ -194,9 +194,9 @@ public function validateValue($value)
     /**
      * Export attribute value to entity model
      *
-     * @param Mage_Core_Model_Abstract $entity
      * @param array|string $value
      * @return $this
+     * @throws Mage_Core_Exception
      */
     public function compactValue($value)
     {
@@ -263,7 +263,9 @@ public function restoreValue($value)
     /**
      * Return formated attribute value from entity model
      *
+     * @param string $format
      * @return string|array
+     * @throws Mage_Core_Exception
      */
     public function outputValue($format = Mage_Eav_Model_Attribute_Data::OUTPUT_FORMAT_TEXT)
     {

app/code/core/Mage/Eav/Model/Attribute/Data/Multiline.php

@@ -103,9 +103,7 @@ public function validateValue($value)
     /**
      * Export attribute value to entity model
      *
-     * @param Mage_Core_Model_Abstract $entity
-     * @param array|string $value
-     * @return $this
+     * @inheritDoc
      */
     public function compactValue($value)
     {
@@ -119,7 +117,7 @@ public function compactValue($value)
      * Restore attribute value from SESSION to entity model
      *
      * @param array|string $value
-     * @return $this
+     * @return Mage_Eav_Model_Attribute_Data_Text
      */
     public function restoreValue($value)
     {
@@ -129,7 +127,9 @@ public function restoreValue($value)
     /**
      * Return formated attribute value from entity model
      *
+     * @param string $format
      * @return string|array
+     * @throws Mage_Core_Exception
      */
     public function outputValue($format = Mage_Eav_Model_Attribute_Data::OUTPUT_FORMAT_TEXT)
     {

app/code/core/Mage/Eav/Model/Attribute/Data/Multiselect.php

@@ -52,8 +52,7 @@ public function extractValue(Zend_Controller_Request_Http $request)
     /**
      * Export attribute value to entity model
      *
-     * @param array|string $value
-     * @return $this
+     * @inheritDoc
      */
     public function compactValue($value)
     {
@@ -66,7 +65,9 @@ public function compactValue($value)
     /**
      * Return formated attribute value from entity model
      *
+     * @param string $format
      * @return string|array
+     * @throws Mage_Core_Exception
      */
     public function outputValue($format = Mage_Eav_Model_Attribute_Data::OUTPUT_FORMAT_TEXT)
     {

app/code/core/Mage/Eav/Model/Attribute/Data/Select.php

@@ -117,7 +117,9 @@ protected function _getOptionText($value)
     /**
      * Return formated attribute value from entity model
      *
+     * @param string $format
      * @return string|array
+     * @throws Mage_Core_Exception
      */
     public function outputValue($format = Mage_Eav_Model_Attribute_Data::OUTPUT_FORMAT_TEXT)
     {