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