5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/ACL/EntityRole.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:b6780a8cf74433fd38a0c7f9e6161986)
13 * Database access object for the EntityRole entity.
15 class CRM_ACL_DAO_EntityRole
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_acl_entity_role';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
39 * Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)
46 * Table of the object joined to the ACL Role (Contact or Group)
53 * ID of the group/contact object being joined
60 * Is this property active?
69 public function __construct() {
70 $this->__table
= 'civicrm_acl_entity_role';
71 parent
::__construct();
75 * Returns foreign keys and entity references.
78 * [CRM_Core_Reference_Interface]
80 public static function getReferenceColumns() {
81 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
82 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
83 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
84 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
86 return Civi
::$statics[__CLASS__
]['links'];
90 * Returns all the column names of this table
94 public static function &fields() {
95 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
96 Civi
::$statics[__CLASS__
]['fields'] = [
99 'type' => CRM_Utils_Type
::T_INT
,
100 'title' => ts('Entity Role'),
101 'description' => ts('Unique table ID'),
103 'table_name' => 'civicrm_acl_entity_role',
104 'entity' => 'EntityRole',
105 'bao' => 'CRM_ACL_BAO_EntityRole',
109 'name' => 'acl_role_id',
110 'type' => CRM_Utils_Type
::T_INT
,
111 'title' => ts('ACL Role ID'),
112 'description' => ts('Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)'),
114 'table_name' => 'civicrm_acl_entity_role',
115 'entity' => 'EntityRole',
116 'bao' => 'CRM_ACL_BAO_EntityRole',
120 'name' => 'entity_table',
121 'type' => CRM_Utils_Type
::T_STRING
,
122 'title' => ts('Entity Table'),
123 'description' => ts('Table of the object joined to the ACL Role (Contact or Group)'),
126 'size' => CRM_Utils_Type
::BIG
,
127 'table_name' => 'civicrm_acl_entity_role',
128 'entity' => 'EntityRole',
129 'bao' => 'CRM_ACL_BAO_EntityRole',
133 'name' => 'entity_id',
134 'type' => CRM_Utils_Type
::T_INT
,
135 'title' => ts('ACL Entity ID'),
136 'description' => ts('ID of the group/contact object being joined'),
138 'table_name' => 'civicrm_acl_entity_role',
139 'entity' => 'EntityRole',
140 'bao' => 'CRM_ACL_BAO_EntityRole',
144 'name' => 'is_active',
145 'type' => CRM_Utils_Type
::T_BOOLEAN
,
146 'title' => ts('ACL Entity Role is Active'),
147 'description' => ts('Is this property active?'),
148 'table_name' => 'civicrm_acl_entity_role',
149 'entity' => 'EntityRole',
150 'bao' => 'CRM_ACL_BAO_EntityRole',
154 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
156 return Civi
::$statics[__CLASS__
]['fields'];
160 * Return a mapping from field-name to the corresponding key (as used in fields()).
163 * Array(string $name => string $uniqueName).
165 public static function &fieldKeys() {
166 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
167 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
169 return Civi
::$statics[__CLASS__
]['fieldKeys'];
173 * Returns the names of this table
177 public static function getTableName() {
178 return self
::$_tableName;
182 * Returns if this table needs to be logged
186 public function getLog() {
191 * Returns the list of fields that can be imported
193 * @param bool $prefix
197 public static function &import($prefix = FALSE) {
198 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'acl_entity_role', $prefix, []);
203 * Returns the list of fields that can be exported
205 * @param bool $prefix
209 public static function &export($prefix = FALSE) {
210 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'acl_entity_role', $prefix, []);
215 * Returns the list of indices
217 * @param bool $localize
221 public static function indices($localize = TRUE) {
224 'name' => 'index_role',
228 'localizable' => FALSE,
229 'sig' => 'civicrm_acl_entity_role::0::acl_role_id',
232 'name' => 'index_entity',
237 'localizable' => FALSE,
238 'sig' => 'civicrm_acl_entity_role::0::entity_table::entity_id',
241 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;