5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/ACL/EntityRole.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:c26077f17afc43e2f44efca99ae8e8fe)
13 * Database access object for the EntityRole entity.
15 class CRM_ACL_DAO_EntityRole
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.6';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_acl_entity_role';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
41 * Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)
48 * Table of the object joined to the ACL Role (Contact or Group)
55 * ID of the group/contact object being joined
62 * Is this property active?
71 public function __construct() {
72 $this->__table
= 'civicrm_acl_entity_role';
73 parent
::__construct();
77 * Returns localized title of this entity.
80 * Whether to return the plural version of the title.
82 public static function getEntityTitle($plural = FALSE) {
83 return $plural ?
ts('Entity Roles') : ts('Entity Role');
87 * Returns foreign keys and entity references.
90 * [CRM_Core_Reference_Interface]
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']);
98 return Civi
::$statics[__CLASS__
]['links'];
102 * Returns all the column names of this table
106 public static function &fields() {
107 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
108 Civi
::$statics[__CLASS__
]['fields'] = [
111 'type' => CRM_Utils_Type
::T_INT
,
112 'title' => ts('Entity Role'),
113 'description' => ts('Unique table ID'),
115 'where' => 'civicrm_acl_entity_role.id',
116 'table_name' => 'civicrm_acl_entity_role',
117 'entity' => 'EntityRole',
118 'bao' => 'CRM_ACL_BAO_EntityRole',
127 'name' => 'acl_role_id',
128 'type' => CRM_Utils_Type
::T_INT
,
129 'title' => ts('ACL Role ID'),
130 'description' => ts('Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)'),
132 'where' => 'civicrm_acl_entity_role.acl_role_id',
133 'table_name' => 'civicrm_acl_entity_role',
134 'entity' => 'EntityRole',
135 'bao' => 'CRM_ACL_BAO_EntityRole',
140 'name' => 'entity_table',
141 'type' => CRM_Utils_Type
::T_STRING
,
142 'title' => ts('Entity Table'),
143 'description' => ts('Table of the object joined to the ACL Role (Contact or Group)'),
146 'size' => CRM_Utils_Type
::BIG
,
147 'where' => 'civicrm_acl_entity_role.entity_table',
148 'table_name' => 'civicrm_acl_entity_role',
149 'entity' => 'EntityRole',
150 'bao' => 'CRM_ACL_BAO_EntityRole',
155 'name' => 'entity_id',
156 'type' => CRM_Utils_Type
::T_INT
,
157 'title' => ts('ACL Entity ID'),
158 'description' => ts('ID of the group/contact object being joined'),
160 'where' => 'civicrm_acl_entity_role.entity_id',
161 'table_name' => 'civicrm_acl_entity_role',
162 'entity' => 'EntityRole',
163 'bao' => 'CRM_ACL_BAO_EntityRole',
168 'name' => 'is_active',
169 'type' => CRM_Utils_Type
::T_BOOLEAN
,
170 'title' => ts('ACL Entity Role is Active'),
171 'description' => ts('Is this property active?'),
172 'where' => 'civicrm_acl_entity_role.is_active',
173 'table_name' => 'civicrm_acl_entity_role',
174 'entity' => 'EntityRole',
175 'bao' => 'CRM_ACL_BAO_EntityRole',
180 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
182 return Civi
::$statics[__CLASS__
]['fields'];
186 * Return a mapping from field-name to the corresponding key (as used in fields()).
189 * Array(string $name => string $uniqueName).
191 public static function &fieldKeys() {
192 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
193 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
195 return Civi
::$statics[__CLASS__
]['fieldKeys'];
199 * Returns the names of this table
203 public static function getTableName() {
204 return self
::$_tableName;
208 * Returns if this table needs to be logged
212 public function getLog() {
217 * Returns the list of fields that can be imported
219 * @param bool $prefix
223 public static function &import($prefix = FALSE) {
224 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'acl_entity_role', $prefix, []);
229 * Returns the list of fields that can be exported
231 * @param bool $prefix
235 public static function &export($prefix = FALSE) {
236 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'acl_entity_role', $prefix, []);
241 * Returns the list of indices
243 * @param bool $localize
247 public static function indices($localize = TRUE) {
250 'name' => 'index_role',
254 'localizable' => FALSE,
255 'sig' => 'civicrm_acl_entity_role::0::acl_role_id',
258 'name' => 'index_entity',
263 'localizable' => FALSE,
264 'sig' => 'civicrm_acl_entity_role::0::entity_table::entity_id',
267 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;