CRM/ACL/DAO/EntityRole.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/ACL/EntityRole.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:b6780a8cf74433fd38a0c7f9e6161986)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_ACL_DAO_EntityRole constructor.
  39  */
  40 class CRM_ACL_DAO_EntityRole extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_acl_entity_role';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Unique table ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)
  61    *
  62    * @var int unsigned
  63    */
  64   public $acl_role_id;
  65   /**
  66    * Table of the object joined to the ACL Role (Contact or Group)
  67    *
  68    * @var string
  69    */
  70   public $entity_table;
  71   /**
  72    * ID of the group/contact object being joined
  73    *
  74    * @var int unsigned
  75    */
  76   public $entity_id;
  77   /**
  78    * Is this property active?
  79    *
  80    * @var boolean
  81    */
  82   public $is_active;
  83   /**
  84    * Class constructor.
  85    */
  86   function __construct() {
  87     $this->__table = 'civicrm_acl_entity_role';
  88     parent::__construct();
  89   }
  90   /**
  91    * Returns foreign keys and entity references.
  92    *
  93    * @return array
  94    *   [CRM_Core_Reference_Interface]
  95    */
  96   static function getReferenceColumns() {
  97     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  98       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  99       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 100       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 101     }
 102     return Civi::$statics[__CLASS__]['links'];
 103   }
 104   /**
 105    * Returns all the column names of this table
 106    *
 107    * @return array
 108    */
 109   static function &fields() {
 110     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 111       Civi::$statics[__CLASS__]['fields'] = array(
 112         'id' => array(
 113           'name' => 'id',
 114           'type' => CRM_Utils_Type::T_INT,
 115           'title' => ts('Entity Role') ,
 116           'description' => 'Unique table ID',
 117           'required' => true,
 118           'table_name' => 'civicrm_acl_entity_role',
 119           'entity' => 'EntityRole',
 120           'bao' => 'CRM_ACL_BAO_EntityRole',
 121           'localizable' => 0,
 122         ) ,
 123         'acl_role_id' => array(
 124           'name' => 'acl_role_id',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('ACL Role ID') ,
 127           'description' => 'Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)',
 128           'required' => true,
 129           'table_name' => 'civicrm_acl_entity_role',
 130           'entity' => 'EntityRole',
 131           'bao' => 'CRM_ACL_BAO_EntityRole',
 132           'localizable' => 0,
 133         ) ,
 134         'entity_table' => array(
 135           'name' => 'entity_table',
 136           'type' => CRM_Utils_Type::T_STRING,
 137           'title' => ts('Entity Table') ,
 138           'description' => 'Table of the object joined to the ACL Role (Contact or Group)',
 139           'required' => true,
 140           'maxlength' => 64,
 141           'size' => CRM_Utils_Type::BIG,
 142           'table_name' => 'civicrm_acl_entity_role',
 143           'entity' => 'EntityRole',
 144           'bao' => 'CRM_ACL_BAO_EntityRole',
 145           'localizable' => 0,
 146         ) ,
 147         'entity_id' => array(
 148           'name' => 'entity_id',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('ACL Entity ID') ,
 151           'description' => 'ID of the group/contact object being joined',
 152           'required' => true,
 153           'table_name' => 'civicrm_acl_entity_role',
 154           'entity' => 'EntityRole',
 155           'bao' => 'CRM_ACL_BAO_EntityRole',
 156           'localizable' => 0,
 157         ) ,
 158         'is_active' => array(
 159           'name' => 'is_active',
 160           'type' => CRM_Utils_Type::T_BOOLEAN,
 161           'title' => ts('ACL Entity Role is Active') ,
 162           'description' => 'Is this property active?',
 163           'table_name' => 'civicrm_acl_entity_role',
 164           'entity' => 'EntityRole',
 165           'bao' => 'CRM_ACL_BAO_EntityRole',
 166           'localizable' => 0,
 167         ) ,
 168       );
 169       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 170     }
 171     return Civi::$statics[__CLASS__]['fields'];
 172   }
 173   /**
 174    * Return a mapping from field-name to the corresponding key (as used in fields()).
 175    *
 176    * @return array
 177    *   Array(string $name => string $uniqueName).
 178    */
 179   static function &fieldKeys() {
 180     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 181       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 182     }
 183     return Civi::$statics[__CLASS__]['fieldKeys'];
 184   }
 185   /**
 186    * Returns the names of this table
 187    *
 188    * @return string
 189    */
 190   static function getTableName() {
 191     return self::$_tableName;
 192   }
 193   /**
 194    * Returns if this table needs to be logged
 195    *
 196    * @return boolean
 197    */
 198   function getLog() {
 199     return self::$_log;
 200   }
 201   /**
 202    * Returns the list of fields that can be imported
 203    *
 204    * @param bool $prefix
 205    *
 206    * @return array
 207    */
 208   static function &import($prefix = false) {
 209     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_entity_role', $prefix, array());
 210     return $r;
 211   }
 212   /**
 213    * Returns the list of fields that can be exported
 214    *
 215    * @param bool $prefix
 216    *
 217    * @return array
 218    */
 219   static function &export($prefix = false) {
 220     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_entity_role', $prefix, array());
 221     return $r;
 222   }
 223   /**
 224    * Returns the list of indices
 225    */
 226   public static function indices($localize = TRUE) {
 227     $indices = array(
 228       'index_role' => array(
 229         'name' => 'index_role',
 230         'field' => array(
 231           0 => 'acl_role_id',
 232         ) ,
 233         'localizable' => false,
 234         'sig' => 'civicrm_acl_entity_role::0::acl_role_id',
 235       ) ,
 236       'index_entity' => array(
 237         'name' => 'index_entity',
 238         'field' => array(
 239           0 => 'entity_table',
 240           1 => 'entity_id',
 241         ) ,
 242         'localizable' => false,
 243         'sig' => 'civicrm_acl_entity_role::0::entity_table::entity_id',
 244       ) ,
 245     );
 246     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 247   }
 248 }