Skip to content

Commit 061ae6b

Browse files
author
Oleksii Korshenko
committed
MAGETWO-71174: Update doc block information in php classes with @deprecated and @SInCE tags
 - updated missing items
1 parent 8d7d902 commit 061ae6b

File tree

178 files changed

+84
-1229
lines changed

Some content is hidden

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

178 files changed

+84
-1229
lines changed

‎app/code/Magento/Vault/Api/Data/PaymentTokenFactoryInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
/**
1010
* Interface PaymentTokenFactoryInterface
1111
* @api
12-
* @since 2.2.0
12+
* @since 100.3.0
1313
*/
1414
interface PaymentTokenFactoryInterface
1515
{
@@ -24,7 +24,7 @@ interface PaymentTokenFactoryInterface
2424
* Create payment token entity
2525
* @param $type string|null
2626
* @return PaymentTokenInterface
27-
* @since 2.2.0
27+
* @since 100.3.0
2828
*/
2929
public function create($type = null);
3030
}

‎app/code/Magento/Vault/Api/Data/PaymentTokenInterface.php

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
* Gateway vault payment token interface.
1010
*
1111
* @api
12-
* @since 2.1.0
1312
* @since 100.1.0
1413
*/
1514
interface PaymentTokenInterface
@@ -66,7 +65,6 @@ interface PaymentTokenInterface
6665
* Gets the entity ID.
6766
*
6867
* @return int|null Entity ID.
69-
* @since 2.1.0
7068
* @since 100.1.0
7169
*/
7270
public function getEntityId();
@@ -76,7 +74,6 @@ public function getEntityId();
7674
*
7775
* @param int $entityId
7876
* @return $this
79-
* @since 2.1.0
8077
* @since 100.1.0
8178
*/
8279
public function setEntityId($entityId);
@@ -85,7 +82,6 @@ public function setEntityId($entityId);
8582
* Gets the customer ID.
8683
*
8784
* @return int|null Customer ID.
88-
* @since 2.1.0
8985
* @since 100.1.0
9086
*/
9187
public function getCustomerId();
@@ -95,7 +91,6 @@ public function getCustomerId();
9591
*
9692
* @param int $customerId
9793
* @return $this
98-
* @since 2.1.0
9994
* @since 100.1.0
10095
*/
10196
public function setCustomerId($customerId);
@@ -104,7 +99,6 @@ public function setCustomerId($customerId);
10499
* Get public hash
105100
*
106101
* @return string
107-
* @since 2.1.0
108102
* @since 100.1.0
109103
*/
110104
public function getPublicHash();
@@ -114,7 +108,6 @@ public function getPublicHash();
114108
*
115109
* @param string $hash
116110
* @return $this
117-
* @since 2.1.0
118111
* @since 100.1.0
119112
*/
120113
public function setPublicHash($hash);
@@ -123,7 +116,6 @@ public function setPublicHash($hash);
123116
* Get payment method code
124117
*
125118
* @return string
126-
* @since 2.1.0
127119
* @since 100.1.0
128120
*/
129121
public function getPaymentMethodCode();
@@ -133,7 +125,6 @@ public function getPaymentMethodCode();
133125
*
134126
* @param string $code
135127
* @return $this
136-
* @since 2.1.0
137128
* @since 100.1.0
138129
*/
139130
public function setPaymentMethodCode($code);
@@ -142,7 +133,6 @@ public function setPaymentMethodCode($code);
142133
* Get type
143134
*
144135
* @return string
145-
* @since 2.1.0
146136
* @since 100.1.0
147137
*/
148138
public function getType();
@@ -152,7 +142,6 @@ public function getType();
152142
*
153143
* @param string $type
154144
* @return $this
155-
* @since 2.1.0
156145
* @since 100.1.0
157146
*/
158147
public function setType($type);
@@ -161,7 +150,6 @@ public function setType($type);
161150
* Get token creation timestamp
162151
*
163152
* @return string|null
164-
* @since 2.1.0
165153
* @since 100.1.0
166154
*/
167155
public function getCreatedAt();
@@ -171,7 +159,6 @@ public function getCreatedAt();
171159
*
172160
* @param string $timestamp
173161
* @return $this
174-
* @since 2.1.0
175162
* @since 100.1.0
176163
*/
177164
public function setCreatedAt($timestamp);
@@ -180,7 +167,6 @@ public function setCreatedAt($timestamp);
180167
* Get token expiration timestamp
181168
*
182169
* @return string|null
183-
* @since 2.1.0
184170
* @since 100.1.0
185171
*/
186172
public function getExpiresAt();
@@ -190,7 +176,6 @@ public function getExpiresAt();
190176
*
191177
* @param string $timestamp
192178
* @return $this
193-
* @since 2.1.0
194179
* @since 100.1.0
195180
*/
196181
public function setExpiresAt($timestamp);
@@ -199,7 +184,6 @@ public function setExpiresAt($timestamp);
199184
* Get gateway token ID
200185
*
201186
* @return string
202-
* @since 2.1.0
203187
* @since 100.1.0
204188
*/
205189
public function getGatewayToken();
@@ -209,7 +193,6 @@ public function getGatewayToken();
209193
*
210194
* @param string $token
211195
* @return $this
212-
* @since 2.1.0
213196
* @since 100.1.0
214197
*/
215198
public function setGatewayToken($token);
@@ -218,7 +201,6 @@ public function setGatewayToken($token);
218201
* Get token details
219202
*
220203
* @return string
221-
* @since 2.1.0
222204
* @since 100.1.0
223205
*/
224206
public function getTokenDetails();
@@ -228,7 +210,6 @@ public function getTokenDetails();
228210
*
229211
* @param string $details
230212
* @return $this
231-
* @since 2.1.0
232213
* @since 100.1.0
233214
*/
234215
public function setTokenDetails($details);
@@ -238,7 +219,6 @@ public function setTokenDetails($details);
238219
*
239220
* @return bool Is active.
240221
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
241-
* @since 2.1.0
242222
* @since 100.1.0
243223
*/
244224
public function getIsActive();
@@ -248,7 +228,6 @@ public function getIsActive();
248228
*
249229
* @param bool $isActive
250230
* @return $this
251-
* @since 2.1.0
252231
* @since 100.1.0
253232
*/
254233
public function setIsActive($isActive);
@@ -258,7 +237,6 @@ public function setIsActive($isActive);
258237
*
259238
* @return bool Is visible.
260239
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
261-
* @since 2.1.0
262240
* @since 100.1.0
263241
*/
264242
public function getIsVisible();
@@ -268,7 +246,6 @@ public function getIsVisible();
268246
*
269247
* @param bool $isVisible
270248
* @return $this
271-
* @since 2.1.0
272249
* @since 100.1.0
273250
*/
274251
public function setIsVisible($isVisible);

‎app/code/Magento/Vault/Api/Data/PaymentTokenInterfaceFactory.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,20 @@
88

99
/**
1010
* Interface PaymentTokenInterfaceFactory
11-
* @deprecated 2.2.0
11+
* @deprecated 100.3.0
1212
* @see PaymentTokenFactoryInterface
13-
* @since 2.1.3
1413
*/
1514
interface PaymentTokenInterfaceFactory
1615
{
1716
/**
1817
* Create payment token entity
1918
* @return PaymentTokenInterface
20-
* @since 2.1.3
2119
*/
2220
public function create();
2321

2422
/**
2523
* Return type of payment token
2624
* @return string
27-
* @since 2.1.3
2825
*/
2926
public function getType();
3027
}

‎app/code/Magento/Vault/Api/Data/PaymentTokenSearchResultsInterface.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
* Gateway vault payment token search result interface.
1010
*
1111
* @api
12-
* @since 2.1.0
1312
* @since 100.1.0
1413
*/
1514
interface PaymentTokenSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
@@ -18,7 +17,6 @@ interface PaymentTokenSearchResultsInterface extends \Magento\Framework\Api\Sear
1817
* Gets collection items.
1918
*
2019
* @return \Magento\Vault\Api\Data\PaymentTokenInterface[] Array of collection items.
21-
* @since 2.1.0
2220
* @since 100.1.0
2321
*/
2422
public function getItems();
@@ -28,7 +26,6 @@ public function getItems();
2826
*
2927
* @param \Magento\Vault\Api\Data\PaymentTokenInterface[] $items
3028
* @return $this
31-
* @since 2.1.0
3229
* @since 100.1.0
3330
*/
3431
public function setItems(array $items);

‎app/code/Magento/Vault/Api/PaymentMethodListInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@
1111
* Contains methods to retrieve vault payment methods
1212
* This interface is consistent with \Magento\Payment\Api\PaymentMethodListInterface
1313
* @api
14-
* @since 2.1.3
14+
* @since 100.2.0
1515
*/
1616
interface PaymentMethodListInterface
1717
{
1818
/**
1919
* Get list of available vault payments
2020
* @param int $storeId
2121
* @return VaultPaymentInterface[]
22-
* @since 2.1.3
22+
* @since 100.2.0
2323
*/
2424
public function getList($storeId);
2525

2626
/**
2727
* Get list of enabled in the configuration vault payments
2828
* @param int $storeId
2929
* @return VaultPaymentInterface[]
30-
* @since 2.1.3
30+
* @since 100.2.0
3131
*/
3232
public function getActiveList($storeId);
3333
}

‎app/code/Magento/Vault/Api/PaymentTokenManagementInterface.php

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
* Gateway vault payment token repository interface.
1313
*
1414
* @api
15-
* @since 2.1.0
1615
* @since 100.1.0
1716
*/
1817
interface PaymentTokenManagementInterface
@@ -22,7 +21,6 @@ interface PaymentTokenManagementInterface
2221
*
2322
* @param int $customerId Customer ID.
2423
* @return \Magento\Vault\Api\Data\PaymentTokenSearchResultsInterface Payment token search result interface.
25-
* @since 2.1.0
2624
* @since 100.1.0
2725
*/
2826
public function getListByCustomerId($customerId);
@@ -32,7 +30,6 @@ public function getListByCustomerId($customerId);
3230
*
3331
* @param int $paymentId The gateway payment token ID.
3432
* @return \Magento\Vault\Api\Data\PaymentTokenInterface Payment token interface.
35-
* @since 2.1.0
3633
* @since 100.1.0
3734
*/
3835
public function getByPaymentId($paymentId);
@@ -44,7 +41,6 @@ public function getByPaymentId($paymentId);
4441
* @param string $paymentMethodCode
4542
* @param int $customerId Customer ID.
4643
* @return PaymentTokenInterface|null Payment token interface.
47-
* @since 2.1.0
4844
* @since 100.1.0
4945
*/
5046
public function getByGatewayToken($token, $paymentMethodCode, $customerId);
@@ -55,7 +51,6 @@ public function getByGatewayToken($token, $paymentMethodCode, $customerId);
5551
* @param string $hash Public hash.
5652
* @param int $customerId Customer ID.
5753
* @return PaymentTokenInterface|null Payment token interface.
58-
* @since 2.1.0
5954
* @since 100.1.0
6055
*/
6156
public function getByPublicHash($hash, $customerId);
@@ -64,7 +59,6 @@ public function getByPublicHash($hash, $customerId);
6459
* @param PaymentTokenInterface $token
6560
* @param OrderPaymentInterface $payment
6661
* @return bool
67-
* @since 2.1.0
6862
* @since 100.1.0
6963
*/
7064
public function saveTokenWithPaymentLink(PaymentTokenInterface $token, OrderPaymentInterface $payment);
@@ -75,7 +69,6 @@ public function saveTokenWithPaymentLink(PaymentTokenInterface $token, OrderPaym
7569
* @param int $paymentTokenId Payment token ID.
7670
* @param int $orderPaymentId Order payment ID.
7771
* @return bool
78-
* @since 2.1.0
7972
* @since 100.1.0
8073
*/
8174
public function addLinkToOrderPayment($paymentTokenId, $orderPaymentId);

‎app/code/Magento/Vault/Api/PaymentTokenRepositoryInterface.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
* Gateway vault payment token repository interface.
1010
*
1111
* @api
12-
* @since 2.1.0
1312
* @since 100.1.0
1413
*/
1514
interface PaymentTokenRepositoryInterface
@@ -19,7 +18,6 @@ interface PaymentTokenRepositoryInterface
1918
*
2019
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
2120
* @return \Magento\Vault\Api\Data\PaymentTokenSearchResultsInterface Payment token search result interface.
22-
* @since 2.1.0
2321
* @since 100.1.0
2422
*/
2523
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
@@ -29,7 +27,6 @@ public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCr
2927
*
3028
* @param int $entityId The payment token entity ID.
3129
* @return \Magento\Vault\Api\Data\PaymentTokenInterface Payment token interface.
32-
* @since 2.1.0
3330
* @since 100.1.0
3431
*/
3532
public function getById($entityId);
@@ -39,7 +36,6 @@ public function getById($entityId);
3936
*
4037
* @param \Magento\Vault\Api\Data\PaymentTokenInterface $paymentToken The invoice.
4138
* @return bool
42-
* @since 2.1.0
4339
* @since 100.1.0
4440
*/
4541
public function delete(Data\PaymentTokenInterface $paymentToken);
@@ -49,7 +45,6 @@ public function delete(Data\PaymentTokenInterface $paymentToken);
4945
*
5046
* @param \Magento\Vault\Api\Data\PaymentTokenInterface $paymentToken The payment token.
5147
* @return \Magento\Vault\Api\Data\PaymentTokenInterface Payment token interface.
52-
* @since 2.1.0
5348
* @since 100.1.0
5449
*/
5550
public function save(Data\PaymentTokenInterface $paymentToken);

0 commit comments

Comments
 (0)