CRM/ACL/Page/EntityRole.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  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   public 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 = [
  63         CRM_Core_Action::UPDATE => [
  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 => [
  70           'name' => ts('Disable'),
  71           'ref' => 'crm-enable-disable',
  72           'title' => ts('Disable ACL Role Assignment'),
  73         ],
  74         CRM_Core_Action::ENABLE => [
  75           'name' => ts('Enable'),
  76           'ref' => 'crm-enable-disable',
  77           'title' => ts('Enable ACL Role Assignment'),
  78         ],
  79         CRM_Core_Action::DELETE => [
  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 = [
 102       [
 103         'title' => ts('Access Control'),
 104         'url' => CRM_Utils_System::url('civicrm/admin/access', 'reset=1'),
 105       ],
 106     ];
 107     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 108     CRM_Utils_System::setTitle(ts('Assign Users to Roles'));
 109
 110     // what action to take ?
 111     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::DELETE)) {
 112       $this->edit($this->_action, $id);
 113     }
 114
 115     // reset cache if enabled/disabled
 116     if ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::ENABLE)) {
 117       CRM_ACL_BAO_Cache::resetCache();
 118     }
 119
 120     // finally browse the acl's
 121     if ($this->_action & CRM_Core_Action::BROWSE) {
 122       $this->browse();
 123     }
 124
 125     // This replaces parent run, but do parent's parent run
 126     return CRM_Core_Page::run();
 127   }
 128
 129   /**
 130    * Browse all acls.
 131    */
 132   public function browse() {
 133
 134     // get all acl's sorted by weight
 135     $entityRoles = [];
 136     $dao = new CRM_ACL_DAO_EntityRole();
 137     $dao->find();
 138
 139     $aclRoles = CRM_Core_OptionGroup::values('acl_role');
 140     $groups = CRM_Core_PseudoConstant::staticGroup();
 141
 142     while ($dao->fetch()) {
 143       $entityRoles[$dao->id] = [];
 144       CRM_Core_DAO::storeValues($dao, $entityRoles[$dao->id]);
 145
 146       $entityRoles[$dao->id]['acl_role'] = CRM_Utils_Array::value($dao->acl_role_id, $aclRoles);
 147       $entityRoles[$dao->id]['entity'] = $groups[$dao->entity_id];
 148
 149       // form all action links
 150       $action = array_sum(array_keys($this->links()));
 151       if ($dao->is_active) {
 152         $action -= CRM_Core_Action::ENABLE;
 153       }
 154       else {
 155         $action -= CRM_Core_Action::DISABLE;
 156       }
 157
 158       $entityRoles[$dao->id]['action'] = CRM_Core_Action::formLink(
 159         self::links(),
 160         $action,
 161         ['id' => $dao->id],
 162         ts('more'),
 163         FALSE,
 164         'entityRole.manage.action',
 165         'EntityRole',
 166         $dao->id
 167       );
 168     }
 169     $this->assign('rows', $entityRoles);
 170   }
 171
 172   /**
 173    * Get name of edit form.
 174    *
 175    * @return string
 176    *   Classname of edit form.
 177    */
 178   public function editForm() {
 179     return 'CRM_ACL_Form_EntityRole';
 180   }
 181
 182   /**
 183    * Get edit form name.
 184    *
 185    * @return string
 186    *   name of this page.
 187    */
 188   public function editName() {
 189     return 'ACL EntityRole';
 190   }
 191
 192   /**
 193    * Get user context.
 194    *
 195    * @param null $mode
 196    *
 197    * @return string
 198    *   user context.
 199    */
 200   public function userContext($mode = NULL) {
 201     return 'civicrm/acl/entityrole';
 202   }
 203
 204 }