/framework/yii/web/Sort.php
PHP | 336 lines | 121 code | 20 blank | 195 comment | 21 complexity | 063dbf635dec323bc250f3ce068f0945 MD5 | raw file
Possible License(s): BSD-3-Clause, GPL-2.0
- <?php
- /**
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
- namespace yii\web;
- use Yii;
- use yii\helpers\Html;
- /**
- * Sort represents information relevant to sorting.
- *
- * When data needs to be sorted according to one or several attributes,
- * we can use Sort to represent the sorting information and generate
- * appropriate hyperlinks that can lead to sort actions.
- *
- * A typical usage example is as follows,
- *
- * ~~~
- * function actionIndex()
- * {
- * $sort = new Sort(array(
- * 'attributes' => array(
- * 'age',
- * 'name' => array(
- * 'asc' => array('last_name', 'first_name'),
- * 'desc' => array('last_name' => true, 'first_name' => true),
- * ),
- * ),
- * ));
- *
- * $models = Article::find()
- * ->where(array('status' => 1))
- * ->orderBy($sort->orders)
- * ->all();
- *
- * $this->render('index', array(
- * 'models' => $models,
- * 'sort' => $sort,
- * ));
- * }
- * ~~~
- *
- * View:
- *
- * ~~~
- * // display links leading to sort actions
- * echo $sort->link('name', 'Name') . ' | ' . $sort->link('age', 'Age');
- *
- * foreach ($models as $model) {
- * // display $model here
- * }
- * ~~~
- *
- * 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.
- *
- * @property array $orders Sort directions indexed by column names. The sort direction
- * can be either [[Sort::ASC]] for ascending order or [[Sort::DESC]] for descending order.
- * @property array $attributeOrders Sort directions indexed by attribute names. The sort
- * direction can be either [[Sort::ASC]] for ascending order or [[Sort::DESC]] for descending order.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @since 2.0
- */
- class Sort extends \yii\base\Object
- {
- /**
- * Sort ascending
- */
- const ASC = false;
- /**
- * Sort descending
- */
- const DESC = true;
- /**
- * @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.
- */
- public $enableMultiSort = false;
- /**
- * @var array list of attributes that are allowed to be sorted. Its syntax can be
- * described using the following example:
- *
- * ~~~
- * array(
- * 'age',
- * 'user' => array(
- * 'asc' => array('first_name' => Sort::ASC, 'last_name' => Sort::ASC),
- * 'desc' => array('first_name' => Sort::DESC, 'last_name' => Sort::DESC),
- * 'default' => 'desc',
- * ),
- * )
- * ~~~
- *
- * In the above, two attributes are declared: "age" and "user". The "age" attribute is
- * a simple attribute which is equivalent to the following:
- *
- * ~~~
- * 'age' => array(
- * 'asc' => array('age' => Sort::ASC),
- * 'desc' => array('age' => Sort::DESC),
- * )
- * ~~~
- *
- * The "user" attribute is a composite attribute:
- *
- * - The "user" key represents the attribute name which will appear in the URLs leading
- * to sort actions. Attribute names cannot contain characters listed in [[separators]].
- * - 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.
- * - And the "default" element specifies if the attribute is not sorted currently,
- * in which direction it should be sorted (the default value is ascending order).
- */
- public $attributes = array();
- /**
- * @var string the name of the parameter that specifies which attributes to be sorted
- * in which direction. Defaults to 'sort'.
- * @see params
- */
- public $sortVar = 'sort';
- /**
- * @var string the tag appeared in the [[sortVar]] parameter that indicates the attribute should be sorted
- * in descending order. Defaults to 'desc'.
- */
- public $descTag = 'desc';
- /**
- * @var array the order that should be used when the current request does not specify any order.
- * The array keys are attribute names and the array values are the corresponding sort directions. For example,
- *
- * ~~~
- * array(
- * 'name' => Sort::ASC,
- * 'create_time' => Sort::DESC,
- * )
- * ~~~
- *
- * @see attributeOrders
- */
- public $defaults;
- /**
- * @var string the route of the controller action for displaying the sorted contents.
- * If not set, it means using the currently requested route.
- */
- public $route;
- /**
- * @var array separators used in the generated URL. This must be an array consisting of
- * two elements. The first element specifies the character separating different
- * attributes, while the second element specifies the character separating attribute name
- * and the corresponding sort direction. Defaults to `array('-', '.')`.
- */
- public $separators = array('-', '.');
- /**
- * @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.
- *
- * The array element indexed by [[sortVar]] is considered to be the current sort directions.
- * If the element does not exist, the [[defaults|default order]] will be used.
- *
- * @see sortVar
- * @see defaults
- */
- public $params;
- /**
- * Returns the columns and their corresponding sort directions.
- * @return array the columns (keys) and their corresponding sort directions (values).
- * This can be passed to [[\yii\db\Query::orderBy()]] to construct a DB query.
- */
- public function getOrders()
- {
- $attributeOrders = $this->getAttributeOrders();
- $orders = array();
- foreach ($attributeOrders as $attribute => $direction) {
- $definition = $this->getAttribute($attribute);
- $columns = $definition[$direction === self::ASC ? 'asc' : 'desc'];
- foreach ($columns as $name => $dir) {
- $orders[$name] = $dir;
- }
- }
- return $orders;
- }
- /**
- * Generates a hyperlink that links to the sort action to sort by the specified attribute.
- * Based on the sort direction, the CSS class of the generated hyperlink will be appended
- * with "asc" or "desc".
- * @param string $attribute the attribute name by which the data should be sorted by.
- * @param string $label the link label. Note that the label will not be HTML-encoded.
- * @param array $htmlOptions additional HTML attributes for the hyperlink tag
- * @return string the generated hyperlink
- */
- public function link($attribute, $label, $htmlOptions = array())
- {
- if (($definition = $this->getAttribute($attribute)) === false) {
- return $label;
- }
- if (($direction = $this->getAttributeOrder($attribute)) !== null) {
- $class = $direction ? 'desc' : 'asc';
- if (isset($htmlOptions['class'])) {
- $htmlOptions['class'] .= ' ' . $class;
- } else {
- $htmlOptions['class'] = $class;
- }
- }
- $url = $this->createUrl($attribute);
- return Html::a($label, $url, $htmlOptions);
- }
- private $_attributeOrders;
- /**
- * Returns the currently requested sort information.
- * @param boolean $recalculate whether to recalculate the sort directions
- * @return array sort directions indexed by attribute names.
- * Sort direction can be either [[Sort::ASC]] for ascending order or
- * [[Sort::DESC]] for descending order.
- */
- public function getAttributeOrders($recalculate = false)
- {
- if ($this->_attributeOrders === null || $recalculate) {
- $this->_attributeOrders = array();
- $params = $this->params === null ? $_GET : $this->params;
- if (isset($params[$this->sortVar]) && is_scalar($params[$this->sortVar])) {
- $attributes = explode($this->separators[0], $params[$this->sortVar]);
- foreach ($attributes as $attribute) {
- $descending = false;
- if (($pos = strrpos($attribute, $this->separators[1])) !== false) {
- if ($descending = (substr($attribute, $pos + 1) === $this->descTag)) {
- $attribute = substr($attribute, 0, $pos);
- }
- }
- if (($this->getAttribute($attribute)) !== false) {
- $this->_attributeOrders[$attribute] = $descending;
- if (!$this->enableMultiSort) {
- return $this->_attributeOrders;
- }
- }
- }
- }
- if (empty($this->_attributeOrders) && is_array($this->defaults)) {
- $this->_attributeOrders = $this->defaults;
- }
- }
- return $this->_attributeOrders;
- }
- /**
- * Returns the sort direction of the specified attribute in the current request.
- * @param string $attribute the attribute name
- * @return boolean|null Sort direction of the attribute. Can be either [[Sort::ASC]]
- * for ascending order or [[Sort::DESC]] for descending order. Null is returned
- * if the attribute is invalid or does not need to be sorted.
- */
- public function getAttributeOrder($attribute)
- {
- $this->getAttributeOrders();
- return isset($this->_attributeOrders[$attribute]) ? $this->_attributeOrders[$attribute] : null;
- }
- /**
- * Creates a URL for sorting the data by the specified attribute.
- * This method will consider the current sorting status given by [[attributeOrders]].
- * For example, if the current page already sorts the data by the specified attribute in ascending order,
- * then the URL created will lead to a page that sorts the data by the specified attribute in descending order.
- * @param string $attribute the attribute name
- * @return string|boolean the URL for sorting. False if the attribute is invalid.
- * @see attributeOrders
- * @see params
- */
- public function createUrl($attribute)
- {
- if (($definition = $this->getAttribute($attribute)) === false) {
- return false;
- }
- $directions = $this->getAttributeOrders();
- if (isset($directions[$attribute])) {
- $descending = !$directions[$attribute];
- unset($directions[$attribute]);
- } elseif (isset($definition['default'])) {
- $descending = $definition['default'] === 'desc';
- } else {
- $descending = false;
- }
- if ($this->enableMultiSort) {
- $directions = array_merge(array($attribute => $descending), $directions);
- } else {
- $directions = array($attribute => $descending);
- }
- $sorts = array();
- foreach ($directions as $attribute => $descending) {
- $sorts[] = $descending ? $attribute . $this->separators[1] . $this->descTag : $attribute;
- }
- $params = $this->params === null ? $_GET : $this->params;
- $params[$this->sortVar] = implode($this->separators[0], $sorts);
- $route = $this->route === null ? Yii::$app->controller->route : $this->route;
- return Yii::$app->getUrlManager()->createUrl($route, $params);
- }
- /**
- * Returns the attribute definition of the specified name.
- * @param string $name the attribute name
- * @return array|boolean the sort definition (column names => sort directions).
- * False is returned if the attribute cannot be sorted.
- * @see attributes
- */
- public function getAttribute($name)
- {
- if (isset($this->attributes[$name])) {
- return $this->attributes[$name];
- } elseif (in_array($name, $this->attributes, true)) {
- return array(
- 'asc' => array($name => self::ASC),
- 'desc' => array($name => self::DESC),
- );
- } else {
- return false;
- }
- }
- }