CRM/ACL/Page/EntityRole.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33 class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
  34
  35   public $useLivePageJS = TRUE;
  36
  37   /**
  38    * The action links that we need to display for the browse screen.
  39    *
  40    * @var array
  41    */
  42   static $_links = NULL;
  43
  44   /**
  45    * Get BAO Name.
  46    *
  47    * @return string
  48    *   Classname of BAO.
  49    */
  50   public function getBAOName() {
  51     return 'CRM_ACL_BAO_EntityRole';
  52   }
  53
  54   /**
  55    * Get action Links.
  56    *
  57    * @return array
  58    *   (reference) of action links
  59    */
  60   public function &links() {
  61     if (!(self::$_links)) {
  62       self::$_links = array(
  63         CRM_Core_Action::UPDATE => array(
  64           'name' => ts('Edit'),
  65           'url' => 'civicrm/acl/entityrole',
  66           'qs' => 'action=update&id=%%id%%',
  67           'title' => ts('Edit ACL Role Assignment'),
  68         ),
  69         CRM_Core_Action::DISABLE => array(
  70           'name' => ts('Disable'),
  71           'ref' => 'crm-enable-disable',
  72           'title' => ts('Disable ACL Role Assignment'),
  73         ),
  74         CRM_Core_Action::ENABLE => array(
  75           'name' => ts('Enable'),
  76           'ref' => 'crm-enable-disable',
  77           'title' => ts('Enable ACL Role Assignment'),
  78         ),
  79         CRM_Core_Action::DELETE => array(
  80           'name' => ts('Delete'),
  81           'url' => 'civicrm/acl/entityrole',
  82           'qs' => 'action=delete&id=%%id%%',
  83           'title' => ts('Delete ACL Role Assignment'),
  84         ),
  85       );
  86     }
  87     return self::$_links;
  88   }
  89
  90   /**
  91    * Run the page.
  92    *
  93    * This method is called after the page is created. It checks for the
  94    * type of action and executes that action.
  95    * Finally it calls the parent's run method.
  96    */
  97   public function run() {
  98     $id = $this->getIdAndAction();
  99
 100     // set breadcrumb to append to admin/access
 101     $breadCrumb = array(
 102       array(
 103         'title' => ts('Access Control'),
 104         'url' => CRM_Utils_System::url('civicrm/admin/access',
 105           'reset=1'
 106         ),
 107       ),
 108     );
 109     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 110     CRM_Utils_System::setTitle(ts('Assign Users to Roles'));
 111
 112     // what action to take ?
 113     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::DELETE)) {
 114       $this->edit($this->_action, $id);
 115     }
 116
 117     // reset cache if enabled/disabled
 118     if ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::ENABLE)) {
 119       CRM_ACL_BAO_Cache::resetCache();
 120     }
 121
 122     // finally browse the acl's
 123     if ($this->_action & CRM_Core_Action::BROWSE) {
 124       $this->browse();
 125     }
 126
 127     // This replaces parent run, but do parent's parent run
 128     return CRM_Core_Page::run();
 129   }
 130
 131   /**
 132    * Browse all acls.
 133    */
 134   public function browse() {
 135
 136     // get all acl's sorted by weight
 137     $entityRoles = array();
 138     $dao = new CRM_ACL_DAO_EntityRole();
 139     $dao->find();
 140
 141     $aclRoles = CRM_Core_OptionGroup::values('acl_role');
 142     $groups = CRM_Core_PseudoConstant::staticGroup();
 143
 144     while ($dao->fetch()) {
 145       $entityRoles[$dao->id] = array();
 146       CRM_Core_DAO::storeValues($dao, $entityRoles[$dao->id]);
 147
 148       $entityRoles[$dao->id]['acl_role'] = CRM_Utils_Array::value($dao->acl_role_id, $aclRoles);
 149       $entityRoles[$dao->id]['entity'] = $groups[$dao->entity_id];
 150
 151       // form all action links
 152       $action = array_sum(array_keys($this->links()));
 153       if ($dao->is_active) {
 154         $action -= CRM_Core_Action::ENABLE;
 155       }
 156       else {
 157         $action -= CRM_Core_Action::DISABLE;
 158       }
 159
 160       $entityRoles[$dao->id]['action'] = CRM_Core_Action::formLink(
 161         self::links(),
 162         $action,
 163         array('id' => $dao->id),
 164         ts('more'),
 165         FALSE,
 166         'entityRole.manage.action',
 167         'EntityRole',
 168         $dao->id
 169       );
 170     }
 171     $this->assign('rows', $entityRoles);
 172   }
 173
 174   /**
 175    * Get name of edit form.
 176    *
 177    * @return string
 178    *   Classname of edit form.
 179    */
 180   public function editForm() {
 181     return 'CRM_ACL_Form_EntityRole';
 182   }
 183
 184   /**
 185    * Get edit form name.
 186    *
 187    * @return string
 188    *   name of this page.
 189    */
 190   public function editName() {
 191     return 'ACL EntityRole';
 192   }
 193
 194   /**
 195    * Get user context.
 196    *
 197    * @param null $mode
 198    *
 199    * @return string
 200    *   user context.
 201    */
 202   public function userContext($mode = NULL) {
 203     return 'civicrm/acl/entityrole';
 204   }
 205
 206 }