262 lines
		
	
	
	
		
			8.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			262 lines
		
	
	
	
		
			8.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
/*
 | 
						|
+--------------------------------------------------------------------+
 | 
						|
| CiviCRM version 4.7                                                |
 | 
						|
+--------------------------------------------------------------------+
 | 
						|
| Copyright CiviCRM LLC (c) 2004-2017                                |
 | 
						|
+--------------------------------------------------------------------+
 | 
						|
| This file is a part of CiviCRM.                                    |
 | 
						|
|                                                                    |
 | 
						|
| CiviCRM is free software; you can copy, modify, and distribute it  |
 | 
						|
| under the terms of the GNU Affero General Public License           |
 | 
						|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 | 
						|
|                                                                    |
 | 
						|
| CiviCRM is distributed in the hope that it will be useful, but     |
 | 
						|
| WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | 
						|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | 
						|
| See the GNU Affero General Public License for more details.        |
 | 
						|
|                                                                    |
 | 
						|
| You should have received a copy of the GNU Affero General Public   |
 | 
						|
| License and the CiviCRM Licensing Exception along                  |
 | 
						|
| with this program; if not, contact CiviCRM LLC                     |
 | 
						|
| at info[AT]civicrm[DOT]org. If you have questions about the        |
 | 
						|
| GNU Affero General Public License or the licensing of CiviCRM,     |
 | 
						|
| see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 | 
						|
+--------------------------------------------------------------------+
 | 
						|
*/
 | 
						|
/**
 | 
						|
 * @package CRM
 | 
						|
 * @copyright CiviCRM LLC (c) 2004-2017
 | 
						|
 *
 | 
						|
 * Generated from xml/schema/CRM/Mailing/Event/Queue.xml
 | 
						|
 * DO NOT EDIT.  Generated by CRM_Core_CodeGen
 | 
						|
 * (GenCodeChecksum:61df95ab05407c3c8fcd677a03e32b99)
 | 
						|
 */
 | 
						|
require_once 'CRM/Core/DAO.php';
 | 
						|
require_once 'CRM/Utils/Type.php';
 | 
						|
/**
 | 
						|
 * CRM_Mailing_Event_DAO_Queue constructor.
 | 
						|
 */
 | 
						|
class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO {
 | 
						|
  /**
 | 
						|
   * Static instance to hold the table name.
 | 
						|
   *
 | 
						|
   * @var string
 | 
						|
   */
 | 
						|
  static $_tableName = 'civicrm_mailing_event_queue';
 | 
						|
  /**
 | 
						|
   * Should CiviCRM log any modifications to this table in the civicrm_log table.
 | 
						|
   *
 | 
						|
   * @var boolean
 | 
						|
   */
 | 
						|
  static $_log = false;
 | 
						|
  /**
 | 
						|
   *
 | 
						|
   * @var int unsigned
 | 
						|
   */
 | 
						|
  public $id;
 | 
						|
  /**
 | 
						|
   * FK to Job
 | 
						|
   *
 | 
						|
   * @var int unsigned
 | 
						|
   */
 | 
						|
  public $job_id;
 | 
						|
  /**
 | 
						|
   * FK to Email
 | 
						|
   *
 | 
						|
   * @var int unsigned
 | 
						|
   */
 | 
						|
  public $email_id;
 | 
						|
  /**
 | 
						|
   * FK to Contact
 | 
						|
   *
 | 
						|
   * @var int unsigned
 | 
						|
   */
 | 
						|
  public $contact_id;
 | 
						|
  /**
 | 
						|
   * Security hash
 | 
						|
   *
 | 
						|
   * @var string
 | 
						|
   */
 | 
						|
  public $hash;
 | 
						|
  /**
 | 
						|
   * FK to Phone
 | 
						|
   *
 | 
						|
   * @var int unsigned
 | 
						|
   */
 | 
						|
  public $phone_id;
 | 
						|
  /**
 | 
						|
   * Class constructor.
 | 
						|
   */
 | 
						|
  function __construct() {
 | 
						|
    $this->__table = 'civicrm_mailing_event_queue';
 | 
						|
    parent::__construct();
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns foreign keys and entity references.
 | 
						|
   *
 | 
						|
   * @return array
 | 
						|
   *   [CRM_Core_Reference_Interface]
 | 
						|
   */
 | 
						|
  static function getReferenceColumns() {
 | 
						|
    if (!isset(Civi::$statics[__CLASS__]['links'])) {
 | 
						|
      Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 | 
						|
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'job_id', 'civicrm_mailing_job', 'id');
 | 
						|
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'email_id', 'civicrm_email', 'id');
 | 
						|
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 | 
						|
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'phone_id', 'civicrm_phone', 'id');
 | 
						|
      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 | 
						|
    }
 | 
						|
    return Civi::$statics[__CLASS__]['links'];
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns all the column names of this table
 | 
						|
   *
 | 
						|
   * @return array
 | 
						|
   */
 | 
						|
  static function &fields() {
 | 
						|
    if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 | 
						|
      Civi::$statics[__CLASS__]['fields'] = array(
 | 
						|
        'id' => array(
 | 
						|
          'name' => 'id',
 | 
						|
          'type' => CRM_Utils_Type::T_INT,
 | 
						|
          'title' => ts('Mailing Event Queue ID') ,
 | 
						|
          'required' => true,
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
        ) ,
 | 
						|
        'job_id' => array(
 | 
						|
          'name' => 'job_id',
 | 
						|
          'type' => CRM_Utils_Type::T_INT,
 | 
						|
          'title' => ts('Job ID') ,
 | 
						|
          'description' => 'FK to Job',
 | 
						|
          'required' => true,
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
          'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
 | 
						|
        ) ,
 | 
						|
        'email_id' => array(
 | 
						|
          'name' => 'email_id',
 | 
						|
          'type' => CRM_Utils_Type::T_INT,
 | 
						|
          'title' => ts('Email ID') ,
 | 
						|
          'description' => 'FK to Email',
 | 
						|
          'default' => 'NULL',
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
          'FKClassName' => 'CRM_Core_DAO_Email',
 | 
						|
        ) ,
 | 
						|
        'contact_id' => array(
 | 
						|
          'name' => 'contact_id',
 | 
						|
          'type' => CRM_Utils_Type::T_INT,
 | 
						|
          'title' => ts('Contact ID') ,
 | 
						|
          'description' => 'FK to Contact',
 | 
						|
          'required' => true,
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
          'FKClassName' => 'CRM_Contact_DAO_Contact',
 | 
						|
        ) ,
 | 
						|
        'hash' => array(
 | 
						|
          'name' => 'hash',
 | 
						|
          'type' => CRM_Utils_Type::T_STRING,
 | 
						|
          'title' => ts('Security Hash') ,
 | 
						|
          'description' => 'Security hash',
 | 
						|
          'required' => true,
 | 
						|
          'maxlength' => 255,
 | 
						|
          'size' => CRM_Utils_Type::HUGE,
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
        ) ,
 | 
						|
        'phone_id' => array(
 | 
						|
          'name' => 'phone_id',
 | 
						|
          'type' => CRM_Utils_Type::T_INT,
 | 
						|
          'title' => ts('Phone ID') ,
 | 
						|
          'description' => 'FK to Phone',
 | 
						|
          'default' => 'NULL',
 | 
						|
          'table_name' => 'civicrm_mailing_event_queue',
 | 
						|
          'entity' => 'Queue',
 | 
						|
          'bao' => 'CRM_Mailing_Event_BAO_Queue',
 | 
						|
          'localizable' => 0,
 | 
						|
          'FKClassName' => 'CRM_Core_DAO_Phone',
 | 
						|
        ) ,
 | 
						|
      );
 | 
						|
      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 | 
						|
    }
 | 
						|
    return Civi::$statics[__CLASS__]['fields'];
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Return a mapping from field-name to the corresponding key (as used in fields()).
 | 
						|
   *
 | 
						|
   * @return array
 | 
						|
   *   Array(string $name => string $uniqueName).
 | 
						|
   */
 | 
						|
  static function &fieldKeys() {
 | 
						|
    if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 | 
						|
      Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 | 
						|
    }
 | 
						|
    return Civi::$statics[__CLASS__]['fieldKeys'];
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns the names of this table
 | 
						|
   *
 | 
						|
   * @return string
 | 
						|
   */
 | 
						|
  static function getTableName() {
 | 
						|
    return self::$_tableName;
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns if this table needs to be logged
 | 
						|
   *
 | 
						|
   * @return boolean
 | 
						|
   */
 | 
						|
  function getLog() {
 | 
						|
    return self::$_log;
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns the list of fields that can be imported
 | 
						|
   *
 | 
						|
   * @param bool $prefix
 | 
						|
   *
 | 
						|
   * @return array
 | 
						|
   */
 | 
						|
  static function &import($prefix = false) {
 | 
						|
    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_queue', $prefix, array());
 | 
						|
    return $r;
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns the list of fields that can be exported
 | 
						|
   *
 | 
						|
   * @param bool $prefix
 | 
						|
   *
 | 
						|
   * @return array
 | 
						|
   */
 | 
						|
  static function &export($prefix = false) {
 | 
						|
    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_queue', $prefix, array());
 | 
						|
    return $r;
 | 
						|
  }
 | 
						|
  /**
 | 
						|
   * Returns the list of indices
 | 
						|
   */
 | 
						|
  public static function indices($localize = TRUE) {
 | 
						|
    $indices = array(
 | 
						|
      'index_hash' => array(
 | 
						|
        'name' => 'index_hash',
 | 
						|
        'field' => array(
 | 
						|
          0 => 'hash',
 | 
						|
        ) ,
 | 
						|
        'localizable' => false,
 | 
						|
        'sig' => 'civicrm_mailing_event_queue::0::hash',
 | 
						|
      ) ,
 | 
						|
    );
 | 
						|
    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 | 
						|
  }
 | 
						|
}
 |