Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated DOCblocks (fixed param null) #2776

Merged
merged 5 commits into from
Dec 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ public function getCategoryChildrenJson($categoryId)
/**
* Returns URL for loading tree
*
* @param null $expanded
* @param null $expanded deprecated
* @return string
*/
public function getLoadTreeUrl($expanded = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ protected function _getTaxObservingCode($attribute)
}

/**
* @param null $index
* @param null $index deprecated
* @return string|null
*/
public function getEscapedValue($index = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ public function getSelectionAttributes($item)
}

/**
* @param null $item
* @param null $item deprecated
* @return array
*/
public function getOrderOptions($item = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
class Mage_Bundle_Block_Sales_Order_Items_Renderer extends Mage_Sales_Block_Order_Item_Renderer_Default
{
/**
* @param null $item
* @param Varien_Object|null $item
* @return bool
*/
public function isShipmentSeparately($item = null)
Expand Down Expand Up @@ -72,7 +72,7 @@ public function isShipmentSeparately($item = null)
}

/**
* @param null $item
* @param Varien_Object|null $item
* @return bool
*/
public function isChildCalculated($item = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,11 @@ public function getTimeHtml()
/**
* Return drop-down html with range of values
*
* @param string $name Id/name of html select element
* @param int $from Start position
* @param int $to End position
* @param int $value Value selected
* @return string Formatted Html
* @param string $name Id/name of html select element
* @param string|int $from Start position
* @param string|int $to End position
* @param string $value Value selected
* @return string Formatted Html
*/
protected function _getSelectFromToHtml($name, $from, $to, $value = null)
{
Expand All @@ -183,14 +183,13 @@ protected function _getSelectFromToHtml($name, $from, $to, $value = null)
* HTML select element
*
* @param string $name Id/name of html select element
* @param null $value
* @param string|null $value
* @return Mage_Core_Block_Html_Select
*/
protected function _getHtmlSelect($name, $value = null)
{
$option = $this->getOption();

// $require = $this->getOption()->getIsRequire() ? ' required-entry' : '';
$require = '';
$select = $this->getLayout()->createBlock('core/html_select')
->setId('options_' . $this->getOption()->getId() . '_' . $name)
Expand Down
10 changes: 5 additions & 5 deletions app/code/core/Mage/Catalog/Model/Category/Api.php
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public function level($website = null, $store = null, $categoryId = null)
/**
* Retrieve category tree
*
* @param null $parentId
* @param int|null $parentId
* @param string|int $store
* @return array
* @throws Mage_Core_Model_Store_Exception
Expand Down Expand Up @@ -478,8 +478,8 @@ public function assignProduct($categoryId, $productId, $position = null, $identi
*
* @param int $categoryId
* @param int $productId
* @param int $position
* @param null $identifierType
* @param int|null $position
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down Expand Up @@ -507,8 +507,8 @@ public function updateProduct($categoryId, $productId, $position = null, $identi
* Remove product assignment from category
*
* @param int $categoryId
* @param int $productId
* @param null $identifierType
* @param int|null $productId
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Category/Api/V2.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public function info($categoryId, $store = null, $attributes = null)
*
* @param int $parentId
* @param array $categoryData
* @param null $store
* @param int|string|null $store
* @return int
* @throws Mage_Api_Exception
* @throws Mage_Eav_Model_Entity_Attribute_Exception
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Layer/Filter/Abstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function getCleanValue()
* Apply filter to collection
*
* @param Zend_Controller_Request_Abstract $request
* @param null $filterBlock
* @param null $filterBlock deprecated
* @return $this
*/
public function apply(Zend_Controller_Request_Abstract $request, $filterBlock)
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Layer/Filter/Price.php
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ protected function _validateFilter($filter)
* Apply price range filter
*
* @param Zend_Controller_Request_Abstract $request
* @param null $filterBlock
* @param null $filterBlock deprecated
*
* @return $this
*/
Expand Down
6 changes: 3 additions & 3 deletions app/code/core/Mage/Catalog/Model/Product/Api.php
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,8 @@ public function create($type, $set, $sku, $productData, $store = null)
*
* @param int|string $productId
* @param array $productData
* @param string|int $store
* @param null $identifierType
* @param string|int|null $store
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
* @throws Mage_Core_Model_Store_Exception
Expand Down Expand Up @@ -370,7 +370,7 @@ public function getSpecialPrice($productId, $store = null)
* Delete product
*
* @param int|string $productId
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Product/Api/V2.php
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public function create($type, $set, $sku, $productData, $store = null)
* @param int|string $productId
* @param array $productData
* @param string|int $store
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
* @throws Mage_Core_Model_Store_Exception
Expand Down
10 changes: 5 additions & 5 deletions app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public function __construct()
*
* @param int|string $productId
* @param string|int $store
* @param null $identifierType
* @param string|null $identifierType
* @return array
*/
public function items($productId, $store = null, $identifierType = null)
Expand Down Expand Up @@ -85,7 +85,7 @@ public function items($productId, $store = null, $identifierType = null)
* @param int|string $productId
* @param string $file
* @param string|int $store
* @param null $identifierType
* @param string|null $identifierType
* @return array
* @throws Mage_Api_Exception
*/
Expand All @@ -108,7 +108,7 @@ public function info($productId, $file, $store = null, $identifierType = null)
* @param int|string $productId
* @param array $data
* @param string|int $store
* @param null $identifierType
* @param string|null $identifierType
* @return string
* @throws Mage_Api_Exception
*/
Expand Down Expand Up @@ -199,7 +199,7 @@ public function create($productId, $data, $store = null, $identifierType = null)
* @param string $file
* @param array $data
* @param string|int $store
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down Expand Up @@ -270,7 +270,7 @@ public function update($productId, $file, $data, $store = null, $identifierType
*
* @param int|string $productId
* @param string $file
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public function __construct()

/**
* @param int $productId
* @param null $identifierType
* @param string|null $identifierType
* @return array
* @throws Mage_Core_Exception
*/
Expand Down Expand Up @@ -74,7 +74,7 @@ public function info($productId, $identifierType = null)
*
* @param int|string $productId
* @param array $tierPrices
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Product/Image.php
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ public function setSize($size)

/**
* @deprecated
* @param null $file
* @param string|null $file
* @return bool
*/
protected function _checkMemory($file = null)
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Catalog/Model/Product/Link.php
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public function getLinkCollection()
}

/**
* @param null $type
* @param int|null $type
* @return array
*/
public function getAttributes($type = null)
Expand Down
4 changes: 2 additions & 2 deletions app/code/core/Mage/Catalog/Model/Product/Link/Api/V2.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class Mage_Catalog_Model_Product_Link_Api_V2 extends Mage_Catalog_Model_Product_
* @param int|string $productId
* @param int|string $linkedProductId
* @param array $data
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down Expand Up @@ -93,7 +93,7 @@ public function assign($type, $productId, $linkedProductId, $data = [], $identif
* @param int|string $productId
* @param int|string $linkedProductId
* @param array $data
* @param null $identifierType
* @param string|null $identifierType
* @return bool
* @throws Mage_Api_Exception
*/
Expand Down
17 changes: 8 additions & 9 deletions app/code/core/Mage/Catalog/Model/Product/Type/Abstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ public function getEditableAttributes($product = null)
* Retrieve product attribute by identifier
*
* @param int $attributeId
* @param null $product
* @return Mage_Eav_Model_Entity_Attribute_Abstract
* @param Mage_Catalog_Model_Product $product
* @return Mage_Eav_Model_Entity_Attribute_Abstract|null
*/
public function getAttributeById($attributeId, $product = null)
{
Expand Down Expand Up @@ -800,9 +800,8 @@ public function hasOptions($product = null)
* @param array $options
* @param Varien_Object $option
* @param mixed $value
*
* @param null $product
* @return object Mage_Catalog_Model_Product_Type_Abstract
* @param Mage_Catalog_Model_Product $product
* @return $this
*/
public function updateQtyOption($options, Varien_Object $option, $value, $product = null)
{
Expand All @@ -826,7 +825,7 @@ public function hasRequiredOptions($product = null)
/**
* Retrieve store filter for associated products
*
* @param null $product
* @param Mage_Catalog_Model_Product|null $product
* @return int|Mage_Core_Model_Store
*/
public function getStoreFilter($product = null)
Expand All @@ -839,7 +838,7 @@ public function getStoreFilter($product = null)
* Set store filter for associated products
*
* @param int|Mage_Core_Model_Store $store
* @param null $product
* @param Mage_Catalog_Model_Product|null $product
* @return $this
*/
public function setStoreFilter($store = null, $product = null)
Expand All @@ -853,7 +852,7 @@ public function setStoreFilter($store = null, $product = null)
* Allow for updates of children quantities
* (applicable for complicated product types. As default returns false)
*
* @param null $product
* @param Mage_Catalog_Model_Product|null $product
* @return bool false
*/
public function getForceChildItemQtyChanges($product = null)
Expand All @@ -865,7 +864,7 @@ public function getForceChildItemQtyChanges($product = null)
* Prepare Quote Item Quantity
*
* @param mixed $qty
* @param null $product
* @param Mage_Catalog_Model_Product|null $product
* @return float
*/
public function prepareQuoteItemQty($qty, $product = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -523,8 +523,8 @@ protected function _refreshDirectRelations($categoryIds = null, $productIds = nu
/**
* Rebuild index for anchor categories and associated to child categories products
*
* @param null | array $categoryIds
* @param null | array $productIds
* @param null|array $categoryIds
* @param null|array $productIds
* @return $this
*/
protected function _refreshAnchorRelations($categoryIds = null, $productIds = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,8 @@ public function applyFilterToCollection($filter, $range, $index)
* @param Mage_Catalog_Model_Layer_Filter_Price $filter
* @param int $limit
* @param null|int $offset
* @param null|int $lowerPrice
* @param null|int $upperPrice
* @param null|float $lowerPrice
* @param null|float $upperPrice
* @return array
*/
public function loadPrices($filter, $limit, $offset = null, $lowerPrice = null, $upperPrice = null)
Expand All @@ -327,7 +327,7 @@ public function loadPrices($filter, $limit, $offset = null, $lowerPrice = null,
* @param Mage_Catalog_Model_Layer_Filter_Price $filter
* @param float $price
* @param int $index
* @param null $lowerPrice
* @param float|null $lowerPrice
* @return array|false
*/
public function loadPreviousPrices($filter, $price, $index, $lowerPrice = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,7 @@ public function getSelectCountSql()
/**
* Get SQL for get record count
*
* @param null $select
* @param Varien_Db_Select|null $select
* @param bool $resetLeftJoins
* @return Varien_Db_Select
*/
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/CatalogInventory/Model/Stock/Status.php
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public function getProductTypeInstance($productType)
/**
* Retrieve website models
*
* @param null $websiteId
* @param string|int|null $websiteId
* @return array
*/
public function getWebsites($websiteId = null)
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Checkout/Block/Cart/Sidebar.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function getItemCount()
/**
* Get array of last added items
*
* @param null $count
* @param int|null $count
* @return array
*/
public function getRecentItems($count = null)
Expand Down
4 changes: 2 additions & 2 deletions app/code/core/Mage/Checkout/Block/Cart/Totals.php
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ protected function _getTotalRenderer($code)

/**
* @param Mage_Sales_Model_Quote_Address_Total $total
* @param null $area
* @param string|null $area
* @param int $colspan
* @return mixed
* @return string
*/
public function renderTotal($total, $area = null, $colspan = 1)
{
Expand Down
Loading