CRM/Mailing/DAO/BounceType.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/BounceType.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:d68c2efe2239490c33482af1416b3c80)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Mailing_DAO_BounceType constructor.
  39  */
  40 class CRM_Mailing_DAO_BounceType extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_bounce_type';
  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    * Type of bounce
  60    *
  61    * @var string
  62    */
  63   public $name;
  64   /**
  65    * A description of this bounce type
  66    *
  67    * @var string
  68    */
  69   public $description;
  70   /**
  71    * Number of bounces of this type required before the email address is put on bounce hold
  72    *
  73    * @var int unsigned
  74    */
  75   public $hold_threshold;
  76   /**
  77    * Class constructor.
  78    */
  79   function __construct() {
  80     $this->__table = 'civicrm_mailing_bounce_type';
  81     parent::__construct();
  82   }
  83   /**
  84    * Returns all the column names of this table
  85    *
  86    * @return array
  87    */
  88   static function &fields() {
  89     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  90       Civi::$statics[__CLASS__]['fields'] = array(
  91         'id' => array(
  92           'name' => 'id',
  93           'type' => CRM_Utils_Type::T_INT,
  94           'title' => ts('Bounce Type ID') ,
  95           'required' => true,
  96           'table_name' => 'civicrm_mailing_bounce_type',
  97           'entity' => 'BounceType',
  98           'bao' => 'CRM_Mailing_DAO_BounceType',
  99         ) ,
 100         'name' => array(
 101           'name' => 'name',
 102           'type' => CRM_Utils_Type::T_STRING,
 103           'title' => ts('Bounce Type Name') ,
 104           'description' => 'Type of bounce',
 105           'required' => true,
 106           'maxlength' => 24,
 107           'size' => CRM_Utils_Type::MEDIUM,
 108           'table_name' => 'civicrm_mailing_bounce_type',
 109           'entity' => 'BounceType',
 110           'bao' => 'CRM_Mailing_DAO_BounceType',
 111         ) ,
 112         'description' => array(
 113           'name' => 'description',
 114           'type' => CRM_Utils_Type::T_STRING,
 115           'title' => ts('Bounce Type Description') ,
 116           'description' => 'A description of this bounce type',
 117           'maxlength' => 255,
 118           'size' => CRM_Utils_Type::HUGE,
 119           'table_name' => 'civicrm_mailing_bounce_type',
 120           'entity' => 'BounceType',
 121           'bao' => 'CRM_Mailing_DAO_BounceType',
 122         ) ,
 123         'hold_threshold' => array(
 124           'name' => 'hold_threshold',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('Hold Threshold') ,
 127           'description' => 'Number of bounces of this type required before the email address is put on bounce hold',
 128           'required' => true,
 129           'table_name' => 'civicrm_mailing_bounce_type',
 130           'entity' => 'BounceType',
 131           'bao' => 'CRM_Mailing_DAO_BounceType',
 132         ) ,
 133       );
 134       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 135     }
 136     return Civi::$statics[__CLASS__]['fields'];
 137   }
 138   /**
 139    * Return a mapping from field-name to the corresponding key (as used in fields()).
 140    *
 141    * @return array
 142    *   Array(string $name => string $uniqueName).
 143    */
 144   static function &fieldKeys() {
 145     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 146       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 147     }
 148     return Civi::$statics[__CLASS__]['fieldKeys'];
 149   }
 150   /**
 151    * Returns the names of this table
 152    *
 153    * @return string
 154    */
 155   static function getTableName() {
 156     return self::$_tableName;
 157   }
 158   /**
 159    * Returns if this table needs to be logged
 160    *
 161    * @return boolean
 162    */
 163   function getLog() {
 164     return self::$_log;
 165   }
 166   /**
 167    * Returns the list of fields that can be imported
 168    *
 169    * @param bool $prefix
 170    *
 171    * @return array
 172    */
 173   static function &import($prefix = false) {
 174     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_type', $prefix, array());
 175     return $r;
 176   }
 177   /**
 178    * Returns the list of fields that can be exported
 179    *
 180    * @param bool $prefix
 181    *
 182    * @return array
 183    */
 184   static function &export($prefix = false) {
 185     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_type', $prefix, array());
 186     return $r;
 187   }
 188 }