5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Mailing/TrackableURL.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:2eba75ecb9fc002adcc4a66cae55650a)
13 * Database access object for the TrackableURL entity.
15 class CRM_Mailing_DAO_TrackableURL
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '';
18 const COMPONENT
= 'CiviMail';
21 * Static instance to hold the table name.
25 public static $_tableName = 'civicrm_mailing_trackable_url';
28 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 public static $_log = FALSE;
35 * @var int|string|null
36 * (SQL type: int unsigned)
37 * Note that values will be retrieved from the database as a string.
42 * The URL to be tracked.
46 * Note that values will be retrieved from the database as a string.
54 * (SQL type: int unsigned)
55 * Note that values will be retrieved from the database as a string.
62 public function __construct() {
63 $this->__table
= 'civicrm_mailing_trackable_url';
64 parent
::__construct();
68 * Returns localized title of this entity.
71 * Whether to return the plural version of the title.
73 public static function getEntityTitle($plural = FALSE) {
74 return $plural ?
ts('Trackable URLs') : ts('Trackable URL');
78 * Returns foreign keys and entity references.
81 * [CRM_Core_Reference_Interface]
83 public 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(), 'mailing_id', 'civicrm_mailing', 'id');
87 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
89 return Civi
::$statics[__CLASS__
]['links'];
93 * Returns all the column names of this table
97 public static function &fields() {
98 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
99 Civi
::$statics[__CLASS__
]['fields'] = [
102 'type' => CRM_Utils_Type
::T_INT
,
103 'title' => ts('Trackable URL ID'),
105 'where' => 'civicrm_mailing_trackable_url.id',
106 'table_name' => 'civicrm_mailing_trackable_url',
107 'entity' => 'TrackableURL',
108 'bao' => 'CRM_Mailing_BAO_TrackableURL',
118 'type' => CRM_Utils_Type
::T_TEXT
,
119 'title' => ts('Url'),
120 'description' => ts('The URL to be tracked.'),
122 'where' => 'civicrm_mailing_trackable_url.url',
123 'table_name' => 'civicrm_mailing_trackable_url',
124 'entity' => 'TrackableURL',
125 'bao' => 'CRM_Mailing_BAO_TrackableURL',
130 'name' => 'mailing_id',
131 'type' => CRM_Utils_Type
::T_INT
,
132 'title' => ts('Mailing ID'),
133 'description' => ts('FK to the mailing'),
135 'where' => 'civicrm_mailing_trackable_url.mailing_id',
136 'table_name' => 'civicrm_mailing_trackable_url',
137 'entity' => 'TrackableURL',
138 'bao' => 'CRM_Mailing_BAO_TrackableURL',
140 'FKClassName' => 'CRM_Mailing_DAO_Mailing',
142 'label' => ts("Mailing"),
147 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
149 return Civi
::$statics[__CLASS__
]['fields'];
153 * Return a mapping from field-name to the corresponding key (as used in fields()).
156 * Array(string $name => string $uniqueName).
158 public static function &fieldKeys() {
159 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
160 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
162 return Civi
::$statics[__CLASS__
]['fieldKeys'];
166 * Returns the names of this table
170 public static function getTableName() {
171 return self
::$_tableName;
175 * Returns if this table needs to be logged
179 public function getLog() {
184 * Returns the list of fields that can be imported
186 * @param bool $prefix
190 public static function &import($prefix = FALSE) {
191 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_trackable_url', $prefix, []);
196 * Returns the list of fields that can be exported
198 * @param bool $prefix
202 public static function &export($prefix = FALSE) {
203 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_trackable_url', $prefix, []);
208 * Returns the list of indices
210 * @param bool $localize
214 public static function indices($localize = TRUE) {
216 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;