php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-10 02:13:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cosmetic changes in DocBlocks (#12788) [skip ci]

Browse Source
This commit is contained in:
Roman Grinyov
2016-10-20 00:31:25 +03:00
committed by Alexander Makarov
parent 15c665974d
commit 088f15ee67
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
framework/data/Sort.php
View File

@ -24,7 +24,7 @@ use yii\web\Request;
* A typical usage example is as follows,
*
* ```php
* function actionIndex()
* public function actionIndex()
* {
* $sort = new Sort([
* 'attributes' => [
@ -61,7 +61,7 @@ use yii\web\Request;
* }
* ```
*
* In the above, we declare two [[attributes]] that support sorting: name and age.
* In the above, we declare two [[attributes]] that support sorting: `name` and `age`.
* We pass the sort information to the Article query so that the query results are
* sorted by the orders specified by the Sort object. In the view, we show two hyperlinks
* that can lead to pages with the data sorted by the corresponding attributes.
@ -78,7 +78,7 @@ class Sort extends Object
{
/**
* @var boolean whether the sorting can be applied to multiple attributes simultaneously.
* Defaults to false, which means each time the data can only be sorted by one attribute.
* Defaults to `false`, which means each time the data can only be sorted by one attribute.
*/
public $enableMultiSort = false;
/**
@ -97,7 +97,7 @@ class Sort extends Object
* ]
* ```
*
* In the above, two attributes are declared: "age" and "name". The "age" attribute is
* In the above, two attributes are declared: `age` and `name`. The `age` attribute is
* a simple attribute which is equivalent to the following:
*
* ```php
@ -109,16 +109,16 @@ class Sort extends Object
* ]
* ```
*
* The "name" attribute is a composite attribute:
* The `name` attribute is a composite attribute:
*
* - The "name" key represents the attribute name which will appear in the URLs leading
* - The `name` key represents the attribute name which will appear in the URLs leading
* to sort actions.
* - The "asc" and "desc" elements specify how to sort by the attribute in ascending
* - The `asc` and `desc` elements specify how to sort by the attribute in ascending
* and descending orders, respectively. Their values represent the actual columns and
* the directions by which the data should be sorted by.
* - The "default" element specifies by which direction the attribute should be sorted
* - The `default` element specifies by which direction the attribute should be sorted
* if it is not currently sorted (the default value is ascending order).
* - The "label" element specifies what label should be used when calling [[link()]] to create
* - The `label` element specifies what label should be used when calling [[link()]] to create
* a sort link. If not set, [[Inflector::camel2words()]] will be called to get a label.
* Note that it will not be HTML-encoded.
*
@ -128,7 +128,7 @@ class Sort extends Object
public $attributes = [];
/**
* @var string the name of the parameter that specifies which attributes to be sorted
* in which direction. Defaults to 'sort'.
* in which direction. Defaults to `sort`.
* @see params
*/
public $sortParam = 'sort';
@ -157,7 +157,7 @@ class Sort extends Object
public $separator = ',';
/**
* @var array parameters (name => value) that should be used to obtain the current sort directions
* and to create new sort URLs. If not set, $_GET will be used instead.
* and to create new sort URLs. If not set, `$_GET` will be used instead.
*
* In order to add hash to all links use `array_merge($_GET, ['#' => 'my-hash'])`.
*
@ -170,7 +170,7 @@ class Sort extends Object
public $params;
/**
* @var \yii\web\UrlManager the URL manager used for creating sort URLs. If not set,
* the "urlManager" application component will be used.
* the `urlManager` application component will be used.
*/
public $urlManager;