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 contact@x2engine.com.
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: Yii::import('application.models.X2LinkableBehavior');
38: 
39: /**
40:  * Model for managing lists of contacts
41:  * @package application.models
42:  */
43: class ContactList extends X2List {
44: 
45:     public static $modelName = 'Contacts';
46:     public static $linkRoute = '/contacts/contacts/list';
47: 
48:     /**
49:      * Behaviors for the model.
50:      * @return array 
51:      */
52:     public function behaviors() {
53:         return array(
54:             'X2LinkableBehavior'=>array(
55:                 'class'=>'X2LinkableBehavior',
56:                 'baseRoute'=>'/contacts/contacts',
57:                 'viewRoute'=>'/contacts/contacts/list',
58:                 'autoCompleteSource'=>'/contacts/contacts/getLists'
59:             )
60:         );
61:     }
62: 
63:     /**
64:      * Returns the static model of the specified AR class.
65:      * @return ContactList the static model class
66:      */
67:     public static function model($className=__CLASS__) {
68:         return parent::model($className);
69:     }
70: 
71:     /**
72:      * Returns the route for viewing contact lists.
73:      * @param integer $id
74:      * @return array
75:      */
76:     public static function getRoute($id) {
77:         if($id=='all')
78:             return array('/contacts/contacts/index');
79:         else if (empty($id) || $id=='my')
80:             return array('/contacts/contacts/viewMy');
81:         else
82:             return array('/contacts/contacts/list','id'=>$id);
83:     }
84:     
85:     /**
86:      * Creates a link (or displays the name, if the ID is not available) of 
87:      * the contact list.
88:      * @return string 
89:      */
90:     public function createLink() {
91:         if(isset($this->id))
92:             return CHtml::link($this->name,array($this->getDefaultRoute(),'id'=>$this->id));
93:         else
94:             return $this->name;
95:     }
96: }
97: