Skip to content

Commit 6729b6e

Browse files
committed
Updated deprecation doc annotations
1 parent 19af792 commit 6729b6e

File tree

1,273 files changed

+2390
-1334
lines changed

Some content is hidden

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

1,273 files changed

+2390
-1334
lines changed

app/code/Magento/AdminNotification/Block/System/Messages.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class Messages extends Template
2626

2727
/**
2828
* @var JsonDataHelper
29-
* @deprecated
29+
* @deprecated 100.3.0
3030
*/
3131
protected $jsonHelper;
3232

app/code/Magento/AdminNotification/Controller/Adminhtml/System/Message/ListAction.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ListAction extends \Magento\Backend\App\AbstractAction
1717

1818
/**
1919
* @var \Magento\Framework\Json\Helper\Data
20-
* @deprecated
20+
* @deprecated 100.3.0
2121
*/
2222
protected $jsonHelper;
2323

app/code/Magento/AdvancedPricingImportExport/Model/Export/AdvancedPricing.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ private function prepareExportData(
381381
* @param array $exportData
382382
* @return array
383383
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
384-
* @deprecated
384+
* @deprecated 100.3.0
385385
* @see prepareExportData
386386
*/
387387
protected function correctExportData($exportData)
@@ -510,7 +510,7 @@ private function fetchTierPrices(array $productIds): array
510510
* @return array|bool
511511
* @SuppressWarnings(PHPMD.NPathComplexity)
512512
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
513-
* @deprecated
513+
* @deprecated 100.3.0
514514
* @see fetchTierPrices
515515
*/
516516
protected function getTierPrices(array $listSku, $table)

app/code/Magento/AdvancedSearch/Model/Client/ClientResolver.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class ClientResolver
2020
*
2121
* @var ScopeConfigInterface
2222
* @since 100.1.0
23-
* @deprecated since it is not used anymore
23+
* @deprecated 100.3.0 since it is not used anymore
2424
*/
2525
protected $scopeConfig;
2626

@@ -56,14 +56,14 @@ class ClientResolver
5656
*
5757
* @var string
5858
* @since 100.1.0
59-
* @deprecated since it is not used anymore
59+
* @deprecated 100.3.0 since it is not used anymore
6060
*/
6161
protected $path;
6262

6363
/**
6464
* Config Scope
6565
* @since 100.1.0
66-
* @deprecated since it is not used anymore
66+
* @deprecated 100.3.0 since it is not used anymore
6767
*/
6868
protected $scope;
6969

app/code/Magento/Analytics/Model/Connector/Http/ConverterInterface.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,35 @@
99
* Represents converter interface for http request and response body.
1010
*
1111
* @api
12+
* @since 100.2.0
1213
*/
1314
interface ConverterInterface
1415
{
1516
/**
1617
* @param string $body
1718
*
1819
* @return array
20+
* @since 100.2.0
1921
*/
2022
public function fromBody($body);
2123

2224
/**
2325
* @param array $data
2426
*
2527
* @return string
28+
* @since 100.2.0
2629
*/
2730
public function toBody(array $data);
2831

2932
/**
3033
* @return string
34+
* @since 100.2.0
3135
*/
3236
public function getContentTypeHeader();
3337

3438
/**
3539
* @return string
40+
* @since 100.3.0
3641
*/
3742
public function getContentMediaType(): string;
3843
}

app/code/Magento/Analytics/ReportXml/Query.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ public function getConfig()
8181
* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
8282
* @return mixed data which can be serialized by <b>json_encode</b>,
8383
* which is a value of any type other than a resource.
84-
* @since 5.4.0
8584
*/
8685
public function jsonSerialize()
8786
{

app/code/Magento/AsynchronousOperations/Api/BulkStatusInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Bulk summary data with list of operations items short data.
1515
*
1616
* @api
17+
* @since 100.2.3
1718
*/
1819
interface BulkStatusInterface extends \Magento\Framework\Bulk\BulkStatusInterface
1920
{
@@ -23,6 +24,7 @@ interface BulkStatusInterface extends \Magento\Framework\Bulk\BulkStatusInterfac
2324
* @param string $bulkUuid
2425
* @return \Magento\AsynchronousOperations\Api\Data\DetailedBulkOperationsStatusInterface
2526
* @throws \Magento\Framework\Exception\NoSuchEntityException
27+
* @since 100.2.3
2628
*/
2729
public function getBulkDetailedStatus($bulkUuid);
2830

@@ -32,6 +34,7 @@ public function getBulkDetailedStatus($bulkUuid);
3234
* @param string $bulkUuid
3335
* @return \Magento\AsynchronousOperations\Api\Data\BulkOperationsStatusInterface
3436
* @throws \Magento\Framework\Exception\NoSuchEntityException
37+
* @since 100.2.3
3538
*/
3639
public function getBulkShortStatus($bulkUuid);
3740
}

app/code/Magento/AsynchronousOperations/Api/Data/AsyncResponseInterface.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* Temporary data object to give response from webapi async router
1414
*
1515
* @api
16+
* @since 100.2.3
1617
*/
1718
interface AsyncResponseInterface
1819
{
@@ -24,6 +25,7 @@ interface AsyncResponseInterface
2425
* Gets the bulk uuid.
2526
*
2627
* @return string Bulk Uuid.
28+
* @since 100.2.3
2729
*/
2830
public function getBulkUuid();
2931

@@ -32,13 +34,15 @@ public function getBulkUuid();
3234
*
3335
* @param string $bulkUuid
3436
* @return $this
37+
* @since 100.2.3
3538
*/
3639
public function setBulkUuid($bulkUuid);
3740

3841
/**
3942
* Gets the list of request items with status data.
4043
*
4144
* @return \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[]
45+
* @since 100.2.3
4246
*/
4347
public function getRequestItems();
4448

@@ -47,26 +51,30 @@ public function getRequestItems();
4751
*
4852
* @param \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[] $requestItems
4953
* @return $this
54+
* @since 100.2.3
5055
*/
5156
public function setRequestItems($requestItems);
5257

5358
/**
5459
* @param bool $isErrors
5560
* @return $this
61+
* @since 100.2.3
5662
*/
5763
public function setErrors($isErrors = false);
5864

5965
/**
6066
* Is there errors during processing bulk
6167
*
6268
* @return boolean
69+
* @since 100.2.3
6370
*/
6471
public function isErrors();
6572

6673
/**
6774
* Retrieve existing extension attributes object.
6875
*
6976
* @return \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface|null
77+
* @since 100.2.3
7078
*/
7179
public function getExtensionAttributes();
7280

@@ -75,6 +83,7 @@ public function getExtensionAttributes();
7583
*
7684
* @param \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes
7785
* @return $this
86+
* @since 100.2.3
7887
*/
7988
public function setExtensionAttributes(
8089
\Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes

app/code/Magento/AsynchronousOperations/Api/Data/BulkOperationsStatusInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Bulk summary data with list of operations items summary data.
1515
*
1616
* @api
17+
* @since 100.2.3
1718
*/
1819
interface BulkOperationsStatusInterface extends BulkSummaryInterface
1920
{
@@ -24,6 +25,7 @@ interface BulkOperationsStatusInterface extends BulkSummaryInterface
2425
* Retrieve list of operation with statuses (short data).
2526
*
2627
* @return \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[]
28+
* @since 100.2.3
2729
*/
2830
public function getOperationsList();
2931

@@ -32,6 +34,7 @@ public function getOperationsList();
3234
*
3335
* @param \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[] $operationStatusList
3436
* @return $this
37+
* @since 100.2.3
3538
*/
3639
public function setOperationsList($operationStatusList);
3740
}

app/code/Magento/AsynchronousOperations/Api/Data/BulkSummaryInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ public function setExtensionAttributes(
3838
* Get user type
3939
*
4040
* @return int
41+
* @since 100.3.0
4142
*/
4243
public function getUserType();
4344

@@ -46,6 +47,7 @@ public function getUserType();
4647
*
4748
* @param int $userType
4849
* @return $this
50+
* @since 100.3.0
4951
*/
5052
public function setUserType($userType);
5153
}

app/code/Magento/AsynchronousOperations/Api/Data/DetailedBulkOperationsStatusInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Bulk summary data with list of operations items full data.
1515
*
1616
* @api
17+
* @since 100.2.3
1718
*/
1819
interface DetailedBulkOperationsStatusInterface extends BulkSummaryInterface
1920
{
@@ -24,6 +25,7 @@ interface DetailedBulkOperationsStatusInterface extends BulkSummaryInterface
2425
* Retrieve operations list.
2526
*
2627
* @return \Magento\AsynchronousOperations\Api\Data\OperationInterface[]
28+
* @since 100.2.3
2729
*/
2830
public function getOperationsList();
2931

@@ -32,6 +34,7 @@ public function getOperationsList();
3234
*
3335
* @param \Magento\AsynchronousOperations\Api\Data\OperationInterface[] $operationStatusList
3436
* @return $this
37+
* @since 100.2.3
3538
*/
3639
public function setOperationsList($operationStatusList);
3740
}

app/code/Magento/AsynchronousOperations/Api/Data/ItemStatusInterface.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Indicate if entity param was Accepted|Rejected to bulk schedule
1515
*
1616
* @api
17+
* @since 100.2.3
1718
*/
1819
interface ItemStatusInterface
1920
{
@@ -30,6 +31,7 @@ interface ItemStatusInterface
3031
* Get entity Id.
3132
*
3233
* @return int
34+
* @since 100.2.3
3335
*/
3436
public function getId();
3537

@@ -38,13 +40,15 @@ public function getId();
3840
*
3941
* @param int $entityId
4042
* @return $this
43+
* @since 100.2.3
4144
*/
4245
public function setId($entityId);
4346

4447
/**
4548
* Get hash of entity data.
4649
*
4750
* @return string md5 hash of entity params array.
51+
* @since 100.2.3
4852
*/
4953
public function getDataHash();
5054

@@ -53,13 +57,15 @@ public function getDataHash();
5357
*
5458
* @param string $hash md5 hash of entity params array.
5559
* @return $this
60+
* @since 100.2.3
5661
*/
5762
public function setDataHash($hash);
5863

5964
/**
6065
* Get status.
6166
*
6267
* @return string accepted|rejected
68+
* @since 100.2.3
6369
*/
6470
public function getStatus();
6571

@@ -68,13 +74,15 @@ public function getStatus();
6874
*
6975
* @param string $status accepted|rejected
7076
* @return $this
77+
* @since 100.2.3
7178
*/
7279
public function setStatus($status = self::STATUS_ACCEPTED);
7380

7481
/**
7582
* Get error information.
7683
*
7784
* @return string|null
85+
* @since 100.2.3
7886
*/
7987
public function getErrorMessage();
8088

@@ -83,13 +91,15 @@ public function getErrorMessage();
8391
*
8492
* @param string|null|\Exception $error
8593
* @return $this
94+
* @since 100.2.3
8695
*/
8796
public function setErrorMessage($error = null);
8897

8998
/**
9099
* Get error code.
91100
*
92101
* @return int|null
102+
* @since 100.2.3
93103
*/
94104
public function getErrorCode();
95105

@@ -98,6 +108,7 @@ public function getErrorCode();
98108
*
99109
* @param int|null|\Exception $errorCode Default: null
100110
* @return $this
111+
* @since 100.2.3
101112
*/
102113
public function setErrorCode($errorCode = null);
103114
}

app/code/Magento/AsynchronousOperations/Api/Data/OperationSearchResultsInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@
1313
*
1414
* An bulk is a group of queue messages. An bulk operation item is a queue message.
1515
* @api
16+
* @since 100.3.0
1617
*/
1718
interface OperationSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
1819
{
1920
/**
2021
* Get list of operations.
2122
*
2223
* @return \Magento\AsynchronousOperations\Api\Data\OperationInterface[]
24+
* @since 100.3.0
2325
*/
2426
public function getItems();
2527

@@ -28,6 +30,7 @@ public function getItems();
2830
*
2931
* @param \Magento\AsynchronousOperations\Api\Data\OperationInterface[] $items
3032
* @return $this
33+
* @since 100.3.0
3134
*/
3235
public function setItems(array $items);
3336
}

0 commit comments

Comments
 (0)