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:  * Description of ControllerPermissionsBehavior
39:  *
40:  * @package application.components.permissions
41:  */
42: abstract class ControllerPermissionsBehavior extends CBehavior {
43: 
44:     /**
45:      * Extension of a base Yii function, this method is run before every action
46:      * in a controller. If true is returned, it procedes as normal, otherwise
47:      * it can redirect to the login page or generate a 403 error.
48:      * @param string $action The name of the action being executed.
49:      * @return boolean True if the user can procede with the requested action
50:      */
51:     abstract function beforeAction($action = null);
52: 
53:     /**
54:      * Determines if we have permission to edit something based on the assignedTo field.
55:      *
56:      * @param mixed $model The model in question (subclass of {@link CActiveRecord} or {@link X2Model}
57:      * @param string $action "view" "edit" or "delete" -- what we're trying to do
58:      * @return boolean Whether or not the user is allowed for that action
59:      */
60:     abstract function checkPermissions(&$model, $action = null);
61: 
62:     /**
63:      * Format the left sidebar menu of links to remove items which a user is not
64:      * allowed to perform due to role settings.
65:      * @param array $array An array of menu items to be formatted
66:      * @param array $params An array of special parameters to be used for a role's biz rule
67:      * @return array The formatted list of menu items
68:      */
69:     abstract function formatMenu($array, $params = array());
70: }
71: 
72: ?>
73: