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:a10a2acb5e6198e023bf1b97883b16cf)
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',
125 'name' => 'campaign_id',
126 'type' => CRM_Utils_Type
::T_INT
,
127 'title' => ts('Campaign'),
128 'description' => ts('Foreign key to the activity Campaign.'),
130 'where' => 'civicrm_campaign_group.campaign_id',
131 'table_name' => 'civicrm_campaign_group',
132 'entity' => 'CampaignGroup',
133 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
135 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
139 'name' => 'group_type',
140 'type' => CRM_Utils_Type
::T_STRING
,
141 'title' => ts('Campaign Group Type'),
142 'description' => ts('Type of Group.'),
144 'size' => CRM_Utils_Type
::EIGHT
,
145 'where' => 'civicrm_campaign_group.group_type',
147 'table_name' => 'civicrm_campaign_group',
148 'entity' => 'CampaignGroup',
149 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
154 'pseudoconstant' => [
155 'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
160 'name' => 'entity_table',
161 'type' => CRM_Utils_Type
::T_STRING
,
162 'title' => ts('Entity Table'),
163 'description' => ts('Name of table where item being referenced is stored.'),
165 'size' => CRM_Utils_Type
::BIG
,
166 'where' => 'civicrm_campaign_group.entity_table',
168 'table_name' => 'civicrm_campaign_group',
169 'entity' => 'CampaignGroup',
170 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
175 'name' => 'entity_id',
176 'type' => CRM_Utils_Type
::T_INT
,
177 'title' => ts('Entity ID'),
178 'description' => ts('Entity id of referenced table.'),
179 'where' => 'civicrm_campaign_group.entity_id',
181 'table_name' => 'civicrm_campaign_group',
182 'entity' => 'CampaignGroup',
183 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
188 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
190 return Civi
::$statics[__CLASS__
]['fields'];
194 * Return a mapping from field-name to the corresponding key (as used in fields()).
197 * Array(string $name => string $uniqueName).
199 public static function &fieldKeys() {
200 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
201 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
203 return Civi
::$statics[__CLASS__
]['fieldKeys'];
207 * Returns the names of this table
211 public static function getTableName() {
212 return self
::$_tableName;
216 * Returns if this table needs to be logged
220 public function getLog() {
225 * Returns the list of fields that can be imported
227 * @param bool $prefix
231 public static function &import($prefix = FALSE) {
232 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'campaign_group', $prefix, []);
237 * Returns the list of fields that can be exported
239 * @param bool $prefix
243 public static function &export($prefix = FALSE) {
244 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'campaign_group', $prefix, []);
249 * Returns the list of indices
251 * @param bool $localize
255 public static function indices($localize = TRUE) {
257 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;