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:a96d346551d72b03fa3ca07ac47cff2b)
  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           'localizable' => 0,
 133         ) ,
 134         'mailing_id' => array(
 135           'name' => 'mailing_id',
 136           'type' => CRM_Utils_Type::T_INT,
 137           'title' => ts('Mailing') ,
 138           'description' => 'The ID of a previous mailing to include/exclude recipients.',
 139           'required' => true,
 140           'table_name' => 'civicrm_mailing_group',
 141           'entity' => 'MailingGroup',
 142           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 143           'localizable' => 0,
 144           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
 145         ) ,
 146         'group_type' => array(
 147           'name' => 'group_type',
 148           'type' => CRM_Utils_Type::T_STRING,
 149           'title' => ts('Mailing Group Type') ,
 150           'description' => 'Are the members of the group included or excluded?.',
 151           'maxlength' => 8,
 152           'size' => CRM_Utils_Type::EIGHT,
 153           'table_name' => 'civicrm_mailing_group',
 154           'entity' => 'MailingGroup',
 155           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 156           'localizable' => 0,
 157           'html' => array(
 158             'type' => 'Select',
 159           ) ,
 160           'pseudoconstant' => array(
 161             'callback' => 'CRM_Core_SelectValues::getMailingGroupTypes',
 162           )
 163         ) ,
 164         'entity_table' => array(
 165           'name' => 'entity_table',
 166           'type' => CRM_Utils_Type::T_STRING,
 167           'title' => ts('Mailing Group Entity Table') ,
 168           'description' => 'Name of table where item being referenced is stored.',
 169           'required' => true,
 170           'maxlength' => 64,
 171           'size' => CRM_Utils_Type::BIG,
 172           'table_name' => 'civicrm_mailing_group',
 173           'entity' => 'MailingGroup',
 174           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 175           'localizable' => 0,
 176           'pseudoconstant' => array(
 177             'callback' => 'CRM_Mailing_BAO_Mailing::mailingGroupEntityTables',
 178           )
 179         ) ,
 180         'entity_id' => array(
 181           'name' => 'entity_id',
 182           'type' => CRM_Utils_Type::T_INT,
 183           'title' => ts('Mailing Group Entity') ,
 184           'description' => 'Foreign key to the referenced item.',
 185           'required' => true,
 186           'table_name' => 'civicrm_mailing_group',
 187           'entity' => 'MailingGroup',
 188           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 189           'localizable' => 0,
 190         ) ,
 191         'search_id' => array(
 192           'name' => 'search_id',
 193           'type' => CRM_Utils_Type::T_INT,
 194           'title' => ts('Mailing Group Search') ,
 195           'description' => 'The filtering search. custom search id or -1 for civicrm api search',
 196           'table_name' => 'civicrm_mailing_group',
 197           'entity' => 'MailingGroup',
 198           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 199           'localizable' => 0,
 200         ) ,
 201         'search_args' => array(
 202           'name' => 'search_args',
 203           'type' => CRM_Utils_Type::T_TEXT,
 204           'title' => ts('Mailing Group Search Arguments') ,
 205           'description' => 'The arguments to be sent to the search function',
 206           'table_name' => 'civicrm_mailing_group',
 207           'entity' => 'MailingGroup',
 208           'bao' => 'CRM_Mailing_DAO_MailingGroup',
 209           'localizable' => 0,
 210         ) ,
 211       );
 212       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 213     }
 214     return Civi::$statics[__CLASS__]['fields'];
 215   }
 216   /**
 217    * Return a mapping from field-name to the corresponding key (as used in fields()).
 218    *
 219    * @return array
 220    *   Array(string $name => string $uniqueName).
 221    */
 222   static function &fieldKeys() {
 223     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 224       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 225     }
 226     return Civi::$statics[__CLASS__]['fieldKeys'];
 227   }
 228   /**
 229    * Returns the names of this table
 230    *
 231    * @return string
 232    */
 233   static function getTableName() {
 234     return self::$_tableName;
 235   }
 236   /**
 237    * Returns if this table needs to be logged
 238    *
 239    * @return boolean
 240    */
 241   function getLog() {
 242     return self::$_log;
 243   }
 244   /**
 245    * Returns the list of fields that can be imported
 246    *
 247    * @param bool $prefix
 248    *
 249    * @return array
 250    */
 251   static function &import($prefix = false) {
 252     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_group', $prefix, array());
 253     return $r;
 254   }
 255   /**
 256    * Returns the list of fields that can be exported
 257    *
 258    * @param bool $prefix
 259    *
 260    * @return array
 261    */
 262   static function &export($prefix = false) {
 263     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_group', $prefix, array());
 264     return $r;
 265   }
 266   /**
 267    * Returns the list of indices
 268    */
 269   public static function indices($localize = TRUE) {
 270     $indices = array();
 271     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 272   }
 273 }