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 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 int unsigned
  72    */
  73   public $bounce_type_id;
  74   /**
  75    * A regexp to match a message to a bounce type
  76    *
  77    * @var string
  78    */
  79   public $pattern;
  80   /**
  81    * class constructor
  82    *
  83    * @return civicrm_mailing_bounce_pattern
  84    */
  85   function __construct() {
  86     $this->__table = 'civicrm_mailing_bounce_pattern';
  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 (!self::$_links) {
  97       self::$_links = static ::createReferenceColumns(__CLASS__);
  98       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'bounce_type_id', 'civicrm_mailing_bounce_type', 'id');
  99     }
 100     return self::$_links;
 101   }
 102   /**
 103    * Returns all the column names of this table
 104    *
 105    * @return array
 106    */
 107   static function &fields() {
 108     if (!(self::$_fields)) {
 109       self::$_fields = array(
 110         'id' => array(
 111           'name' => 'id',
 112           'type' => CRM_Utils_Type::T_INT,
 113           'title' => ts('Bounce Pattern ID') ,
 114           'required' => true,
 115         ) ,
 116         'bounce_type_id' => array(
 117           'name' => 'bounce_type_id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Bounce Type') ,
 120           'description' => 'Type of bounce',
 121           'required' => true,
 122           'FKClassName' => 'CRM_Mailing_DAO_BounceType',
 123         ) ,
 124         'pattern' => array(
 125           'name' => 'pattern',
 126           'type' => CRM_Utils_Type::T_STRING,
 127           'title' => ts('Pattern') ,
 128           'description' => 'A regexp to match a message to a bounce type',
 129           'maxlength' => 255,
 130           'size' => CRM_Utils_Type::HUGE,
 131         ) ,
 132       );
 133     }
 134     return self::$_fields;
 135   }
 136   /**
 137    * Return a mapping from field-name to the corresponding key (as used in fields()).
 138    *
 139    * @return array
 140    *   Array(string $name => string $uniqueName).
 141    */
 142   static function &fieldKeys() {
 143     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 144       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 145     }
 146     return Civi::$statics[__CLASS__]['fieldKeys'];
 147   }
 148   /**
 149    * Returns the names of this table
 150    *
 151    * @return string
 152    */
 153   static function getTableName() {
 154     return self::$_tableName;
 155   }
 156   /**
 157    * Returns if this table needs to be logged
 158    *
 159    * @return boolean
 160    */
 161   function getLog() {
 162     return self::$_log;
 163   }
 164   /**
 165    * Returns the list of fields that can be imported
 166    *
 167    * @param bool $prefix
 168    *
 169    * @return array
 170    */
 171   static function &import($prefix = false) {
 172     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_pattern', $prefix, array());
 173     return $r;
 174   }
 175   /**
 176    * Returns the list of fields that can be exported
 177    *
 178    * @param bool $prefix
 179    *
 180    * @return array
 181    */
 182   static function &export($prefix = false) {
 183     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_pattern', $prefix, array());
 184     return $r;
 185   }
 186 }