Skip to content

Commit

Permalink
Updated deprecation doc annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
magento-team committed Sep 18, 2019
1 parent 51e61a2 commit a91cfde
Show file tree
Hide file tree
Showing 1,310 changed files with 2,309 additions and 1,396 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Messages extends \Magento\Backend\Block\Template

/**
* @var \Magento\Framework\Json\Helper\Data
* @deprecated
* @deprecated 100.3.0
*/
protected $jsonHelper;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class ListAction extends \Magento\Backend\App\AbstractAction

/**
* @var \Magento\Framework\Json\Helper\Data
* @deprecated
* @deprecated 100.3.0
*/
protected $jsonHelper;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ private function prepareExportData(
* @param array $exportData
* @return array
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
* @deprecated
* @deprecated 100.3.0
* @see prepareExportData
*/
protected function correctExportData($exportData)
Expand Down Expand Up @@ -513,7 +513,7 @@ private function fetchTierPrices(array $productIds): array
* @return array|bool
* @SuppressWarnings(PHPMD.NPathComplexity)
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @deprecated
* @deprecated 100.3.0
* @see fetchTierPrices
*/
protected function getTierPrices(array $listSku, $table)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class ClientResolver
*
* @var ScopeConfigInterface
* @since 100.1.0
* @deprecated since it is not used anymore
* @deprecated 100.3.0 since it is not used anymore
*/
protected $scopeConfig;

Expand Down Expand Up @@ -55,14 +55,14 @@ class ClientResolver
*
* @var string
* @since 100.1.0
* @deprecated since it is not used anymore
* @deprecated 100.3.0 since it is not used anymore
*/
protected $path;

/**
* Config Scope
* @since 100.1.0
* @deprecated since it is not used anymore
* @deprecated 100.3.0 since it is not used anymore
*/
protected $scope;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,35 @@
* Represents converter interface for http request and response body.
*
* @api
* @since 100.2.0
*/
interface ConverterInterface
{
/**
* @param string $body
*
* @return array
* @since 100.2.0
*/
public function fromBody($body);

/**
* @param array $data
*
* @return string
* @since 100.2.0
*/
public function toBody(array $data);

/**
* @return string
* @since 100.2.0
*/
public function getContentTypeHeader();

/**
* @return string
* @since 100.3.0
*/
public function getContentMediaType(): string;
}
1 change: 0 additions & 1 deletion app/code/Magento/Analytics/ReportXml/Query.php
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ public function getConfig()
* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4.0
*/
public function jsonSerialize()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Bulk summary data with list of operations items short data.
*
* @api
* @since 100.2.3
*/
interface BulkStatusInterface extends \Magento\Framework\Bulk\BulkStatusInterface
{
Expand All @@ -23,6 +24,7 @@ interface BulkStatusInterface extends \Magento\Framework\Bulk\BulkStatusInterfac
* @param string $bulkUuid
* @return \Magento\AsynchronousOperations\Api\Data\DetailedBulkOperationsStatusInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException
* @since 100.2.3
*/
public function getBulkDetailedStatus($bulkUuid);

Expand All @@ -32,6 +34,7 @@ public function getBulkDetailedStatus($bulkUuid);
* @param string $bulkUuid
* @return \Magento\AsynchronousOperations\Api\Data\BulkOperationsStatusInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException
* @since 100.2.3
*/
public function getBulkShortStatus($bulkUuid);
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* Temporary data object to give response from webapi async router
*
* @api
* @since 100.2.3
*/
interface AsyncResponseInterface
{
Expand All @@ -24,6 +25,7 @@ interface AsyncResponseInterface
* Gets the bulk uuid.
*
* @return string Bulk Uuid.
* @since 100.2.3
*/
public function getBulkUuid();

Expand All @@ -32,13 +34,15 @@ public function getBulkUuid();
*
* @param string $bulkUuid
* @return $this
* @since 100.2.3
*/
public function setBulkUuid($bulkUuid);

/**
* Gets the list of request items with status data.
*
* @return \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[]
* @since 100.2.3
*/
public function getRequestItems();

Expand All @@ -47,26 +51,30 @@ public function getRequestItems();
*
* @param \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[] $requestItems
* @return $this
* @since 100.2.3
*/
public function setRequestItems($requestItems);

/**
* @param bool $isErrors
* @return $this
* @since 100.2.3
*/
public function setErrors($isErrors = false);

/**
* Is there errors during processing bulk
*
* @return boolean
* @since 100.2.3
*/
public function isErrors();

/**
* Retrieve existing extension attributes object.
*
* @return \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface|null
* @since 100.2.3
*/
public function getExtensionAttributes();

Expand All @@ -75,6 +83,7 @@ public function getExtensionAttributes();
*
* @param \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes
* @return $this
* @since 100.2.3
*/
public function setExtensionAttributes(
\Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Bulk summary data with list of operations items summary data.
*
* @api
* @since 100.2.3
*/
interface BulkOperationsStatusInterface extends BulkSummaryInterface
{
Expand All @@ -24,6 +25,7 @@ interface BulkOperationsStatusInterface extends BulkSummaryInterface
* Retrieve list of operation with statuses (short data).
*
* @return \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[]
* @since 100.2.3
*/
public function getOperationsList();

Expand All @@ -32,6 +34,7 @@ public function getOperationsList();
*
* @param \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[] $operationStatusList
* @return $this
* @since 100.2.3
*/
public function setOperationsList($operationStatusList);
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public function setExtensionAttributes(
* Get user type
*
* @return int
* @since 100.3.0
*/
public function getUserType();

Expand All @@ -46,6 +47,7 @@ public function getUserType();
*
* @param int $userType
* @return $this
* @since 100.3.0
*/
public function setUserType($userType);
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Bulk summary data with list of operations items full data.
*
* @api
* @since 100.2.3
*/
interface DetailedBulkOperationsStatusInterface extends BulkSummaryInterface
{
Expand All @@ -24,6 +25,7 @@ interface DetailedBulkOperationsStatusInterface extends BulkSummaryInterface
* Retrieve operations list.
*
* @return \Magento\AsynchronousOperations\Api\Data\OperationInterface[]
* @since 100.2.3
*/
public function getOperationsList();

Expand All @@ -32,6 +34,7 @@ public function getOperationsList();
*
* @param \Magento\AsynchronousOperations\Api\Data\OperationInterface[] $operationStatusList
* @return $this
* @since 100.2.3
*/
public function setOperationsList($operationStatusList);
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Indicate if entity param was Accepted|Rejected to bulk schedule
*
* @api
* @since 100.2.3
*/
interface ItemStatusInterface
{
Expand All @@ -30,6 +31,7 @@ interface ItemStatusInterface
* Get entity Id.
*
* @return int
* @since 100.2.3
*/
public function getId();

Expand All @@ -38,13 +40,15 @@ public function getId();
*
* @param int $entityId
* @return $this
* @since 100.2.3
*/
public function setId($entityId);

/**
* Get hash of entity data.
*
* @return string md5 hash of entity params array.
* @since 100.2.3
*/
public function getDataHash();

Expand All @@ -53,13 +57,15 @@ public function getDataHash();
*
* @param string $hash md5 hash of entity params array.
* @return $this
* @since 100.2.3
*/
public function setDataHash($hash);

/**
* Get status.
*
* @return string accepted|rejected
* @since 100.2.3
*/
public function getStatus();

Expand All @@ -68,13 +74,15 @@ public function getStatus();
*
* @param string $status accepted|rejected
* @return $this
* @since 100.2.3
*/
public function setStatus($status = self::STATUS_ACCEPTED);

/**
* Get error information.
*
* @return string|null
* @since 100.2.3
*/
public function getErrorMessage();

Expand All @@ -83,13 +91,15 @@ public function getErrorMessage();
*
* @param string|null|\Exception $error
* @return $this
* @since 100.2.3
*/
public function setErrorMessage($error = null);

/**
* Get error code.
*
* @return int|null
* @since 100.2.3
*/
public function getErrorCode();

Expand All @@ -98,6 +108,7 @@ public function getErrorCode();
*
* @param int|null|\Exception $errorCode Default: null
* @return $this
* @since 100.2.3
*/
public function setErrorCode($errorCode = null);
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@
*
* An bulk is a group of queue messages. An bulk operation item is a queue message.
* @api
* @since 100.3.0
*/
interface OperationSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
{
/**
* Get list of operations.
*
* @return \Magento\AsynchronousOperations\Api\Data\OperationInterface[]
* @since 100.3.0
*/
public function getItems();

Expand All @@ -28,6 +30,7 @@ public function getItems();
*
* @param \Magento\AsynchronousOperations\Api\Data\OperationInterface[] $items
* @return $this
* @since 100.3.0
*/
public function setItems(array $items);
}
Loading

0 comments on commit a91cfde

Please sign in to comment.