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:a10a2acb5e6198e023bf1b97883b16cf)
  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           'add' => '3.3',
 123         ],
 124         'campaign_id' => [
 125           'name' => 'campaign_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Campaign'),
 128           'description' => ts('Foreign key to the activity Campaign.'),
 129           'required' => TRUE,
 130           'where' => 'civicrm_campaign_group.campaign_id',
 131           'table_name' => 'civicrm_campaign_group',
 132           'entity' => 'CampaignGroup',
 133           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 134           'localizable' => 0,
 135           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 136           'add' => '3.3',
 137         ],
 138         'group_type' => [
 139           'name' => 'group_type',
 140           'type' => CRM_Utils_Type::T_STRING,
 141           'title' => ts('Campaign Group Type'),
 142           'description' => ts('Type of Group.'),
 143           'maxlength' => 8,
 144           'size' => CRM_Utils_Type::EIGHT,
 145           'where' => 'civicrm_campaign_group.group_type',
 146           'default' => 'NULL',
 147           'table_name' => 'civicrm_campaign_group',
 148           'entity' => 'CampaignGroup',
 149           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 150           'localizable' => 0,
 151           'html' => [
 152             'type' => 'Select',
 153           ],
 154           'pseudoconstant' => [
 155             'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
 156           ],
 157           'add' => NULL,
 158         ],
 159         'entity_table' => [
 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.'),
 164           'maxlength' => 64,
 165           'size' => CRM_Utils_Type::BIG,
 166           'where' => 'civicrm_campaign_group.entity_table',
 167           'default' => 'NULL',
 168           'table_name' => 'civicrm_campaign_group',
 169           'entity' => 'CampaignGroup',
 170           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 171           'localizable' => 0,
 172           'add' => '3.3',
 173         ],
 174         'entity_id' => [
 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',
 180           'default' => 'NULL',
 181           'table_name' => 'civicrm_campaign_group',
 182           'entity' => 'CampaignGroup',
 183           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 184           'localizable' => 0,
 185           'add' => '3.3',
 186         ],
 187       ];
 188       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 189     }
 190     return Civi::$statics[__CLASS__]['fields'];
 191   }
 192
 193   /**
 194    * Return a mapping from field-name to the corresponding key (as used in fields()).
 195    *
 196    * @return array
 197    *   Array(string $name => string $uniqueName).
 198    */
 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()));
 202     }
 203     return Civi::$statics[__CLASS__]['fieldKeys'];
 204   }
 205
 206   /**
 207    * Returns the names of this table
 208    *
 209    * @return string
 210    */
 211   public static function getTableName() {
 212     return self::$_tableName;
 213   }
 214
 215   /**
 216    * Returns if this table needs to be logged
 217    *
 218    * @return bool
 219    */
 220   public function getLog() {
 221     return self::$_log;
 222   }
 223
 224   /**
 225    * Returns the list of fields that can be imported
 226    *
 227    * @param bool $prefix
 228    *
 229    * @return array
 230    */
 231   public static function &import($prefix = FALSE) {
 232     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'campaign_group', $prefix, []);
 233     return $r;
 234   }
 235
 236   /**
 237    * Returns the list of fields that can be exported
 238    *
 239    * @param bool $prefix
 240    *
 241    * @return array
 242    */
 243   public static function &export($prefix = FALSE) {
 244     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'campaign_group', $prefix, []);
 245     return $r;
 246   }
 247
 248   /**
 249    * Returns the list of indices
 250    *
 251    * @param bool $localize
 252    *
 253    * @return array
 254    */
 255   public static function indices($localize = TRUE) {
 256     $indices = [];
 257     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 258   }
 259
 260 }