CRM/Mailing/DAO/BouncePattern.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/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 /**
  38  * CRM_Mailing_DAO_BouncePattern constructor.
  39  */
  40 class CRM_Mailing_DAO_BouncePattern extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_bounce_pattern';
  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 int unsigned
  62    */
  63   public $bounce_type_id;
  64   /**
  65    * A regexp to match a message to a bounce type
  66    *
  67    * @var string
  68    */
  69   public $pattern;
  70   /**
  71    * Class constructor.
  72    */
  73   function __construct() {
  74     $this->__table = 'civicrm_mailing_bounce_pattern';
  75     parent::__construct();
  76   }
  77   /**
  78    * Returns foreign keys and entity references.
  79    *
  80    * @return array
  81    *   [CRM_Core_Reference_Interface]
  82    */
  83   static function getReferenceColumns() {
  84     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  85       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  86       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'bounce_type_id', 'civicrm_mailing_bounce_type', 'id');
  87       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  88     }
  89     return Civi::$statics[__CLASS__]['links'];
  90   }
  91   /**
  92    * Returns all the column names of this table
  93    *
  94    * @return array
  95    */
  96   static function &fields() {
  97     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  98       Civi::$statics[__CLASS__]['fields'] = array(
  99         'id' => array(
 100           'name' => 'id',
 101           'type' => CRM_Utils_Type::T_INT,
 102           'title' => ts('Bounce Pattern ID') ,
 103           'required' => true,
 104         ) ,
 105         'bounce_type_id' => array(
 106           'name' => 'bounce_type_id',
 107           'type' => CRM_Utils_Type::T_INT,
 108           'title' => ts('Bounce Type') ,
 109           'description' => 'Type of bounce',
 110           'required' => true,
 111           'FKClassName' => 'CRM_Mailing_DAO_BounceType',
 112         ) ,
 113         'pattern' => array(
 114           'name' => 'pattern',
 115           'type' => CRM_Utils_Type::T_STRING,
 116           'title' => ts('Pattern') ,
 117           'description' => 'A regexp to match a message to a bounce type',
 118           'maxlength' => 255,
 119           'size' => CRM_Utils_Type::HUGE,
 120         ) ,
 121       );
 122       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 123     }
 124     return Civi::$statics[__CLASS__]['fields'];
 125   }
 126   /**
 127    * Return a mapping from field-name to the corresponding key (as used in fields()).
 128    *
 129    * @return array
 130    *   Array(string $name => string $uniqueName).
 131    */
 132   static function &fieldKeys() {
 133     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 134       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 135     }
 136     return Civi::$statics[__CLASS__]['fieldKeys'];
 137   }
 138   /**
 139    * Returns the names of this table
 140    *
 141    * @return string
 142    */
 143   static function getTableName() {
 144     return self::$_tableName;
 145   }
 146   /**
 147    * Returns if this table needs to be logged
 148    *
 149    * @return boolean
 150    */
 151   function getLog() {
 152     return self::$_log;
 153   }
 154   /**
 155    * Returns the list of fields that can be imported
 156    *
 157    * @param bool $prefix
 158    *
 159    * @return array
 160    */
 161   static function &import($prefix = false) {
 162     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_pattern', $prefix, array());
 163     return $r;
 164   }
 165   /**
 166    * Returns the list of fields that can be exported
 167    *
 168    * @param bool $prefix
 169    *
 170    * @return array
 171    */
 172   static function &export($prefix = false) {
 173     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_pattern', $prefix, array());
 174     return $r;
 175   }
 176 }