CRM/ACL/DAO/EntityRole.php

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