CRM/Campaign/DAO/CampaignGroup.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Campaign/CampaignGroup.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:1cf5b0513e86c29cb81bd0f694ccafcd)
  10  */
  11
  12 /**
  13  * Database access object for the CampaignGroup entity.
  14  */
  15 class CRM_Campaign_DAO_CampaignGroup extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '3.3';
  18   const COMPONENT = 'CiviCampaign';
  19
  20   /**
  21    * Static instance to hold the table name.
  22    *
  23    * @var string
  24    */
  25   public static $_tableName = 'civicrm_campaign_group';
  26
  27   /**
  28    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  29    *
  30    * @var bool
  31    */
  32   public static $_log = FALSE;
  33
  34   /**
  35    * Campaign Group id.
  36    *
  37    * @var int
  38    */
  39   public $id;
  40
  41   /**
  42    * Foreign key to the activity Campaign.
  43    *
  44    * @var int
  45    */
  46   public $campaign_id;
  47
  48   /**
  49    * Type of Group.
  50    *
  51    * @var string
  52    */
  53   public $group_type;
  54
  55   /**
  56    * Name of table where item being referenced is stored.
  57    *
  58    * @var string
  59    */
  60   public $entity_table;
  61
  62   /**
  63    * Entity id of referenced table.
  64    *
  65    * @var int
  66    */
  67   public $entity_id;
  68
  69   /**
  70    * Class constructor.
  71    */
  72   public function __construct() {
  73     $this->__table = 'civicrm_campaign_group';
  74     parent::__construct();
  75   }
  76
  77   /**
  78    * Returns localized title of this entity.
  79    *
  80    * @param bool $plural
  81    *   Whether to return the plural version of the title.
  82    */
  83   public static function getEntityTitle($plural = FALSE) {
  84     return $plural ? ts('Campaign Groups') : ts('Campaign Group');
  85   }
  86
  87   /**
  88    * Returns foreign keys and entity references.
  89    *
  90    * @return array
  91    *   [CRM_Core_Reference_Interface]
  92    */
  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']);
  99     }
 100     return Civi::$statics[__CLASS__]['links'];
 101   }
 102
 103   /**
 104    * Returns all the column names of this table
 105    *
 106    * @return array
 107    */
 108   public static function &fields() {
 109     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 110       Civi::$statics[__CLASS__]['fields'] = [
 111         'id' => [
 112           'name' => 'id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Campaign Group ID'),
 115           'description' => ts('Campaign Group id.'),
 116           'required' => TRUE,
 117           'where' => 'civicrm_campaign_group.id',
 118           'table_name' => 'civicrm_campaign_group',
 119           'entity' => 'CampaignGroup',
 120           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 121           'localizable' => 0,
 122           'html' => [
 123             'type' => 'Number',
 124           ],
 125           'readonly' => TRUE,
 126           'add' => '3.3',
 127         ],
 128         'campaign_id' => [
 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.'),
 133           'required' => TRUE,
 134           'where' => 'civicrm_campaign_group.campaign_id',
 135           'table_name' => 'civicrm_campaign_group',
 136           'entity' => 'CampaignGroup',
 137           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 138           'localizable' => 0,
 139           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 140           'html' => [
 141             'label' => ts("Campaign"),
 142           ],
 143           'add' => '3.3',
 144         ],
 145         'group_type' => [
 146           'name' => 'group_type',
 147           'type' => CRM_Utils_Type::T_STRING,
 148           'title' => ts('Campaign Group Type'),
 149           'description' => ts('Type of Group.'),
 150           'maxlength' => 8,
 151           'size' => CRM_Utils_Type::EIGHT,
 152           'where' => 'civicrm_campaign_group.group_type',
 153           'default' => 'NULL',
 154           'table_name' => 'civicrm_campaign_group',
 155           'entity' => 'CampaignGroup',
 156           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 157           'localizable' => 0,
 158           'html' => [
 159             'type' => 'Select',
 160           ],
 161           'pseudoconstant' => [
 162             'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
 163           ],
 164           'add' => NULL,
 165         ],
 166         'entity_table' => [
 167           'name' => 'entity_table',
 168           'type' => CRM_Utils_Type::T_STRING,
 169           'title' => ts('Entity Table'),
 170           'description' => ts('Name of table where item being referenced is stored.'),
 171           'maxlength' => 64,
 172           'size' => CRM_Utils_Type::BIG,
 173           'where' => 'civicrm_campaign_group.entity_table',
 174           'default' => 'NULL',
 175           'table_name' => 'civicrm_campaign_group',
 176           'entity' => 'CampaignGroup',
 177           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 178           'localizable' => 0,
 179           'add' => '3.3',
 180         ],
 181         'entity_id' => [
 182           'name' => 'entity_id',
 183           'type' => CRM_Utils_Type::T_INT,
 184           'title' => ts('Entity ID'),
 185           'description' => ts('Entity id of referenced table.'),
 186           'where' => 'civicrm_campaign_group.entity_id',
 187           'default' => 'NULL',
 188           'table_name' => 'civicrm_campaign_group',
 189           'entity' => 'CampaignGroup',
 190           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 191           'localizable' => 0,
 192           'add' => '3.3',
 193         ],
 194       ];
 195       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 196     }
 197     return Civi::$statics[__CLASS__]['fields'];
 198   }
 199
 200   /**
 201    * Return a mapping from field-name to the corresponding key (as used in fields()).
 202    *
 203    * @return array
 204    *   Array(string $name => string $uniqueName).
 205    */
 206   public static function &fieldKeys() {
 207     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 208       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 209     }
 210     return Civi::$statics[__CLASS__]['fieldKeys'];
 211   }
 212
 213   /**
 214    * Returns the names of this table
 215    *
 216    * @return string
 217    */
 218   public static function getTableName() {
 219     return self::$_tableName;
 220   }
 221
 222   /**
 223    * Returns if this table needs to be logged
 224    *
 225    * @return bool
 226    */
 227   public function getLog() {
 228     return self::$_log;
 229   }
 230
 231   /**
 232    * Returns the list of fields that can be imported
 233    *
 234    * @param bool $prefix
 235    *
 236    * @return array
 237    */
 238   public static function &import($prefix = FALSE) {
 239     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'campaign_group', $prefix, []);
 240     return $r;
 241   }
 242
 243   /**
 244    * Returns the list of fields that can be exported
 245    *
 246    * @param bool $prefix
 247    *
 248    * @return array
 249    */
 250   public static function &export($prefix = FALSE) {
 251     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'campaign_group', $prefix, []);
 252     return $r;
 253   }
 254
 255   /**
 256    * Returns the list of indices
 257    *
 258    * @param bool $localize
 259    *
 260    * @return array
 261    */
 262   public static function indices($localize = TRUE) {
 263     $indices = [];
 264     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 265   }
 266
 267 }