CRM/Campaign/DAO/CampaignGroup.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Campaign/CampaignGroup.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:16989135f9745e57028278a41cc303ea)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Campaign_DAO_CampaignGroup constructor.
  39  */
  40 class CRM_Campaign_DAO_CampaignGroup extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_campaign_group';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Campaign Group id.
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Foreign key to the activity Campaign.
  61    *
  62    * @var int unsigned
  63    */
  64   public $campaign_id;
  65   /**
  66    * Type of Group.
  67    *
  68    * @var string
  69    */
  70   public $group_type;
  71   /**
  72    * Name of table where item being referenced is stored.
  73    *
  74    * @var string
  75    */
  76   public $entity_table;
  77   /**
  78    * Entity id of referenced table.
  79    *
  80    * @var int unsigned
  81    */
  82   public $entity_id;
  83   /**
  84    * Class constructor.
  85    */
  86   function __construct() {
  87     $this->__table = 'civicrm_campaign_group';
  88     parent::__construct();
  89   }
  90   /**
  91    * Returns foreign keys and entity references.
  92    *
  93    * @return array
  94    *   [CRM_Core_Reference_Interface]
  95    */
  96   static function getReferenceColumns() {
  97     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  98       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  99       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'campaign_id', 'civicrm_campaign', 'id');
 100       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 101       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 102     }
 103     return Civi::$statics[__CLASS__]['links'];
 104   }
 105   /**
 106    * Returns all the column names of this table
 107    *
 108    * @return array
 109    */
 110   static function &fields() {
 111     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 112       Civi::$statics[__CLASS__]['fields'] = array(
 113         'id' => array(
 114           'name' => 'id',
 115           'type' => CRM_Utils_Type::T_INT,
 116           'title' => ts('Campaign Group ID') ,
 117           'description' => 'Campaign Group id.',
 118           'required' => true,
 119           'table_name' => 'civicrm_campaign_group',
 120           'entity' => 'CampaignGroup',
 121           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 122           'localizable' => 0,
 123         ) ,
 124         'campaign_id' => array(
 125           'name' => 'campaign_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Campaign') ,
 128           'description' => 'Foreign key to the activity Campaign.',
 129           'required' => true,
 130           'table_name' => 'civicrm_campaign_group',
 131           'entity' => 'CampaignGroup',
 132           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 135           'pseudoconstant' => array(
 136             'table' => 'civicrm_campaign',
 137             'keyColumn' => 'id',
 138             'labelColumn' => 'title',
 139           )
 140         ) ,
 141         'group_type' => array(
 142           'name' => 'group_type',
 143           'type' => CRM_Utils_Type::T_STRING,
 144           'title' => ts('Campaign Group Type') ,
 145           'description' => 'Type of Group.',
 146           'maxlength' => 8,
 147           'size' => CRM_Utils_Type::EIGHT,
 148           'default' => 'NULL',
 149           'table_name' => 'civicrm_campaign_group',
 150           'entity' => 'CampaignGroup',
 151           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 152           'localizable' => 0,
 153           'html' => array(
 154             'type' => 'Select',
 155           ) ,
 156           'pseudoconstant' => array(
 157             'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
 158           )
 159         ) ,
 160         'entity_table' => array(
 161           'name' => 'entity_table',
 162           'type' => CRM_Utils_Type::T_STRING,
 163           'title' => ts('Entity Table') ,
 164           'description' => 'Name of table where item being referenced is stored.',
 165           'maxlength' => 64,
 166           'size' => CRM_Utils_Type::BIG,
 167           'default' => 'NULL',
 168           'table_name' => 'civicrm_campaign_group',
 169           'entity' => 'CampaignGroup',
 170           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 171           'localizable' => 0,
 172         ) ,
 173         'entity_id' => array(
 174           'name' => 'entity_id',
 175           'type' => CRM_Utils_Type::T_INT,
 176           'title' => ts('Entity ID') ,
 177           'description' => 'Entity id of referenced table.',
 178           'default' => 'NULL',
 179           'table_name' => 'civicrm_campaign_group',
 180           'entity' => 'CampaignGroup',
 181           'bao' => 'CRM_Campaign_DAO_CampaignGroup',
 182           'localizable' => 0,
 183         ) ,
 184       );
 185       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 186     }
 187     return Civi::$statics[__CLASS__]['fields'];
 188   }
 189   /**
 190    * Return a mapping from field-name to the corresponding key (as used in fields()).
 191    *
 192    * @return array
 193    *   Array(string $name => string $uniqueName).
 194    */
 195   static function &fieldKeys() {
 196     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 197       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 198     }
 199     return Civi::$statics[__CLASS__]['fieldKeys'];
 200   }
 201   /**
 202    * Returns the names of this table
 203    *
 204    * @return string
 205    */
 206   static function getTableName() {
 207     return self::$_tableName;
 208   }
 209   /**
 210    * Returns if this table needs to be logged
 211    *
 212    * @return boolean
 213    */
 214   function getLog() {
 215     return self::$_log;
 216   }
 217   /**
 218    * Returns the list of fields that can be imported
 219    *
 220    * @param bool $prefix
 221    *
 222    * @return array
 223    */
 224   static function &import($prefix = false) {
 225     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'campaign_group', $prefix, array());
 226     return $r;
 227   }
 228   /**
 229    * Returns the list of fields that can be exported
 230    *
 231    * @param bool $prefix
 232    *
 233    * @return array
 234    */
 235   static function &export($prefix = false) {
 236     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'campaign_group', $prefix, array());
 237     return $r;
 238   }
 239   /**
 240    * Returns the list of indices
 241    */
 242   public static function indices($localize = TRUE) {
 243     $indices = array();
 244     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 245   }
 246 }