1: <?php
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address [email protected].
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * Filters GET parameters by unique id to prevent issues that arise when multiple instances of X2GridView  * are on the same page.
 39:  *
 40:  * @package application.components
 41:  */
 42: class SmartSort extends CSort {
 43: 
 44:     public $uniqueId;
 45: 
 46:     public $alwaysApplyDefaultOrder = false;
 47: 
 48:     public function getOrderBy ($criteria=null) {
 49:         $order = parent::getOrderBy ($criteria);
 50:         if ($this->alwaysApplyDefaultOrder && $this->defaultOrder && 
 51:             $order !== $this->defaultOrder) {
 52: 
 53:             if ($order) {
 54:                 $order .= ', '.$this->defaultOrder;
 55:             } else {
 56:                 $order = $this->defaultOrder;
 57:             }
 58:         }
 59:         return $order;
 60:     }
 61: 
 62:     /**
 63:      * Overrides parent __construct ().
 64:      * @param string $uniqueId (optional) If set, will be used to uniquely identify this sort
 65:      *  instance.
 66:      *
 67:      * This method is Copyright (c) 2008-2014 by Yii Software LLC
 68:      * http://www.yiiframework.com/license/
 69:      */
 70:     public function __construct($modelClass=null, $uniqueId=null)
 71:     {
 72:         $this->modelClass=$modelClass;
 73:         /* x2modstart */ 
 74:         if ($uniqueId !== null) {
 75:             $this->uniqueId = $uniqueId;
 76:             $this->sortVar = $uniqueId."_sort";
 77:         }
 78:         /* x2modend */ 
 79:     }
 80: 
 81:     /**
 82:      * Added filtering of GET params so that only those related to the current sort get used to
 83:      * generate the url.
 84:      *
 85:      * This method is Copyright (c) 2008-2014 by Yii Software LLC
 86:      * http://www.yiiframework.com/license/
 87:      */
 88:     public function createUrl($controller,$directions)
 89:     {
 90:         $sorts=array();
 91:         foreach($directions as $attribute=>$descending)
 92:             $sorts[]=$descending ? $attribute.$this->separators[1].$this->descTag : $attribute;
 93:         /* x2modstart */ 
 94:         $explicitParams = $this->params!==null; 
 95:         /* x2modend */ 
 96:         $params=$this->params===null ? $_GET : $this->params;
 97:         $params[$this->sortVar]=implode($this->separators[0],$sorts);
 98:         /* x2modstart */ 
 99:         if (!$explicitParams) {
100:             foreach ($params as $key => $val) {
101:                  if (!preg_match ("/(^id$)|(^".
102:                     (isset ($this->uniqueId) ? $this->uniqueId : $this->modelClass)."_)/", $key)) {
103: 
104:                     unset ($params[$key]);
105:                  }
106:             }
107:         }
108:         /* x2modend */ 
109: 
110:         return $controller->createUrl($this->route,$params);
111:     }
112: }
113: