diff --git a/framework/base/ArrayAccessTrait.php b/framework/base/ArrayAccessTrait.php index df1ab603fd..43a229ab8b 100644 --- a/framework/base/ArrayAccessTrait.php +++ b/framework/base/ArrayAccessTrait.php @@ -22,7 +22,7 @@ trait ArrayAccessTrait { /** * Returns an iterator for traversing the data. - * This method is required by the SPL interface `IteratorAggregate`. + * This method is required by the SPL interface [[\IteratorAggregate]]. * It will be implicitly called when you use `foreach` to traverse the collection. * @return \ArrayIterator an iterator for traversing the cookies in the collection. */ @@ -42,7 +42,7 @@ trait ArrayAccessTrait } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param mixed $offset the offset to check on * @return boolean */ @@ -52,7 +52,7 @@ trait ArrayAccessTrait } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param integer $offset the offset to retrieve element. * @return mixed the element at the offset, null if no element is found at the offset */ @@ -62,7 +62,7 @@ trait ArrayAccessTrait } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param integer $offset the offset to set element * @param mixed $item the element value */ @@ -72,7 +72,7 @@ trait ArrayAccessTrait } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param mixed $offset the offset to unset element */ public function offsetUnset($offset) diff --git a/framework/base/Model.php b/framework/base/Model.php index 7c1f06f350..bfeb649123 100644 --- a/framework/base/Model.php +++ b/framework/base/Model.php @@ -925,7 +925,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab /** * Returns an iterator for traversing the attributes in the model. - * This method is required by the interface IteratorAggregate. + * This method is required by the interface [[\IteratorAggregate]]. * @return ArrayIterator an iterator for traversing the items in the list. */ public function getIterator() @@ -936,7 +936,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab /** * Returns whether there is an element at the specified offset. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `isset($model[$offset])`. * @param mixed $offset the offset to check on * @return boolean @@ -948,7 +948,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab /** * Returns the element at the specified offset. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$value = $model[$offset];`. * @param mixed $offset the offset to retrieve element. * @return mixed the element at the offset, null if no element is found at the offset @@ -960,7 +960,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab /** * Sets the element at the specified offset. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$model[$offset] = $item;`. * @param integer $offset the offset to set element * @param mixed $item the element value @@ -972,7 +972,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab /** * Sets the element value at the specified offset to null. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `unset($model[$offset])`. * @param mixed $offset the offset to unset element */ diff --git a/framework/caching/Cache.php b/framework/caching/Cache.php index dce5ccc9ff..68e11e8612 100644 --- a/framework/caching/Cache.php +++ b/framework/caching/Cache.php @@ -30,7 +30,7 @@ use yii\helpers\StringHelper; * } * ``` * - * Because Cache implements the ArrayAccess interface, it can be used like an array. For example, + * Because Cache implements the [[\ArrayAccess]] interface, it can be used like an array. For example, * * ```php * $cache['foo'] = 'some data'; @@ -423,7 +423,7 @@ abstract class Cache extends Component implements \ArrayAccess /** * Returns whether there is a cache entry with a specified key. - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param string $key a key identifying the cached value * @return boolean */ @@ -434,7 +434,7 @@ abstract class Cache extends Component implements \ArrayAccess /** * Retrieves the value from cache with a specified key. - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param string $key a key identifying the cached value * @return mixed the value stored in cache, false if the value is not in the cache or expired. */ @@ -447,7 +447,7 @@ abstract class Cache extends Component implements \ArrayAccess * Stores the value identified by a key into cache. * If the cache already contains such a key, the existing value will be * replaced with the new ones. To add expiration and dependencies, use the [[set()]] method. - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param string $key the key identifying the value to be cached * @param mixed $value the value to be cached */ @@ -458,7 +458,7 @@ abstract class Cache extends Component implements \ArrayAccess /** * Deletes the value with the specified key from cache - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param string $key the key of the value to be deleted */ public function offsetUnset($key) diff --git a/framework/db/BaseActiveRecord.php b/framework/db/BaseActiveRecord.php index fa90537ee1..2008d661e9 100644 --- a/framework/db/BaseActiveRecord.php +++ b/framework/db/BaseActiveRecord.php @@ -1092,7 +1092,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface /** * Returns whether there is an element at the specified offset. - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param mixed $offset the offset to check on * @return boolean whether there is an element at the specified offset. */ @@ -1160,11 +1160,11 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface * * Note that this method requires that the primary key value is not null. * - * @param string $name the case sensitive name of the relationship + * @param string $name the case sensitive name of the relationship. * @param ActiveRecordInterface $model the model to be linked with the current one. * @param array $extraColumns additional column values to be saved into the junction table. * This parameter is only meaningful for a relationship involving a junction table - * (i.e., a relation set with [[ActiveRelationTrait::via()]] or `[[ActiveQuery::viaTable()]]`.) + * (i.e., a relation set with [[ActiveRelationTrait::via()]] or [[ActiveQuery::viaTable()]].) * @throws InvalidCallException if the method is unable to link two models. */ public function link($name, $model, $extraColumns = []) @@ -1557,7 +1557,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface /** * Sets the element value at the specified offset to null. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `unset($model[$offset])`. * @param mixed $offset the offset to unset element */ diff --git a/framework/db/BatchQueryResult.php b/framework/db/BatchQueryResult.php index f1583839c7..e2f679f954 100644 --- a/framework/db/BatchQueryResult.php +++ b/framework/db/BatchQueryResult.php @@ -13,7 +13,7 @@ use yii\base\Object; * BatchQueryResult represents a batch query from which you can retrieve data in batches. * * You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by - * calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the `Iterator` interface, + * calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the [[\Iterator]] interface, * you can iterate it to obtain a batch of data in each iteration. For example, * * ```php @@ -94,7 +94,7 @@ class BatchQueryResult extends Object implements \Iterator /** * Resets the iterator to the initial state. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. */ public function rewind() { @@ -104,7 +104,7 @@ class BatchQueryResult extends Object implements \Iterator /** * Moves the internal pointer to the next dataset. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. */ public function next() { @@ -149,7 +149,7 @@ class BatchQueryResult extends Object implements \Iterator /** * Returns the index of the current dataset. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return integer the index of the current row. */ public function key() @@ -159,7 +159,7 @@ class BatchQueryResult extends Object implements \Iterator /** * Returns the current dataset. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return mixed the current dataset. */ public function current() @@ -169,7 +169,7 @@ class BatchQueryResult extends Object implements \Iterator /** * Returns whether there is a valid dataset at the current position. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return boolean whether there is a valid dataset at the current position. */ public function valid() diff --git a/framework/db/DataReader.php b/framework/db/DataReader.php index ebe835183e..2630790c8e 100644 --- a/framework/db/DataReader.php +++ b/framework/db/DataReader.php @@ -212,7 +212,7 @@ class DataReader extends \yii\base\Object implements \Iterator, \Countable /** * Resets the iterator to the initial state. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @throws InvalidCallException if this method is invoked twice */ public function rewind() @@ -227,7 +227,7 @@ class DataReader extends \yii\base\Object implements \Iterator, \Countable /** * Returns the index of the current row. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return integer the index of the current row. */ public function key() @@ -237,7 +237,7 @@ class DataReader extends \yii\base\Object implements \Iterator, \Countable /** * Returns the current row. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return mixed the current row. */ public function current() @@ -247,7 +247,7 @@ class DataReader extends \yii\base\Object implements \Iterator, \Countable /** * Moves the internal pointer to the next row. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. */ public function next() { @@ -257,7 +257,7 @@ class DataReader extends \yii\base\Object implements \Iterator, \Countable /** * Returns whether there is a row of data at current position. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return boolean whether there is a row of data at current position. */ public function valid() diff --git a/framework/db/Query.php b/framework/db/Query.php index 544982830e..a5a935c9f3 100644 --- a/framework/db/Query.php +++ b/framework/db/Query.php @@ -140,7 +140,7 @@ class Query extends Component implements QueryInterface * Starts a batch query. * * A batch query supports fetching data in batches, which can keep the memory usage under a limit. - * This method will return a [[BatchQueryResult]] object which implements the `Iterator` interface + * This method will return a [[BatchQueryResult]] object which implements the [[\Iterator]] interface * and can be traversed to retrieve the data in batches. * * For example, @@ -154,7 +154,7 @@ class Query extends Component implements QueryInterface * * @param integer $batchSize the number of records to be fetched in each batch. * @param Connection $db the database connection. If not set, the "db" application component will be used. - * @return BatchQueryResult the batch query result. It implements the `Iterator` interface + * @return BatchQueryResult the batch query result. It implements the [[\Iterator]] interface * and can be traversed to retrieve the data in batches. */ public function batch($batchSize = 100, $db = null) @@ -181,7 +181,7 @@ class Query extends Component implements QueryInterface * * @param integer $batchSize the number of records to be fetched in each batch. * @param Connection $db the database connection. If not set, the "db" application component will be used. - * @return BatchQueryResult the batch query result. It implements the `Iterator` interface + * @return BatchQueryResult the batch query result. It implements the [[\Iterator]] interface * and can be traversed to retrieve the data in batches. */ public function each($batchSize = 100, $db = null) diff --git a/framework/web/CookieCollection.php b/framework/web/CookieCollection.php index 09d51d3327..fe9eeb7785 100644 --- a/framework/web/CookieCollection.php +++ b/framework/web/CookieCollection.php @@ -49,7 +49,7 @@ class CookieCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns an iterator for traversing the cookies in the collection. - * This method is required by the SPL interface `IteratorAggregate`. + * This method is required by the SPL interface [[\IteratorAggregate]]. * It will be implicitly called when you use `foreach` to traverse the collection. * @return ArrayIterator an iterator for traversing the cookies in the collection. */ @@ -191,7 +191,7 @@ class CookieCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns whether there is a cookie with the specified name. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `isset($collection[$name])`. * @param string $name the cookie name * @return boolean whether the named cookie exists @@ -203,7 +203,7 @@ class CookieCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns the cookie with the specified name. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$cookie = $collection[$name];`. * This is equivalent to [[get()]]. * @param string $name the cookie name @@ -216,7 +216,7 @@ class CookieCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Adds the cookie to the collection. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$collection[$name] = $cookie;`. * This is equivalent to [[add()]]. * @param string $name the cookie name @@ -229,7 +229,7 @@ class CookieCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Removes the named cookie. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `unset($collection[$name])`. * This is equivalent to [[remove()]]. * @param string $name the cookie name diff --git a/framework/web/HeaderCollection.php b/framework/web/HeaderCollection.php index fe3073b582..0cdf8d6752 100644 --- a/framework/web/HeaderCollection.php +++ b/framework/web/HeaderCollection.php @@ -31,7 +31,7 @@ class HeaderCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns an iterator for traversing the headers in the collection. - * This method is required by the SPL interface `IteratorAggregate`. + * This method is required by the SPL interface [[\IteratorAggregate]]. * It will be implicitly called when you use `foreach` to traverse the collection. * @return ArrayIterator an iterator for traversing the headers in the collection. */ @@ -186,7 +186,7 @@ class HeaderCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns whether there is a header with the specified name. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `isset($collection[$name])`. * @param string $name the header name * @return boolean whether the named header exists @@ -198,7 +198,7 @@ class HeaderCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Returns the header with the specified name. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$header = $collection[$name];`. * This is equivalent to [[get()]]. * @param string $name the header name @@ -211,7 +211,7 @@ class HeaderCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Adds the header to the collection. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `$collection[$name] = $header;`. * This is equivalent to [[add()]]. * @param string $name the header name @@ -224,7 +224,7 @@ class HeaderCollection extends Object implements \IteratorAggregate, \ArrayAcces /** * Removes the named header. - * This method is required by the SPL interface `ArrayAccess`. + * This method is required by the SPL interface [[\ArrayAccess]]. * It is implicitly called when you use something like `unset($collection[$name])`. * This is equivalent to [[remove()]]. * @param string $name the header name diff --git a/framework/web/Session.php b/framework/web/Session.php index 167a69cb16..f175119d80 100644 --- a/framework/web/Session.php +++ b/framework/web/Session.php @@ -517,7 +517,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co /** * Returns an iterator for traversing the session variables. - * This method is required by the interface IteratorAggregate. + * This method is required by the interface [[\IteratorAggregate]]. * @return SessionIterator an iterator for traversing the session variables. */ public function getIterator() @@ -538,7 +538,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co /** * Returns the number of items in the session. - * This method is required by Countable interface. + * This method is required by [[\Countable]] interface. * @return integer number of items in the session. */ public function count() @@ -820,7 +820,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param mixed $offset the offset to check on * @return boolean */ @@ -832,7 +832,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param integer $offset the offset to retrieve element. * @return mixed the element at the offset, null if no element is found at the offset */ @@ -844,7 +844,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param integer $offset the offset to set element * @param mixed $item the element value */ @@ -855,7 +855,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co } /** - * This method is required by the interface ArrayAccess. + * This method is required by the interface [[\ArrayAccess]]. * @param mixed $offset the offset to unset element */ public function offsetUnset($offset) diff --git a/framework/web/SessionIterator.php b/framework/web/SessionIterator.php index 69911d33c6..ccdbbf49b8 100644 --- a/framework/web/SessionIterator.php +++ b/framework/web/SessionIterator.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * SessionIterator implements an iterator for traversing session variables managed by [[Session]]. + * SessionIterator implements an [[\Iterator|iterator]] for traversing session variables managed by [[Session]]. * * @author Qiang Xue * @since 2.0 @@ -35,7 +35,7 @@ class SessionIterator implements \Iterator /** * Rewinds internal array pointer. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. */ public function rewind() { @@ -44,7 +44,7 @@ class SessionIterator implements \Iterator /** * Returns the key of the current array element. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return mixed the key of the current array element */ public function key() @@ -54,7 +54,7 @@ class SessionIterator implements \Iterator /** * Returns the current array element. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return mixed the current array element */ public function current() @@ -64,7 +64,7 @@ class SessionIterator implements \Iterator /** * Moves the internal pointer to the next array element. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. */ public function next() { @@ -75,7 +75,7 @@ class SessionIterator implements \Iterator /** * Returns whether there is an element at current position. - * This method is required by the interface Iterator. + * This method is required by the interface [[\Iterator]]. * @return boolean */ public function valid()