Skip to content

Commit 71a2751

Browse files
sreichelfballiano
andauthored
Some fixes for phpdocs (OpenMage#2588)
* Some phpdocs updates * Minor fixes Co-authored-by: Fabrizio Balliano <fabrizio.balliano@gmail.com>
1 parent ad28ba4 commit 71a2751

File tree

59 files changed

+85
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+85
-114
lines changed

app/code/core/Mage/Admin/Model/Acl/Assert/Ip.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ class Mage_Admin_Model_Acl_Assert_Ip implements Zend_Acl_Assert_Interface
3131
* Check whether ip is allowed
3232
*
3333
* @param Mage_Admin_Model_Acl $acl
34-
* @param Mage_Admin_Model_Acl_Role $role
35-
* @param Mage_Admin_Model_Acl_Resource $resource
36-
* @param string $privilege
37-
* @return bool
34+
* @param Mage_Admin_Model_Acl_Role|null $role
35+
* @param Mage_Admin_Model_Acl_Resource|null $resource
36+
* @param string|null $privilege
37+
* @return bool|null
3838
*/
3939
public function assert(
4040
Mage_Admin_Model_Acl $acl,

app/code/core/Mage/Admin/Model/Acl/Assert/Time.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ class Mage_Admin_Model_Acl_Assert_Time implements Zend_Acl_Assert_Interface
3131
* Assert time
3232
*
3333
* @param Mage_Admin_Model_Acl $acl
34-
* @param Mage_Admin_Model_Acl_Role $role
35-
* @param Mage_Admin_Model_Acl_Resource $resource
36-
* @param string $privilege
37-
* @return bool
34+
* @param Mage_Admin_Model_Acl_Role|null $role
35+
* @param Mage_Admin_Model_Acl_Resource|null $resource
36+
* @param string|null $privilege
37+
* @return bool|null
3838
*/
3939
public function assert(
4040
Mage_Admin_Model_Acl $acl,

app/code/core/Mage/Admin/Model/Redirectpolicy.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public function __construct($parameters = [])
4545
* Redirect to startup page after logging in if request contains any params (except security key)
4646
*
4747
* @param Mage_Admin_Model_User $user
48-
* @param Zend_Controller_Request_Http $request
48+
* @param Zend_Controller_Request_Http|null $request
4949
* @param string|null $alternativeUrl
5050
* @return null|string
5151
*/

app/code/core/Mage/Adminhtml/Block/Catalog/Product/Composite/Configure.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public function getProduct()
5757
/**
5858
* Set product object
5959
*
60-
* @param Mage_Catalog_Model_Product $product
60+
* @param Mage_Catalog_Model_Product|null $product
6161
* @return $this
6262
*/
6363
public function setProduct(Mage_Catalog_Model_Product $product = null)

app/code/core/Mage/Adminhtml/Block/Customer/Edit/Tab/Wishlist.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,6 @@ public function getGridUrl()
192192
*/
193193
protected function _addColumnFilterToCollection($column)
194194
{
195-
/** @var Mage_Wishlist_Model_Resource_Item_Collection $collection */
196195
$collection = $this->getCollection();
197196
$value = $column->getFilter()->getValue();
198197
if ($collection && $value) {

app/code/core/Mage/Adminhtml/Block/System/Config/Form/Field/Array/Abstract.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public function getArrayRows()
135135
return $this->_arrayRowsCache;
136136
}
137137
$result = [];
138-
/** @var Varien_Data_Form_Element_Abstract */
138+
/** @var Varien_Data_Form_Element_Abstract $element */
139139
$element = $this->getElement();
140140
if ($element->getValue() && is_array($element->getValue())) {
141141
foreach ($element->getValue() as $rowId => $row) {

app/code/core/Mage/Adminhtml/Block/System/Convert/Gui/Edit/Tabs.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ protected function _beforeToHtml()
6767
'content' => $this->getLayout()->createBlock('adminhtml/system_convert_profile_edit_tab_run')->toHtml(),
6868
]);
6969

70-
/** @var Mage_Adminhtml_Block_System_Convert_Gui_Edit_Tab_View
71-
$block */
70+
/** @var Mage_Adminhtml_Block_System_Convert_Gui_Edit_Tab_View $block */
7271
$block = $this->getLayout()->createBlock('adminhtml/system_convert_gui_edit_tab_view');
7372
$this->addTab('view', [
7473
'label' => Mage::helper('adminhtml')->__('Profile Actions XML'),

app/code/core/Mage/Adminhtml/Model/Sales/Order/Create.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1663,7 +1663,7 @@ protected function _getNewCustomerEmail($customer)
16631663
protected function _putCustomerIntoQuote()
16641664
{
16651665
if (!$this->getSession()->getCustomer()->getId()) {
1666-
/** @var Mage_Customer_Model_Customer*/
1666+
/** @var Mage_Customer_Model_Customer $customer */
16671667
$customer = Mage::getModel('customer/customer');
16681668

16691669
$customer->addData($this->getBillingAddress()->exportCustomerAddress()->getData())

app/code/core/Mage/Adminhtml/controllers/Sales/Order/CreateController.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -475,8 +475,6 @@ public function cancelAction()
475475

476476
/**
477477
* Saving quote and create order
478-
*
479-
* @throws Mage_Core_Exception
480478
*/
481479
public function saveAction()
482480
{

app/code/core/Mage/Api/Model/Acl/Assert/Ip.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ class Mage_Api_Model_Acl_Assert_Ip implements Zend_Acl_Assert_Interface
3131
* Check whether ip is allowed
3232
*
3333
* @param Mage_Api_Model_Acl $acl
34-
* @param Mage_Api_Model_Acl_Role $role
35-
* @param Mage_Api_Model_Acl_Resource $resource
36-
* @param string $privilege
37-
* @return bool
34+
* @param Mage_Api_Model_Acl_Role|null $role
35+
* @param Mage_Api_Model_Acl_Resource|null $resource
36+
* @param string|null $privilege
37+
* @return bool|null
3838
*/
3939
public function assert(
4040
Mage_Api_Model_Acl $acl,

0 commit comments

Comments
 (0)