crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Mailing/DAO/BouncePattern.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  30  *
  31  * Generated from xml/schema/CRM/Mailing/BouncePattern.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Mailing_DAO_BouncePattern extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_mailing_bounce_pattern';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = false;
  82   /**
  83    *
  84    * @var int unsigned
  85    */
  86   public $id;
  87   /**
  88    * Type of bounce
  89    *
  90    * @var int unsigned
  91    */
  92   public $bounce_type_id;
  93   /**
  94    * A regexp to match a message to a bounce type
  95    *
  96    * @var string
  97    */
  98   public $pattern;
  99   /**
 100    * class constructor
 101    *
 102    * @return civicrm_mailing_bounce_pattern
 103    */
 104   function __construct() {
 105     $this->__table = 'civicrm_mailing_bounce_pattern';
 106     parent::__construct();
 107   }
 108   /**
 109    * Returns foreign keys and entity references
 110    *
 111    * @return array
 112    *   [CRM_Core_Reference_Interface]
 113    */
 114   static function getReferenceColumns() {
 115     if (!self::$_links) {
 116       self::$_links = static ::createReferenceColumns(__CLASS__);
 117       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'bounce_type_id', 'civicrm_mailing_bounce_type', 'id');
 118     }
 119     return self::$_links;
 120   }
 121   /**
 122    * Returns all the column names of this table
 123    *
 124    * @return array
 125    */
 126   static function &fields() {
 127     if (!(self::$_fields)) {
 128       self::$_fields = array(
 129         'id' => array(
 130           'name' => 'id',
 131           'type' => CRM_Utils_Type::T_INT,
 132           'required' => true,
 133         ) ,
 134         'bounce_type_id' => array(
 135           'name' => 'bounce_type_id',
 136           'type' => CRM_Utils_Type::T_INT,
 137           'description' => 'Type of bounce',
 138           'required' => true,
 139           'FKClassName' => 'CRM_Mailing_DAO_BounceType',
 140         ) ,
 141         'pattern' => array(
 142           'name' => 'pattern',
 143           'type' => CRM_Utils_Type::T_STRING,
 144           'title' => ts('Pattern') ,
 145           'description' => 'A regexp to match a message to a bounce type',
 146           'maxlength' => 255,
 147           'size' => CRM_Utils_Type::HUGE,
 148         ) ,
 149       );
 150     }
 151     return self::$_fields;
 152   }
 153   /**
 154    * Returns an array containing, for each field, the arary key used for that
 155    * field in self::$_fields.
 156    *
 157    * @return array
 158    */
 159   static function &fieldKeys() {
 160     if (!(self::$_fieldKeys)) {
 161       self::$_fieldKeys = array(
 162         'id' => 'id',
 163         'bounce_type_id' => 'bounce_type_id',
 164         'pattern' => 'pattern',
 165       );
 166     }
 167     return self::$_fieldKeys;
 168   }
 169   /**
 170    * Returns the names of this table
 171    *
 172    * @return string
 173    */
 174   static function getTableName() {
 175     return self::$_tableName;
 176   }
 177   /**
 178    * Returns if this table needs to be logged
 179    *
 180    * @return boolean
 181    */
 182   function getLog() {
 183     return self::$_log;
 184   }
 185   /**
 186    * Returns the list of fields that can be imported
 187    *
 188    * @param bool $prefix
 189    *
 190    * @return array
 191    */
 192   static function &import($prefix = false) {
 193     if (!(self::$_import)) {
 194       self::$_import = array();
 195       $fields = self::fields();
 196       foreach($fields as $name => $field) {
 197         if (CRM_Utils_Array::value('import', $field)) {
 198           if ($prefix) {
 199             self::$_import['mailing_bounce_pattern'] = & $fields[$name];
 200           } else {
 201             self::$_import[$name] = & $fields[$name];
 202           }
 203         }
 204       }
 205     }
 206     return self::$_import;
 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     if (!(self::$_export)) {
 217       self::$_export = array();
 218       $fields = self::fields();
 219       foreach($fields as $name => $field) {
 220         if (CRM_Utils_Array::value('export', $field)) {
 221           if ($prefix) {
 222             self::$_export['mailing_bounce_pattern'] = & $fields[$name];
 223           } else {
 224             self::$_export[$name] = & $fields[$name];
 225           }
 226         }
 227       }
 228     }
 229     return self::$_export;
 230   }
 231 }