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