CRM/Campaign/DAO/CampaignGroup.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  30  *
  31  * Generated from xml/schema/CRM/Campaign/CampaignGroup.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:4ff30619fe1018210832e24befe9c40f)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Campaign_DAO_CampaignGroup extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_campaign_group';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    * Campaign Group id.
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Foreign key to the activity Campaign.
  59    *
  60    * @var int unsigned
  61    */
  62   public $campaign_id;
  63   /**
  64    * Type of Group.
  65    *
  66    * @var string
  67    */
  68   public $group_type;
  69   /**
  70    * Name of table where item being referenced is stored.
  71    *
  72    * @var string
  73    */
  74   public $entity_table;
  75   /**
  76    * Entity id of referenced table.
  77    *
  78    * @var int unsigned
  79    */
  80   public $entity_id;
  81   /**
  82    * class constructor
  83    *
  84    * @return civicrm_campaign_group
  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         ) ,
 120         'campaign_id' => array(
 121           'name' => 'campaign_id',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Campaign') ,
 124           'description' => 'Foreign key to the activity Campaign.',
 125           'required' => true,
 126           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 127           'pseudoconstant' => array(
 128             'table' => 'civicrm_campaign',
 129             'keyColumn' => 'id',
 130             'labelColumn' => 'title',
 131           )
 132         ) ,
 133         'group_type' => array(
 134           'name' => 'group_type',
 135           'type' => CRM_Utils_Type::T_STRING,
 136           'title' => ts('Campaign Group Type') ,
 137           'description' => 'Type of Group.',
 138           'maxlength' => 8,
 139           'size' => CRM_Utils_Type::EIGHT,
 140           'default' => 'NULL',
 141           'html' => array(
 142             'type' => 'Select',
 143           ) ,
 144           'pseudoconstant' => array(
 145             'callback' => 'CRM_Core_SelectValues::getCampaignGroupTypes',
 146           )
 147         ) ,
 148         'entity_table' => array(
 149           'name' => 'entity_table',
 150           'type' => CRM_Utils_Type::T_STRING,
 151           'title' => ts('Entity Table') ,
 152           'description' => 'Name of table where item being referenced is stored.',
 153           'maxlength' => 64,
 154           'size' => CRM_Utils_Type::BIG,
 155           'default' => 'NULL',
 156         ) ,
 157         'entity_id' => array(
 158           'name' => 'entity_id',
 159           'type' => CRM_Utils_Type::T_INT,
 160           'title' => ts('Entity ID') ,
 161           'description' => 'Entity id of referenced table.',
 162           'default' => 'NULL',
 163         ) ,
 164       );
 165       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 166     }
 167     return Civi::$statics[__CLASS__]['fields'];
 168   }
 169   /**
 170    * Return a mapping from field-name to the corresponding key (as used in fields()).
 171    *
 172    * @return array
 173    *   Array(string $name => string $uniqueName).
 174    */
 175   static function &fieldKeys() {
 176     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 177       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 178     }
 179     return Civi::$statics[__CLASS__]['fieldKeys'];
 180   }
 181   /**
 182    * Returns the names of this table
 183    *
 184    * @return string
 185    */
 186   static function getTableName() {
 187     return self::$_tableName;
 188   }
 189   /**
 190    * Returns if this table needs to be logged
 191    *
 192    * @return boolean
 193    */
 194   function getLog() {
 195     return self::$_log;
 196   }
 197   /**
 198    * Returns the list of fields that can be imported
 199    *
 200    * @param bool $prefix
 201    *
 202    * @return array
 203    */
 204   static function &import($prefix = false) {
 205     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'campaign_group', $prefix, array());
 206     return $r;
 207   }
 208   /**
 209    * Returns the list of fields that can be exported
 210    *
 211    * @param bool $prefix
 212    *
 213    * @return array
 214    */
 215   static function &export($prefix = false) {
 216     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'campaign_group', $prefix, array());
 217     return $r;
 218   }
 219 }