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