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:88f73bc59595d75977b66fe76466a22c)
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',
136 'pseudoconstant' => [
137 'table' => 'civicrm_campaign',
139 'labelColumn' => 'title',
144 'name' => 'group_type',
145 'type' => CRM_Utils_Type
::T_STRING
,
146 'title' => ts('Campaign Group Type'),
147 'description' => ts('Type of Group.'),
149 'size' => CRM_Utils_Type
::EIGHT
,
150 'where' => 'civicrm_campaign_group.group_type',
152 'table_name' => 'civicrm_campaign_group',
153 'entity' => 'CampaignGroup',
154 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
159 'pseudoconstant' => [
160 'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
165 'name' => 'entity_table',
166 'type' => CRM_Utils_Type
::T_STRING
,
167 'title' => ts('Entity Table'),
168 'description' => ts('Name of table where item being referenced is stored.'),
170 'size' => CRM_Utils_Type
::BIG
,
171 'where' => 'civicrm_campaign_group.entity_table',
173 'table_name' => 'civicrm_campaign_group',
174 'entity' => 'CampaignGroup',
175 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
180 'name' => 'entity_id',
181 'type' => CRM_Utils_Type
::T_INT
,
182 'title' => ts('Entity ID'),
183 'description' => ts('Entity id of referenced table.'),
184 'where' => 'civicrm_campaign_group.entity_id',
186 'table_name' => 'civicrm_campaign_group',
187 'entity' => 'CampaignGroup',
188 'bao' => 'CRM_Campaign_DAO_CampaignGroup',
193 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
195 return Civi
::$statics[__CLASS__
]['fields'];
199 * Return a mapping from field-name to the corresponding key (as used in fields()).
202 * Array(string $name => string $uniqueName).
204 public static function &fieldKeys() {
205 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
206 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
208 return Civi
::$statics[__CLASS__
]['fieldKeys'];
212 * Returns the names of this table
216 public static function getTableName() {
217 return self
::$_tableName;
221 * Returns if this table needs to be logged
225 public function getLog() {
230 * Returns the list of fields that can be imported
232 * @param bool $prefix
236 public static function &import($prefix = FALSE) {
237 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'campaign_group', $prefix, []);
242 * Returns the list of fields that can be exported
244 * @param bool $prefix
248 public static function &export($prefix = FALSE) {
249 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'campaign_group', $prefix, []);
254 * Returns the list of indices
256 * @param bool $localize
260 public static function indices($localize = TRUE) {
262 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;