CRM/Mailing/DAO/MailingGroup.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/MailingGroup.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:fa734125b5fd4a3d8d916fc0cfdfbba4)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Mailing_DAO_MailingGroup constructor.
  39  */
  40 class CRM_Mailing_DAO_MailingGroup extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_group';
  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    * The ID of a previous mailing to include/exclude recipients.
  60    *
  61    * @var int unsigned
  62    */
  63   public $mailing_id;
  64   /**
  65    * Are the members of the group included or excluded?.
  66    *
  67    * @var string
  68    */
  69   public $group_type;
  70   /**
  71    * Name of table where item being referenced is stored.
  72    *
  73    * @var string
  74    */
  75   public $entity_table;
  76   /**
  77    * Foreign key to the referenced item.
  78    *
  79    * @var int unsigned
  80    */
  81   public $entity_id;
  82   /**
  83    * The filtering search. custom search id or -1 for civicrm api search
  84    *
  85    * @var int
  86    */
  87   public $search_id;
  88   /**
  89    * The arguments to be sent to the search function
  90    *
  91    * @var text
  92    */
  93   public $search_args;
  94   /**
  95    * Class constructor.
  96    */
  97   function __construct() {
  98     $this->__table = 'civicrm_mailing_group';
  99     parent::__construct();
 100   }
 101   /**
 102    * Returns foreign keys and entity references.
 103    *
 104    * @return array
 105    *   [CRM_Core_Reference_Interface]
 106    */
 107   static function getReferenceColumns() {
 108     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 109       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 110       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'mailing_id', 'civicrm_mailing', 'id');
 111       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 112       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 113     }
 114     return Civi::$statics[__CLASS__]['links'];
 115   }
 116   /**
 117    * Returns all the column names of this table
 118    *
 119    * @return array
 120    */
 121   static function &fields() {
 122     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 123       Civi::$statics[__CLASS__]['fields'] = array(
 124         'id' => array(
 125           'name' => 'id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Mailing Group ID') ,
 128           'required' => true,
 129           'table_name' => 'civicrm_mailing_group',
 130           'entity' => 'MailingGroup',
 131           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 132         ) ,
 133         'mailing_id' => array(
 134           'name' => 'mailing_id',
 135           'type' => CRM_Utils_Type::T_INT,
 136           'title' => ts('Mailing') ,
 137           'description' => 'The ID of a previous mailing to include/exclude recipients.',
 138           'required' => true,
 139           'table_name' => 'civicrm_mailing_group',
 140           'entity' => 'MailingGroup',
 141           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 142           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
 143         ) ,
 144         'group_type' => array(
 145           'name' => 'group_type',
 146           'type' => CRM_Utils_Type::T_STRING,
 147           'title' => ts('Mailing Group Type') ,
 148           'description' => 'Are the members of the group included or excluded?.',
 149           'maxlength' => 8,
 150           'size' => CRM_Utils_Type::EIGHT,
 151           'table_name' => 'civicrm_mailing_group',
 152           'entity' => 'MailingGroup',
 153           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 154           'html' => array(
 155             'type' => 'Select',
 156           ) ,
 157           'pseudoconstant' => array(
 158             'callback' => 'CRM_Core_SelectValues::getMailingGroupTypes',
 159           )
 160         ) ,
 161         'entity_table' => array(
 162           'name' => 'entity_table',
 163           'type' => CRM_Utils_Type::T_STRING,
 164           'title' => ts('Mailing Group Entity Table') ,
 165           'description' => 'Name of table where item being referenced is stored.',
 166           'required' => true,
 167           'maxlength' => 64,
 168           'size' => CRM_Utils_Type::BIG,
 169           'table_name' => 'civicrm_mailing_group',
 170           'entity' => 'MailingGroup',
 171           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 172           'pseudoconstant' => array(
 173             'callback' => 'CRM_Mailing_BAO_Mailing::mailingGroupEntityTables',
 174           )
 175         ) ,
 176         'entity_id' => array(
 177           'name' => 'entity_id',
 178           'type' => CRM_Utils_Type::T_INT,
 179           'title' => ts('Mailing Group Entity') ,
 180           'description' => 'Foreign key to the referenced item.',
 181           'required' => true,
 182           'table_name' => 'civicrm_mailing_group',
 183           'entity' => 'MailingGroup',
 184           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 185         ) ,
 186         'search_id' => array(
 187           'name' => 'search_id',
 188           'type' => CRM_Utils_Type::T_INT,
 189           'title' => ts('Mailing Group Search') ,
 190           'description' => 'The filtering search. custom search id or -1 for civicrm api search',
 191           'table_name' => 'civicrm_mailing_group',
 192           'entity' => 'MailingGroup',
 193           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 194         ) ,
 195         'search_args' => array(
 196           'name' => 'search_args',
 197           'type' => CRM_Utils_Type::T_TEXT,
 198           'title' => ts('Mailing Group Search Arguments') ,
 199           'description' => 'The arguments to be sent to the search function',
 200           'table_name' => 'civicrm_mailing_group',
 201           'entity' => 'MailingGroup',
 202           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 203         ) ,
 204       );
 205       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 206     }
 207     return Civi::$statics[__CLASS__]['fields'];
 208   }
 209   /**
 210    * Return a mapping from field-name to the corresponding key (as used in fields()).
 211    *
 212    * @return array
 213    *   Array(string $name => string $uniqueName).
 214    */
 215   static function &fieldKeys() {
 216     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 217       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 218     }
 219     return Civi::$statics[__CLASS__]['fieldKeys'];
 220   }
 221   /**
 222    * Returns the names of this table
 223    *
 224    * @return string
 225    */
 226   static function getTableName() {
 227     return self::$_tableName;
 228   }
 229   /**
 230    * Returns if this table needs to be logged
 231    *
 232    * @return boolean
 233    */
 234   function getLog() {
 235     return self::$_log;
 236   }
 237   /**
 238    * Returns the list of fields that can be imported
 239    *
 240    * @param bool $prefix
 241    *
 242    * @return array
 243    */
 244   static function &import($prefix = false) {
 245     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_group', $prefix, array());
 246     return $r;
 247   }
 248   /**
 249    * Returns the list of fields that can be exported
 250    *
 251    * @param bool $prefix
 252    *
 253    * @return array
 254    */
 255   static function &export($prefix = false) {
 256     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_group', $prefix, array());
 257     return $r;
 258   }
 259 }