CRM/Mailing/DAO/TrackableURL.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Mailing/TrackableURL.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:4e58345d210aa786e7653982fc998c37)
  10  */
  11
  12 /**
  13  * Database access object for the TrackableURL entity.
  14  */
  15 class CRM_Mailing_DAO_TrackableURL extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_mailing_trackable_url';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = FALSE;
  30
  31   /**
  32    * @var int
  33    */
  34   public $id;
  35
  36   /**
  37    * The URL to be tracked.
  38    *
  39    * @var text
  40    */
  41   public $url;
  42
  43   /**
  44    * FK to the mailing
  45    *
  46    * @var int
  47    */
  48   public $mailing_id;
  49
  50   /**
  51    * Class constructor.
  52    */
  53   public function __construct() {
  54     $this->__table = 'civicrm_mailing_trackable_url';
  55     parent::__construct();
  56   }
  57
  58   /**
  59    * Returns foreign keys and entity references.
  60    *
  61    * @return array
  62    *   [CRM_Core_Reference_Interface]
  63    */
  64   public static function getReferenceColumns() {
  65     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  66       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  67       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'mailing_id', 'civicrm_mailing', 'id');
  68       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  69     }
  70     return Civi::$statics[__CLASS__]['links'];
  71   }
  72
  73   /**
  74    * Returns all the column names of this table
  75    *
  76    * @return array
  77    */
  78   public static function &fields() {
  79     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  80       Civi::$statics[__CLASS__]['fields'] = [
  81         'id' => [
  82           'name' => 'id',
  83           'type' => CRM_Utils_Type::T_INT,
  84           'title' => ts('Trackable URL ID'),
  85           'required' => TRUE,
  86           'where' => 'civicrm_mailing_trackable_url.id',
  87           'table_name' => 'civicrm_mailing_trackable_url',
  88           'entity' => 'TrackableURL',
  89           'bao' => 'CRM_Mailing_BAO_TrackableURL',
  90           'localizable' => 0,
  91         ],
  92         'url' => [
  93           'name' => 'url',
  94           'type' => CRM_Utils_Type::T_TEXT,
  95           'title' => ts('Url'),
  96           'description' => ts('The URL to be tracked.'),
  97           'required' => TRUE,
  98           'where' => 'civicrm_mailing_trackable_url.url',
  99           'table_name' => 'civicrm_mailing_trackable_url',
 100           'entity' => 'TrackableURL',
 101           'bao' => 'CRM_Mailing_BAO_TrackableURL',
 102           'localizable' => 0,
 103         ],
 104         'mailing_id' => [
 105           'name' => 'mailing_id',
 106           'type' => CRM_Utils_Type::T_INT,
 107           'title' => ts('Mailing'),
 108           'description' => ts('FK to the mailing'),
 109           'required' => TRUE,
 110           'where' => 'civicrm_mailing_trackable_url.mailing_id',
 111           'table_name' => 'civicrm_mailing_trackable_url',
 112           'entity' => 'TrackableURL',
 113           'bao' => 'CRM_Mailing_BAO_TrackableURL',
 114           'localizable' => 0,
 115           'FKClassName' => 'CRM_Mailing_DAO_Mailing',
 116         ],
 117       ];
 118       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 119     }
 120     return Civi::$statics[__CLASS__]['fields'];
 121   }
 122
 123   /**
 124    * Return a mapping from field-name to the corresponding key (as used in fields()).
 125    *
 126    * @return array
 127    *   Array(string $name => string $uniqueName).
 128    */
 129   public static function &fieldKeys() {
 130     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 131       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 132     }
 133     return Civi::$statics[__CLASS__]['fieldKeys'];
 134   }
 135
 136   /**
 137    * Returns the names of this table
 138    *
 139    * @return string
 140    */
 141   public static function getTableName() {
 142     return self::$_tableName;
 143   }
 144
 145   /**
 146    * Returns if this table needs to be logged
 147    *
 148    * @return bool
 149    */
 150   public function getLog() {
 151     return self::$_log;
 152   }
 153
 154   /**
 155    * Returns the list of fields that can be imported
 156    *
 157    * @param bool $prefix
 158    *
 159    * @return array
 160    */
 161   public static function &import($prefix = FALSE) {
 162     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_trackable_url', $prefix, []);
 163     return $r;
 164   }
 165
 166   /**
 167    * Returns the list of fields that can be exported
 168    *
 169    * @param bool $prefix
 170    *
 171    * @return array
 172    */
 173   public static function &export($prefix = FALSE) {
 174     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_trackable_url', $prefix, []);
 175     return $r;
 176   }
 177
 178   /**
 179    * Returns the list of indices
 180    *
 181    * @param bool $localize
 182    *
 183    * @return array
 184    */
 185   public static function indices($localize = TRUE) {
 186     $indices = [];
 187     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 188   }
 189
 190 }