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/Friend/Friend.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
929a1c14 | 9 | * (GenCodeChecksum:3f1c976d43e312175e85da0427f5210d) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Friend entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Friend_DAO_Friend extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '2.0'; | |
c3fc2621 | 18 | |
e501603b | 19 | /** |
f41f0342 | 20 | * Static instance to hold the table name. |
e501603b TO |
21 | * |
22 | * @var string | |
23 | */ | |
fa45b5b9 | 24 | public static $_tableName = 'civicrm_tell_friend'; |
c3fc2621 | 25 | |
e501603b | 26 | /** |
f41f0342 | 27 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 28 | * |
c3fc2621 | 29 | * @var bool |
e501603b | 30 | */ |
fa45b5b9 | 31 | public static $_log = FALSE; |
c3fc2621 | 32 | |
e501603b TO |
33 | /** |
34 | * Friend ID | |
35 | * | |
e6ca0a57 | 36 | * @var int |
e501603b TO |
37 | */ |
38 | public $id; | |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * Name of table where item being referenced is stored. | |
42 | * | |
43 | * @var string | |
44 | */ | |
45 | public $entity_table; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * Foreign key to the referenced item. | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $entity_id; | |
c3fc2621 | 53 | |
e501603b | 54 | /** |
e501603b TO |
55 | * @var string |
56 | */ | |
57 | public $title; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Introductory message to contributor or participant displayed on the Tell a Friend form. | |
61 | * | |
62 | * @var text | |
63 | */ | |
64 | public $intro; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * Suggested message to friends, provided as default on the Tell A Friend form. | |
68 | * | |
69 | * @var text | |
70 | */ | |
71 | public $suggested_message; | |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * URL for general info about the organization - included in the email sent to friends. | |
75 | * | |
76 | * @var string | |
77 | */ | |
78 | public $general_link; | |
c3fc2621 | 79 | |
e501603b TO |
80 | /** |
81 | * Text for Tell a Friend thank you page header and HTML title. | |
82 | * | |
83 | * @var string | |
84 | */ | |
85 | public $thankyou_title; | |
c3fc2621 | 86 | |
e501603b TO |
87 | /** |
88 | * Thank you message displayed on success page. | |
89 | * | |
90 | * @var text | |
91 | */ | |
92 | public $thankyou_text; | |
c3fc2621 | 93 | |
e501603b | 94 | /** |
e6ca0a57 | 95 | * @var bool |
e501603b TO |
96 | */ |
97 | public $is_active; | |
c3fc2621 | 98 | |
e501603b | 99 | /** |
f41f0342 | 100 | * Class constructor. |
e501603b | 101 | */ |
c3fc2621 | 102 | public function __construct() { |
e501603b TO |
103 | $this->__table = 'civicrm_tell_friend'; |
104 | parent::__construct(); | |
105 | } | |
c3fc2621 | 106 | |
449c4e6b CW |
107 | /** |
108 | * Returns localized title of this entity. | |
109 | */ | |
110 | public static function getEntityTitle() { | |
111 | return ts('Friends'); | |
112 | } | |
113 | ||
e501603b | 114 | /** |
f41f0342 | 115 | * Returns foreign keys and entity references. |
e501603b TO |
116 | * |
117 | * @return array | |
118 | * [CRM_Core_Reference_Interface] | |
119 | */ | |
c3fc2621 | 120 | public static function getReferenceColumns() { |
346aaaba | 121 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 122 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 123 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); |
346aaaba | 124 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 125 | } |
346aaaba | 126 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 127 | } |
c3fc2621 | 128 | |
e501603b TO |
129 | /** |
130 | * Returns all the column names of this table | |
131 | * | |
132 | * @return array | |
133 | */ | |
c3fc2621 | 134 | public static function &fields() { |
346aaaba | 135 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
136 | Civi::$statics[__CLASS__]['fields'] = [ |
137 | 'id' => [ | |
e501603b TO |
138 | 'name' => 'id', |
139 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 140 | 'title' => ts('Friend ID'), |
215b423e | 141 | 'description' => ts('Friend ID'), |
c3fc2621 | 142 | 'required' => TRUE, |
a36434b9 | 143 | 'where' => 'civicrm_tell_friend.id', |
522a26c9 | 144 | 'table_name' => 'civicrm_tell_friend', |
145 | 'entity' => 'Friend', | |
146 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 147 | 'localizable' => 0, |
a9d0587b | 148 | 'add' => '2.0', |
c3fc2621 CW |
149 | ], |
150 | 'entity_table' => [ | |
e501603b TO |
151 | 'name' => 'entity_table', |
152 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 153 | 'title' => ts('Entity Table'), |
215b423e | 154 | 'description' => ts('Name of table where item being referenced is stored.'), |
c3fc2621 | 155 | 'required' => TRUE, |
e501603b TO |
156 | 'maxlength' => 64, |
157 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 158 | 'where' => 'civicrm_tell_friend.entity_table', |
522a26c9 | 159 | 'table_name' => 'civicrm_tell_friend', |
160 | 'entity' => 'Friend', | |
161 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 162 | 'localizable' => 0, |
a9d0587b | 163 | 'add' => '2.0', |
c3fc2621 CW |
164 | ], |
165 | 'entity_id' => [ | |
e501603b TO |
166 | 'name' => 'entity_id', |
167 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 168 | 'title' => ts('Entity ID'), |
215b423e | 169 | 'description' => ts('Foreign key to the referenced item.'), |
c3fc2621 | 170 | 'required' => TRUE, |
a36434b9 | 171 | 'where' => 'civicrm_tell_friend.entity_id', |
522a26c9 | 172 | 'table_name' => 'civicrm_tell_friend', |
173 | 'entity' => 'Friend', | |
174 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 175 | 'localizable' => 0, |
a9d0587b | 176 | 'add' => '2.0', |
c3fc2621 CW |
177 | ], |
178 | 'title' => [ | |
e501603b TO |
179 | 'name' => 'title', |
180 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 181 | 'title' => ts('Title'), |
e501603b TO |
182 | 'maxlength' => 255, |
183 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 184 | 'where' => 'civicrm_tell_friend.title', |
522a26c9 | 185 | 'table_name' => 'civicrm_tell_friend', |
186 | 'entity' => 'Friend', | |
187 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 188 | 'localizable' => 1, |
c3fc2621 | 189 | 'html' => [ |
e501603b | 190 | 'type' => 'Text', |
c3fc2621 | 191 | ], |
a9d0587b | 192 | 'add' => '2.0', |
c3fc2621 CW |
193 | ], |
194 | 'intro' => [ | |
e501603b TO |
195 | 'name' => 'intro', |
196 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 197 | 'title' => ts('Intro'), |
215b423e | 198 | 'description' => ts('Introductory message to contributor or participant displayed on the Tell a Friend form.'), |
a36434b9 | 199 | 'where' => 'civicrm_tell_friend.intro', |
522a26c9 | 200 | 'table_name' => 'civicrm_tell_friend', |
201 | 'entity' => 'Friend', | |
202 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 203 | 'localizable' => 1, |
c3fc2621 | 204 | 'html' => [ |
e501603b | 205 | 'type' => 'Text', |
c3fc2621 | 206 | ], |
a9d0587b | 207 | 'add' => '2.0', |
c3fc2621 CW |
208 | ], |
209 | 'suggested_message' => [ | |
e501603b TO |
210 | 'name' => 'suggested_message', |
211 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 212 | 'title' => ts('Suggested Message'), |
215b423e | 213 | 'description' => ts('Suggested message to friends, provided as default on the Tell A Friend form.'), |
a36434b9 | 214 | 'where' => 'civicrm_tell_friend.suggested_message', |
522a26c9 | 215 | 'table_name' => 'civicrm_tell_friend', |
216 | 'entity' => 'Friend', | |
217 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 218 | 'localizable' => 1, |
c3fc2621 | 219 | 'html' => [ |
e501603b | 220 | 'type' => 'Text', |
c3fc2621 | 221 | ], |
a9d0587b | 222 | 'add' => '2.0', |
c3fc2621 CW |
223 | ], |
224 | 'general_link' => [ | |
e501603b TO |
225 | 'name' => 'general_link', |
226 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 227 | 'title' => ts('General Link'), |
215b423e | 228 | 'description' => ts('URL for general info about the organization - included in the email sent to friends.'), |
e501603b TO |
229 | 'maxlength' => 255, |
230 | 'size' => CRM_Utils_Type::HUGE, | |
c3fc2621 | 231 | 'import' => TRUE, |
e501603b | 232 | 'where' => 'civicrm_tell_friend.general_link', |
c3fc2621 | 233 | 'export' => TRUE, |
522a26c9 | 234 | 'table_name' => 'civicrm_tell_friend', |
235 | 'entity' => 'Friend', | |
236 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 237 | 'localizable' => 0, |
c3fc2621 | 238 | 'html' => [ |
e501603b | 239 | 'type' => 'Text', |
c3fc2621 | 240 | ], |
a9d0587b | 241 | 'add' => '2.0', |
c3fc2621 CW |
242 | ], |
243 | 'thankyou_title' => [ | |
e501603b TO |
244 | 'name' => 'thankyou_title', |
245 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 246 | 'title' => ts('Thank You Title'), |
215b423e | 247 | 'description' => ts('Text for Tell a Friend thank you page header and HTML title.'), |
e501603b TO |
248 | 'maxlength' => 255, |
249 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 250 | 'where' => 'civicrm_tell_friend.thankyou_title', |
522a26c9 | 251 | 'table_name' => 'civicrm_tell_friend', |
252 | 'entity' => 'Friend', | |
253 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 254 | 'localizable' => 1, |
c3fc2621 | 255 | 'html' => [ |
e501603b | 256 | 'type' => 'Text', |
c3fc2621 | 257 | ], |
a9d0587b | 258 | 'add' => '2.0', |
c3fc2621 CW |
259 | ], |
260 | 'thankyou_text' => [ | |
e501603b TO |
261 | 'name' => 'thankyou_text', |
262 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 263 | 'title' => ts('Thank You Text'), |
215b423e | 264 | 'description' => ts('Thank you message displayed on success page.'), |
a36434b9 | 265 | 'where' => 'civicrm_tell_friend.thankyou_text', |
522a26c9 | 266 | 'table_name' => 'civicrm_tell_friend', |
267 | 'entity' => 'Friend', | |
268 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 269 | 'localizable' => 1, |
c3fc2621 | 270 | 'html' => [ |
e501603b | 271 | 'type' => 'Text', |
c3fc2621 | 272 | ], |
a9d0587b | 273 | 'add' => '2.0', |
c3fc2621 CW |
274 | ], |
275 | 'is_active' => [ | |
e501603b TO |
276 | 'name' => 'is_active', |
277 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 278 | 'title' => ts('Enabled?'), |
a36434b9 | 279 | 'where' => 'civicrm_tell_friend.is_active', |
522a26c9 | 280 | 'table_name' => 'civicrm_tell_friend', |
281 | 'entity' => 'Friend', | |
282 | 'bao' => 'CRM_Friend_BAO_Friend', | |
6a7e5e5d | 283 | 'localizable' => 0, |
c3fc2621 | 284 | 'html' => [ |
e501603b | 285 | 'type' => 'CheckBox', |
c3fc2621 | 286 | ], |
a9d0587b | 287 | 'add' => '2.0', |
c3fc2621 CW |
288 | ], |
289 | ]; | |
346aaaba | 290 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 291 | } |
346aaaba | 292 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 293 | } |
c3fc2621 | 294 | |
e501603b | 295 | /** |
bd8e0b14 | 296 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
297 | * |
298 | * @return array | |
bd8e0b14 | 299 | * Array(string $name => string $uniqueName). |
e501603b | 300 | */ |
c3fc2621 | 301 | public static function &fieldKeys() { |
bd8e0b14 TO |
302 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
303 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 304 | } |
bd8e0b14 | 305 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 306 | } |
c3fc2621 | 307 | |
e501603b TO |
308 | /** |
309 | * Returns the names of this table | |
310 | * | |
311 | * @return string | |
312 | */ | |
c3fc2621 | 313 | public static function getTableName() { |
e501603b TO |
314 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
315 | } | |
c3fc2621 | 316 | |
e501603b TO |
317 | /** |
318 | * Returns if this table needs to be logged | |
319 | * | |
c3fc2621 | 320 | * @return bool |
e501603b | 321 | */ |
c3fc2621 | 322 | public function getLog() { |
e501603b TO |
323 | return self::$_log; |
324 | } | |
c3fc2621 | 325 | |
e501603b TO |
326 | /** |
327 | * Returns the list of fields that can be imported | |
328 | * | |
329 | * @param bool $prefix | |
330 | * | |
331 | * @return array | |
332 | */ | |
c3fc2621 CW |
333 | public static function &import($prefix = FALSE) { |
334 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'tell_friend', $prefix, []); | |
60808919 | 335 | return $r; |
e501603b | 336 | } |
c3fc2621 | 337 | |
e501603b TO |
338 | /** |
339 | * Returns the list of fields that can be exported | |
340 | * | |
341 | * @param bool $prefix | |
342 | * | |
343 | * @return array | |
344 | */ | |
c3fc2621 CW |
345 | public static function &export($prefix = FALSE) { |
346 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'tell_friend', $prefix, []); | |
60808919 | 347 | return $r; |
e501603b | 348 | } |
c3fc2621 | 349 | |
e7a6b91a AS |
350 | /** |
351 | * Returns the list of indices | |
c3fc2621 CW |
352 | * |
353 | * @param bool $localize | |
354 | * | |
355 | * @return array | |
e7a6b91a AS |
356 | */ |
357 | public static function indices($localize = TRUE) { | |
c3fc2621 | 358 | $indices = []; |
e7a6b91a AS |
359 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
360 | } | |
c3fc2621 | 361 | |
e501603b | 362 | } |