Fix variable references in phpdoc (#19006)

This commit is contained in:
Alexey Rogachev
2021-11-10 16:26:55 +06:00
committed by GitHub
parent 53477e8ad9
commit fa6f0ef658
13 changed files with 37 additions and 36 deletions

View File

@@ -252,7 +252,7 @@ class DynamicModel extends Model
* Sets the attribute labels in a massive way. * Sets the attribute labels in a massive way.
* *
* @see attributeLabels() * @see attributeLabels()
* @see $_attributeLabels * @see _attributeLabels
* @since 2.0.35 * @since 2.0.35
* *
* @param array $labels Array of attribute labels * @param array $labels Array of attribute labels
@@ -269,7 +269,7 @@ class DynamicModel extends Model
* Sets a label for an attribute. * Sets a label for an attribute.
* *
* @see attributeLabels() * @see attributeLabels()
* @see $_attributeLabels * @see _attributeLabels
* @since 2.0.35 * @since 2.0.35
* *
* @param string $attribute Attribute name * @param string $attribute Attribute name

View File

@@ -54,7 +54,7 @@ abstract class BaseMigrateController extends Controller
* as the migration name contains the origin of the migration in the history, which is not the case when * as the migration name contains the origin of the migration in the history, which is not the case when
* using multiple migration paths. * using multiple migration paths.
* *
* @see $migrationNamespaces * @see migrationNamespaces
*/ */
public $migrationPath = ['@app/migrations']; public $migrationPath = ['@app/migrations'];
/** /**
@@ -75,7 +75,7 @@ abstract class BaseMigrateController extends Controller
* ``` * ```
* *
* @since 2.0.10 * @since 2.0.10
* @see $migrationPath * @see migrationPath
*/ */
public $migrationNamespaces = []; public $migrationNamespaces = [];
/** /**

View File

@@ -305,8 +305,8 @@ class Sort extends BaseObject
* @param string $param the value of the [[sortParam]]. * @param string $param the value of the [[sortParam]].
* @return array the valid sort attributes. * @return array the valid sort attributes.
* @since 2.0.12 * @since 2.0.12
* @see $separator for the attribute name separator. * @see separator for the attribute name separator.
* @see $sortParam * @see sortParam
*/ */
protected function parseSortParam($param) protected function parseSortParam($param)
{ {

View File

@@ -159,7 +159,7 @@ class QueryBuilder extends \yii\base\BaseObject
* default expression builders for this query builder. See [[expressionBuilders]] docs for details. * default expression builders for this query builder. See [[expressionBuilders]] docs for details.
* *
* @return array * @return array
* @see $expressionBuilders * @see expressionBuilders
* @since 2.0.14 * @since 2.0.14
*/ */
protected function defaultExpressionBuilders() protected function defaultExpressionBuilders()

View File

@@ -62,8 +62,8 @@ class AccessRule extends Component
* Note that it is preferred to check for permissions instead. * Note that it is preferred to check for permissions instead.
* *
* If this property is not set or empty, it means this rule applies regardless of roles. * If this property is not set or empty, it means this rule applies regardless of roles.
* @see $permissions * @see permissions
* @see $roleParams * @see roleParams
*/ */
public $roles; public $roles;
/** /**
@@ -72,8 +72,8 @@ class AccessRule extends Component
* *
* If this property is not set or empty, it means this rule applies regardless of permissions. * If this property is not set or empty, it means this rule applies regardless of permissions.
* @since 2.0.12 * @since 2.0.12
* @see $roles * @see roles
* @see $roleParams * @see roleParams
*/ */
public $permissions; public $permissions;
/** /**
@@ -106,7 +106,7 @@ class AccessRule extends Component
* *
* A reference to the [[AccessRule]] instance will be passed to the closure as the first parameter. * A reference to the [[AccessRule]] instance will be passed to the closure as the first parameter.
* *
* @see $roles * @see roles
* @since 2.0.12 * @since 2.0.12
*/ */
public $roleParams = []; public $roleParams = [];

View File

@@ -9,8 +9,9 @@ namespace yii\helpers;
use yii\base\Arrayable; use yii\base\Arrayable;
use yii\base\InvalidArgumentException; use yii\base\InvalidArgumentException;
use yii\web\JsExpression;
use yii\base\Model; use yii\base\Model;
use yii\web\JsExpression;
use yii\web\JsonResponseFormatter;
/** /**
* BaseJson provides concrete implementation for [[Json]]. * BaseJson provides concrete implementation for [[Json]].

View File

@@ -45,7 +45,7 @@ class BaseMarkdown
/** /**
* @var string the markdown flavor to use when none is specified explicitly. * @var string the markdown flavor to use when none is specified explicitly.
* Defaults to `original`. * Defaults to `original`.
* @see $flavors * @see flavors
*/ */
public static $defaultFlavor = 'original'; public static $defaultFlavor = 'original';

View File

@@ -40,7 +40,7 @@ class AssetBundle extends BaseObject
* If you do not set this property, it means the source asset files are located under [[basePath]]. * If you do not set this property, it means the source asset files are located under [[basePath]].
* *
* You can use either a directory or an alias of the directory. * You can use either a directory or an alias of the directory.
* @see $publishOptions * @see publishOptions
*/ */
public $sourcePath; public $sourcePath;
/** /**

View File

@@ -132,7 +132,7 @@ abstract class CompositeUrlRule extends BaseObject implements UrlRuleInterface
* *
* @return null|int Status of the URL creation after the last [[createUrl()]] call. `null` if rule does not provide * @return null|int Status of the URL creation after the last [[createUrl()]] call. `null` if rule does not provide
* info about create status. * info about create status.
* @see $createStatus * @see createStatus
* @see https://www.php.net/manual/en/language.operators.bitwise.php * @see https://www.php.net/manual/en/language.operators.bitwise.php
* @since 2.0.12 * @since 2.0.12
*/ */

View File

@@ -22,7 +22,7 @@ class Cookie extends \yii\base\BaseObject
* during CSRF-prone request methods (e.g. POST, PUT, PATCH etc). * during CSRF-prone request methods (e.g. POST, PUT, PATCH etc).
* E.g. a POST request from https://otherdomain.com to https://yourdomain.com will not include the cookie, however a GET request will. * E.g. a POST request from https://otherdomain.com to https://yourdomain.com will not include the cookie, however a GET request will.
* When a user follows a link from https://otherdomain.com to https://yourdomain.com it will include the cookie * When a user follows a link from https://otherdomain.com to https://yourdomain.com it will include the cookie
* @see $sameSite * @see sameSite
*/ */
const SAME_SITE_LAX = 'Lax'; const SAME_SITE_LAX = 'Lax';
/** /**
@@ -30,7 +30,7 @@ class Cookie extends \yii\base\BaseObject
* regardless of the request method and even when following a regular link. * regardless of the request method and even when following a regular link.
* E.g. a GET request from https://otherdomain.com to https://yourdomain.com or a user following a link from * E.g. a GET request from https://otherdomain.com to https://yourdomain.com or a user following a link from
* https://otherdomain.com to https://yourdomain.com will not include the cookie. * https://otherdomain.com to https://yourdomain.com will not include the cookie.
* @see $sameSite * @see sameSite
*/ */
const SAME_SITE_STRICT = 'Strict'; const SAME_SITE_STRICT = 'Strict';
/** /**
@@ -38,8 +38,8 @@ class Cookie extends \yii\base\BaseObject
* i.e in responses to both first-party and cross-origin requests. * i.e in responses to both first-party and cross-origin requests.
* E.g. a POST request from https://otherdomain.com to https://yourdomain.com will include the cookie. * E.g. a POST request from https://otherdomain.com to https://yourdomain.com will include the cookie.
* Note: If `sameSite` is set to None, the `secure` attribute must be set to `true` (otherwise the cookie will be blocked by the browser). * Note: If `sameSite` is set to None, the `secure` attribute must be set to `true` (otherwise the cookie will be blocked by the browser).
* @see $sameSite * @see sameSite
* @see $secure * @see secure
* @since 2.0.43 * @since 2.0.43
*/ */
const SAME_SITE_NONE = 'None'; const SAME_SITE_NONE = 'None';

View File

@@ -208,7 +208,7 @@ class Request extends \yii\base\Request
* See [[IpValidator::::setRanges()|IpValidator::setRanges()]] * See [[IpValidator::::setRanges()|IpValidator::setRanges()]]
* and [[IpValidator::networks]] for advanced matching. * and [[IpValidator::networks]] for advanced matching.
* *
* @see $secureHeaders * @see secureHeaders
* @since 2.0.13 * @since 2.0.13
*/ */
public $trustedHosts = []; public $trustedHosts = [];
@@ -219,7 +219,7 @@ class Request extends \yii\base\Request
* The match of header names is case-insensitive. * The match of header names is case-insensitive.
* @see https://en.wikipedia.org/wiki/List_of_HTTP_header_fields * @see https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
* @see https://datatracker.ietf.org/doc/html/rfc7239 * @see https://datatracker.ietf.org/doc/html/rfc7239
* @see $trustedHosts * @see trustedHosts
* @since 2.0.13 * @since 2.0.13
*/ */
public $secureHeaders = [ public $secureHeaders = [
@@ -240,8 +240,8 @@ class Request extends \yii\base\Request
* It's not advisable to put insecure headers here. * It's not advisable to put insecure headers here.
* To use the `Forwarded` header according to RFC 7239, the header must be added to [[secureHeaders]] list. * To use the `Forwarded` header according to RFC 7239, the header must be added to [[secureHeaders]] list.
* The match of header names is case-insensitive. * The match of header names is case-insensitive.
* @see $trustedHosts * @see trustedHosts
* @see $secureHeaders * @see secureHeaders
* @since 2.0.13 * @since 2.0.13
*/ */
public $ipHeaders = [ public $ipHeaders = [
@@ -252,8 +252,8 @@ class Request extends \yii\base\Request
* The array keys are header names and the array value is a list of header values that indicate a secure connection. * The array keys are header names and the array value is a list of header values that indicate a secure connection.
* The match of header names and values is case-insensitive. * The match of header names and values is case-insensitive.
* It's not advisable to put insecure headers here. * It's not advisable to put insecure headers here.
* @see $trustedHosts * @see trustedHosts
* @see $secureHeaders * @see secureHeaders
* @since 2.0.13 * @since 2.0.13
*/ */
public $secureProtocolHeaders = [ public $secureProtocolHeaders = [
@@ -1171,7 +1171,7 @@ class Request extends \yii\base\Request
/** /**
* Returns the user IP address from [[ipHeaders]]. * Returns the user IP address from [[ipHeaders]].
* @return string|null user IP address, null if not available * @return string|null user IP address, null if not available
* @see $ipHeaders * @see ipHeaders
* @since 2.0.28 * @since 2.0.28
*/ */
protected function getUserIpFromIpHeaders() protected function getUserIpFromIpHeaders()
@@ -1216,9 +1216,9 @@ class Request extends \yii\base\Request
* *
* @param string $ips comma separated IP list * @param string $ips comma separated IP list
* @return string|null IP as string. Null is returned if IP can not be determined from header. * @return string|null IP as string. Null is returned if IP can not be determined from header.
* @see $getUserHost * @see getUserHost
* @see $ipHeader * @see ipHeader
* @see $trustedHeaders * @see trustedHeaders
* @since 2.0.28 * @since 2.0.28
*/ */
protected function getUserIpFromIpHeader($ips) protected function getUserIpFromIpHeader($ips)

View File

@@ -42,27 +42,27 @@ class UrlRule extends BaseObject implements UrlRuleInterface
const CREATION_ONLY = 2; const CREATION_ONLY = 2;
/** /**
* Represents the successful URL generation by last [[createUrl()]] call. * Represents the successful URL generation by last [[createUrl()]] call.
* @see $createStatus * @see createStatus
* @since 2.0.12 * @since 2.0.12
*/ */
const CREATE_STATUS_SUCCESS = 0; const CREATE_STATUS_SUCCESS = 0;
/** /**
* Represents the unsuccessful URL generation by last [[createUrl()]] call, because rule does not support * Represents the unsuccessful URL generation by last [[createUrl()]] call, because rule does not support
* creating URLs. * creating URLs.
* @see $createStatus * @see createStatus
* @since 2.0.12 * @since 2.0.12
*/ */
const CREATE_STATUS_PARSING_ONLY = 1; const CREATE_STATUS_PARSING_ONLY = 1;
/** /**
* Represents the unsuccessful URL generation by last [[createUrl()]] call, because of mismatched route. * Represents the unsuccessful URL generation by last [[createUrl()]] call, because of mismatched route.
* @see $createStatus * @see createStatus
* @since 2.0.12 * @since 2.0.12
*/ */
const CREATE_STATUS_ROUTE_MISMATCH = 2; const CREATE_STATUS_ROUTE_MISMATCH = 2;
/** /**
* Represents the unsuccessful URL generation by last [[createUrl()]] call, because of mismatched * Represents the unsuccessful URL generation by last [[createUrl()]] call, because of mismatched
* or missing parameters. * or missing parameters.
* @see $createStatus * @see createStatus
* @since 2.0.12 * @since 2.0.12
*/ */
const CREATE_STATUS_PARAMS_MISMATCH = 4; const CREATE_STATUS_PARAMS_MISMATCH = 4;
@@ -543,7 +543,7 @@ class UrlRule extends BaseObject implements UrlRuleInterface
* *
* @return null|int Status of the URL creation after the last [[createUrl()]] call. `null` if rule does not provide * @return null|int Status of the URL creation after the last [[createUrl()]] call. `null` if rule does not provide
* info about create status. * info about create status.
* @see $createStatus * @see createStatus
* @since 2.0.12 * @since 2.0.12
*/ */
public function getCreateUrlStatus() public function getCreateUrlStatus()

View File

@@ -306,7 +306,7 @@ class ActiveField extends Component
* See also [[\yii\helpers\Html::tag()]]. * See also [[\yii\helpers\Html::tag()]].
* *
* If you set a custom `id` for the error element, you may need to adjust the [[$selectors]] accordingly. * If you set a custom `id` for the error element, you may need to adjust the [[$selectors]] accordingly.
* @see $errorOptions * @see errorOptions
* @return $this the field object itself. * @return $this the field object itself.
*/ */
public function error($options = []) public function error($options = [])