CRM/Mailing/DAO/Recipients.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/Mailing/Recipients.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:c342948a9f69ec474335688029f101e0)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Mailing_DAO_Recipients constructor.
  39  */
  40 class CRM_Mailing_DAO_Recipients extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_recipients';
  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    *
  55    * @var int unsigned
  56    */
  57   public $id;
  58   /**
  59    * The ID of the mailing this Job will send.
  60    *
  61    * @var int unsigned
  62    */
  63   public $mailing_id;
  64   /**
  65    * FK to Contact
  66    *
  67    * @var int unsigned
  68    */
  69   public $contact_id;
  70   /**
  71    * FK to Email
  72    *
  73    * @var int unsigned
  74    */
  75   public $email_id;
  76   /**
  77    * FK to Phone
  78    *
  79    * @var int unsigned
  80    */
  81   public $phone_id;
  82   /**
  83    * Class constructor.
  84    */
  85   function __construct() {
  86     $this->__table = 'civicrm_mailing_recipients';
  87     parent::__construct();
  88   }
  89   /**
  90    * Returns foreign keys and entity references.
  91    *
  92    * @return array
  93    *   [CRM_Core_Reference_Interface]
  94    */
  95   static function getReferenceColumns() {
  96     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  97       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  98       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'mailing_id', 'civicrm_mailing', 'id');
  99       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 100       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'email_id', 'civicrm_email', 'id');
 101       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'phone_id', 'civicrm_phone', 'id');
 102       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 103     }
 104     return Civi::$statics[__CLASS__]['links'];
 105   }
 106   /**
 107    * Returns all the column names of this table
 108    *
 109    * @return array
 110    */
 111   static function &fields() {
 112     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 113       Civi::$statics[__CLASS__]['fields'] = array(
 114         'id' => array(
 115           'name' => 'id',
 116           'type' => CRM_Utils_Type::T_INT,
 117           'title' => ts('Mailing Recipients ID') ,
 118           'required' => true,
 119           'table_name' => 'civicrm_mailing_recipients',
 120           'entity' => 'Recipients',
 121           'bao' => 'CRM_Mailing_BAO_Recipients',
 122           'localizable' => 0,
 123         ) ,
 124         'mailing_id' => array(
 125           'name' => 'mailing_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Mailing') ,
 128           'description' => 'The ID of the mailing this Job will send.',
 129           'required' => true,
 130           'table_name' => 'civicrm_mailing_recipients',
 131           'entity' => 'Recipients',
 132           'bao' => 'CRM_Mailing_BAO_Recipients',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
 135         ) ,
 136         'contact_id' => array(
 137           'name' => 'contact_id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Mailing Recipient') ,
 140           'description' => 'FK to Contact',
 141           'required' => true,
 142           'table_name' => 'civicrm_mailing_recipients',
 143           'entity' => 'Recipients',
 144           'bao' => 'CRM_Mailing_BAO_Recipients',
 145           'localizable' => 0,
 146           'FKClassName' => 'CRM_Contact_DAO_Contact',
 147         ) ,
 148         'email_id' => array(
 149           'name' => 'email_id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Recipient Email') ,
 152           'description' => 'FK to Email',
 153           'default' => 'NULL',
 154           'table_name' => 'civicrm_mailing_recipients',
 155           'entity' => 'Recipients',
 156           'bao' => 'CRM_Mailing_BAO_Recipients',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Core_DAO_Email',
 159         ) ,
 160         'phone_id' => array(
 161           'name' => 'phone_id',
 162           'type' => CRM_Utils_Type::T_INT,
 163           'title' => ts('Recipient Phone') ,
 164           'description' => 'FK to Phone',
 165           'default' => 'NULL',
 166           'table_name' => 'civicrm_mailing_recipients',
 167           'entity' => 'Recipients',
 168           'bao' => 'CRM_Mailing_BAO_Recipients',
 169           'localizable' => 0,
 170           'FKClassName' => 'CRM_Core_DAO_Phone',
 171         ) ,
 172       );
 173       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 174     }
 175     return Civi::$statics[__CLASS__]['fields'];
 176   }
 177   /**
 178    * Return a mapping from field-name to the corresponding key (as used in fields()).
 179    *
 180    * @return array
 181    *   Array(string $name => string $uniqueName).
 182    */
 183   static function &fieldKeys() {
 184     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 185       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 186     }
 187     return Civi::$statics[__CLASS__]['fieldKeys'];
 188   }
 189   /**
 190    * Returns the names of this table
 191    *
 192    * @return string
 193    */
 194   static function getTableName() {
 195     return self::$_tableName;
 196   }
 197   /**
 198    * Returns if this table needs to be logged
 199    *
 200    * @return boolean
 201    */
 202   function getLog() {
 203     return self::$_log;
 204   }
 205   /**
 206    * Returns the list of fields that can be imported
 207    *
 208    * @param bool $prefix
 209    *
 210    * @return array
 211    */
 212   static function &import($prefix = false) {
 213     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_recipients', $prefix, array());
 214     return $r;
 215   }
 216   /**
 217    * Returns the list of fields that can be exported
 218    *
 219    * @param bool $prefix
 220    *
 221    * @return array
 222    */
 223   static function &export($prefix = false) {
 224     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_recipients', $prefix, array());
 225     return $r;
 226   }
 227   /**
 228    * Returns the list of indices
 229    */
 230   public static function indices($localize = TRUE) {
 231     $indices = array();
 232     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 233   }
 234 }