Skip to content

Commit 6bcb185

Browse files
committed
MAGETWO-67205: Add @api Annotation in Stdlib framework library
1 parent 971d3bb commit 6bcb185

File tree

9 files changed

+22
-15
lines changed

9 files changed

+22
-15
lines changed

lib/internal/Magento/Framework/Stdlib/Cookie/CookieSizeLimitReachedException.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
*
1414
* Limits can include the amount of data stored in an individual cookie as well as the number of cookies
1515
* set for the domain.
16+
*
17+
* @api
1618
*/
1719
class CookieSizeLimitReachedException extends LocalizedException
1820
{

lib/internal/Magento/Framework/Stdlib/Cookie/FailureToSendException.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
/**
1111
* FailureToSendException is thrown when trying to set a cookie but the response has already been sent, making it
1212
* impossible to send any cookie information back to the client.
13+
*
14+
* @api
1315
*/
1416
class FailureToSendException extends LocalizedException
1517
{

lib/internal/Magento/Framework/Stdlib/Cookie/PublicCookieMetadata.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
/**
1010
* Class PublicCookieMetadata
1111
*
12+
* @api
1213
*/
1314
class PublicCookieMetadata extends CookieMetadata
1415
{
@@ -41,7 +42,6 @@ public function setDurationOneYear()
4142
* The cookie duration can be translated into an expiration date at the time the cookie is sent.
4243
*
4344
* @return int|null Time in seconds.
44-
* @api
4545
*/
4646
public function getDuration()
4747
{
@@ -53,7 +53,6 @@ public function getDuration()
5353
*
5454
* @param bool $httpOnly
5555
* @return $this
56-
* @api
5756
*/
5857
public function setHttpOnly($httpOnly)
5958
{
@@ -65,7 +64,6 @@ public function setHttpOnly($httpOnly)
6564
*
6665
* @param bool $secure
6766
* @return $this
68-
* @api
6967
*/
7068
public function setSecure($secure)
7169
{

lib/internal/Magento/Framework/Stdlib/Cookie/SensitiveCookieMetadata.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
*
1414
* The class has only methods extended from CookieMetadata
1515
* as path and domain are only data to be exposed by SensitiveCookieMetadata
16+
*
17+
* @api
1618
*/
1719
class SensitiveCookieMetadata extends CookieMetadata
1820
{

lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
/**
1010
* Date conversion model
1111
*
12-
* @author Magento Core Team <core@magentocommerce.com>
12+
* @api
1313
*/
1414
class DateTime
1515
{
@@ -39,7 +39,6 @@ public function __construct(TimezoneInterface $localeDate)
3939
*
4040
* @param string|null $timezone
4141
* @return int offset between timezone and gmt
42-
* @api
4342
*/
4443
public function calculateOffset($timezone = null)
4544
{
@@ -85,7 +84,6 @@ public function gmtDate($format = null, $input = null)
8584
* @param string $format
8685
* @param int|string $input date in GMT timezone
8786
* @return string
88-
* @api
8987
*/
9088
public function date($format = null, $input = null)
9189
{
@@ -148,7 +146,6 @@ public function timestamp($input = null)
148146
*
149147
* @param string $type
150148
* @return int
151-
* @api
152149
*/
153150
public function getGmtOffset($type = 'seconds')
154151
{

lib/internal/Magento/Framework/Stdlib/DateTime/Filter/Date.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
<?php
22
/**
3-
* Date filter. Converts date from localized to internal format.
4-
*
53
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
64
* See COPYING.txt for license details.
75
*/
86
namespace Magento\Framework\Stdlib\DateTime\Filter;
97

108
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
11-
use Magento\Framework\Phrase;
129

10+
/**
11+
* Date filter. Converts date from localized to internal format.
12+
*
13+
* @api
14+
*/
1315
class Date implements \Zend_Filter_Interface
1416
{
1517
/**

lib/internal/Magento/Framework/Stdlib/DateTime/Filter/DateTime.php

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
<?php
22
/**
3-
* Date/Time filter. Converts datetime from localized to internal format.
4-
*
53
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
64
* See COPYING.txt for license details.
75
*/
86
namespace Magento\Framework\Stdlib\DateTime\Filter;
97

10-
use Magento\Framework\Phrase;
11-
8+
/**
9+
* Date/Time filter. Converts datetime from localized to internal format.
10+
*
11+
* @api
12+
*/
1213
class DateTime extends Date
1314
{
1415
/**

lib/internal/Magento/Framework/Stdlib/DateTime/Timezone/Validator.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
use Magento\Framework\Exception\ValidatorException;
99
use Magento\Framework\Phrase;
1010

11+
/**
12+
* @api
13+
*/
1114
class Validator
1215
{
1316
/**
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The Stdlib library contains utility classes that extend or relate to base PHP classes. Modules should use the CookieManager to get and set cookies instead of the built-in cookie functions for improved security.
2-
Other classes provide convenience methods for dealing with arrays, boolean, date/time, and strings.
2+
Other classes provide convenient methods for dealing with arrays, boolean, date/time, and strings.

0 commit comments

Comments
 (0)