5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Campaign/CampaignGroup.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:7bfca99dbb564a33bc7845002f091536)
13 * Database access object for the CampaignGroup entity.
15 class CRM_Campaign_DAO_CampaignGroup
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '3.3';
18 const COMPONENT
= 'CiviCampaign';
21 * Static instance to hold the table name.
25 public static $_tableName = 'civicrm_campaign_group';
28 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 public static $_log = FALSE;
42 * Foreign key to the activity Campaign.
56 * Name of table where item being referenced is stored.
63 * Entity id of referenced table.
72 public function __construct() {
73 $this->__table
= 'civicrm_campaign_group';
74 parent
::__construct();
78 * Returns localized title of this entity.
81 * Whether to return the plural version of the title.
83 public static function getEntityTitle($plural = FALSE) {
84 return $plural ?
ts('Campaign Groups') : ts('Campaign Group');
88 * Returns foreign keys and entity references.
91 * [CRM_Core_Reference_Interface]
93 public static function getReferenceColumns() {
94 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
95 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
96 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
97 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
98 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
100 return Civi
::$statics[__CLASS__
]['links'];
104 * Returns all the column names of this table
108 public static function &fields() {
109 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
110 Civi
::$statics[__CLASS__
]['fields'] = [
113 'type' => CRM_Utils_Type
::T_INT
,
114 'title' => ts('Campaign Group ID'),
115 'description' => ts('Campaign Group id.'),
117 'where' => 'civicrm_campaign_group.id',
118 'table_name' => 'civicrm_campaign_group',
119 'entity' => 'CampaignGroup',
120 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
129 'name' => 'campaign_id',
130 'type' => CRM_Utils_Type
::T_INT
,
131 'title' => ts('Campaign ID'),
132 'description' => ts('Foreign key to the activity Campaign.'),
134 'where' => 'civicrm_campaign_group.campaign_id',
135 'table_name' => 'civicrm_campaign_group',
136 'entity' => 'CampaignGroup',
137 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
139 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
141 'type' => 'EntityRef',
142 'label' => ts("Campaign"),
147 'name' => 'group_type',
148 'type' => CRM_Utils_Type
::T_STRING
,
149 'title' => ts('Campaign Group Type'),
150 'description' => ts('Type of Group.'),
152 'size' => CRM_Utils_Type
::EIGHT
,
153 'where' => 'civicrm_campaign_group.group_type',
155 'table_name' => 'civicrm_campaign_group',
156 'entity' => 'CampaignGroup',
157 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
162 'pseudoconstant' => [
163 'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
168 'name' => 'entity_table',
169 'type' => CRM_Utils_Type
::T_STRING
,
170 'title' => ts('Entity Table'),
171 'description' => ts('Name of table where item being referenced is stored.'),
173 'size' => CRM_Utils_Type
::BIG
,
174 'where' => 'civicrm_campaign_group.entity_table',
176 'table_name' => 'civicrm_campaign_group',
177 'entity' => 'CampaignGroup',
178 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
183 'name' => 'entity_id',
184 'type' => CRM_Utils_Type
::T_INT
,
185 'title' => ts('Entity ID'),
186 'description' => ts('Entity id of referenced table.'),
187 'where' => 'civicrm_campaign_group.entity_id',
189 'table_name' => 'civicrm_campaign_group',
190 'entity' => 'CampaignGroup',
191 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
196 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
198 return Civi
::$statics[__CLASS__
]['fields'];
202 * Return a mapping from field-name to the corresponding key (as used in fields()).
205 * Array(string $name => string $uniqueName).
207 public static function &fieldKeys() {
208 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
209 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
211 return Civi
::$statics[__CLASS__
]['fieldKeys'];
215 * Returns the names of this table
219 public static function getTableName() {
220 return self
::$_tableName;
224 * Returns if this table needs to be logged
228 public function getLog() {
233 * Returns the list of fields that can be imported
235 * @param bool $prefix
239 public static function &import($prefix = FALSE) {
240 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'campaign_group', $prefix, []);
245 * Returns the list of fields that can be exported
247 * @param bool $prefix
251 public static function &export($prefix = FALSE) {
252 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'campaign_group', $prefix, []);
257 * Returns the list of indices
259 * @param bool $localize
263 public static function indices($localize = TRUE) {
265 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;