Browse Source

improve `@deprecated` annotations

tags/2.0.14
Carsten Brandt 7 years ago
parent
commit
e493843b1c
No known key found for this signature in database
GPG Key ID: BE4F41DE1DEEEED0
  1. 4
      framework/BaseYii.php
  2. 2
      framework/base/BaseObject.php
  3. 2
      framework/base/InvalidParamException.php
  4. 2
      framework/base/View.php
  5. 2
      framework/caching/XCache.php
  6. 2
      framework/caching/ZendDataCache.php
  7. 2
      framework/db/Connection.php
  8. 2
      framework/db/QueryBuilder.php
  9. 2
      framework/web/Request.php

4
framework/BaseYii.php

@ -401,7 +401,7 @@ class BaseYii
* @param string|array $message the message to be logged. This can be a simple string or a more
* complex data structure, such as array.
* @param string $category the category of the message.
* @deprecated 2.0.14 Use [[debug()]]
* @deprecated since 2.0.14. Use [[debug()]] instead.
*/
public static function trace($message, $category = 'application')
{
@ -485,7 +485,7 @@ class BaseYii
/**
* Returns an HTML hyperlink that can be displayed on your Web page showing "Powered by Yii Framework" information.
* @return string an HTML hyperlink that can be displayed on your Web page showing "Powered by Yii Framework" information
* @deprecated 2.0.14
* @deprecated since 2.0.14, this method will be removed in 2.1.0.
*/
public static function powered()
{

2
framework/base/BaseObject.php

@ -79,7 +79,7 @@ class BaseObject implements Configurable
/**
* Returns the fully qualified name of this class.
* @return string the fully qualified name of this class.
* @deprecated 2.0.14 Use `::class`.
* @deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.
*/
public static function className()
{

2
framework/base/InvalidParamException.php

@ -12,7 +12,7 @@ namespace yii\base;
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @deprecated 2.0.14 Use [[InvalidArgumentException]]
* @deprecated since 2.0.14. Use [[InvalidArgumentException]] instead.
*/
class InvalidParamException extends \BadMethodCallException
{

2
framework/base/View.php

@ -89,7 +89,7 @@ class View extends Component implements DynamicContentAwareInterface
* @var array|DynamicContentAwareInterface[] a list of currently active dynamic content class instances.
* This property is used internally to implement the dynamic content caching feature. Do not modify it directly.
* @internal
* @deprecated Sice 2.0.14. Do not use this property directly. Use methods [[getDynamicContents()]],
* @deprecated Since 2.0.14. Do not use this property directly. Use methods [[getDynamicContents()]],
* [[pushDynamicContent()]], [[popDynamicContent()]] instead.
*/
public $cacheStack = [];

2
framework/caching/XCache.php

@ -20,7 +20,7 @@ namespace yii\caching;
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @deprecated 2.0.14
* @deprecated since 2.0.14. This class will be removed in 2.1.0.
*/
class XCache extends Cache
{

2
framework/caching/ZendDataCache.php

@ -19,7 +19,7 @@ namespace yii\caching;
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @deprecated 2.0.14
* @deprecated since 2.0.14. This class will be removed in 2.1.0.
*/
class ZendDataCache extends Cache
{

2
framework/db/Connection.php

@ -295,7 +295,7 @@ class Connection extends Component
* Since version 2.0.14 [[$commandMap]] is used if this property is set to its default value.
* @see createCommand
* @since 2.0.7
* @deprecated 2.0.14 Use [[$commandMap]] for precise configuration.
* @deprecated since 2.0.14. Use [[$commandMap]] for precise configuration.
*/
public $commandClass = 'yii\db\Command';
/**

2
framework/db/QueryBuilder.php

@ -51,7 +51,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* @var array map of query condition to builder methods.
* These methods are used by [[buildCondition]] to build SQL conditions from array syntax.
* @deprecated since 2.0.14. Is not used, will be dropped in 2.1.0
* @deprecated since 2.0.14. Is not used, will be dropped in 2.1.0.
*/
protected $conditionBuilders = [];

2
framework/web/Request.php

@ -100,7 +100,7 @@ class Request extends \yii\base\Request
const CSRF_HEADER = 'X-CSRF-Token';
/**
* The length of the CSRF token mask.
* @deprecated 2.0.12 The mask length is now equal to the token length.
* @deprecated since 2.0.12. The mask length is now equal to the token length.
*/
const CSRF_MASK_LENGTH = 8;

Loading…
Cancel
Save