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/Core/Website.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
7b66c3b5 | 9 | * (GenCodeChecksum:1d9c6cf4e3d809a3b3f5963ccb189e83) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Website entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Website extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '3.2'; | |
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_website'; |
c3fc2621 | 25 | |
449c4e6b CW |
26 | /** |
27 | * Icon associated with this entity. | |
28 | * | |
29 | * @var string | |
30 | */ | |
31 | public static $_icon = 'fa-desktop'; | |
32 | ||
e501603b | 33 | /** |
f41f0342 | 34 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 35 | * |
c3fc2621 | 36 | * @var bool |
e501603b | 37 | */ |
fa45b5b9 | 38 | public static $_log = FALSE; |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * Unique Website ID | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * FK to Contact ID | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $contact_id; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * Website | |
56 | * | |
57 | * @var string | |
58 | */ | |
59 | public $url; | |
c3fc2621 | 60 | |
e501603b TO |
61 | /** |
62 | * Which Website type does this website belong to. | |
63 | * | |
e6ca0a57 | 64 | * @var int |
e501603b TO |
65 | */ |
66 | public $website_type_id; | |
c3fc2621 | 67 | |
e501603b | 68 | /** |
f41f0342 | 69 | * Class constructor. |
e501603b | 70 | */ |
c3fc2621 | 71 | public function __construct() { |
e501603b TO |
72 | $this->__table = 'civicrm_website'; |
73 | parent::__construct(); | |
74 | } | |
c3fc2621 | 75 | |
449c4e6b CW |
76 | /** |
77 | * Returns localized title of this entity. | |
7b66c3b5 AH |
78 | * |
79 | * @param bool $plural | |
80 | * Whether to return the plural version of the title. | |
449c4e6b | 81 | */ |
7b66c3b5 AH |
82 | public static function getEntityTitle($plural = FALSE) { |
83 | return $plural ? ts('Websites') : ts('Website'); | |
449c4e6b CW |
84 | } |
85 | ||
e501603b | 86 | /** |
f41f0342 | 87 | * Returns foreign keys and entity references. |
e501603b TO |
88 | * |
89 | * @return array | |
90 | * [CRM_Core_Reference_Interface] | |
91 | */ | |
c3fc2621 | 92 | public static function getReferenceColumns() { |
346aaaba | 93 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 94 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 95 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); |
346aaaba | 96 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 97 | } |
346aaaba | 98 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 99 | } |
c3fc2621 | 100 | |
e501603b TO |
101 | /** |
102 | * Returns all the column names of this table | |
103 | * | |
104 | * @return array | |
105 | */ | |
c3fc2621 | 106 | public static function &fields() { |
346aaaba | 107 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
108 | Civi::$statics[__CLASS__]['fields'] = [ |
109 | 'id' => [ | |
e501603b TO |
110 | 'name' => 'id', |
111 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 112 | 'title' => ts('Website ID'), |
215b423e | 113 | 'description' => ts('Unique Website ID'), |
c3fc2621 | 114 | 'required' => TRUE, |
a36434b9 | 115 | 'where' => 'civicrm_website.id', |
522a26c9 | 116 | 'table_name' => 'civicrm_website', |
117 | 'entity' => 'Website', | |
118 | 'bao' => 'CRM_Core_BAO_Website', | |
6a7e5e5d | 119 | 'localizable' => 0, |
a9d0587b | 120 | 'add' => '3.2', |
c3fc2621 CW |
121 | ], |
122 | 'contact_id' => [ | |
e501603b TO |
123 | 'name' => 'contact_id', |
124 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 125 | 'title' => ts('Contact'), |
215b423e | 126 | 'description' => ts('FK to Contact ID'), |
a36434b9 | 127 | 'where' => 'civicrm_website.contact_id', |
522a26c9 | 128 | 'table_name' => 'civicrm_website', |
129 | 'entity' => 'Website', | |
130 | 'bao' => 'CRM_Core_BAO_Website', | |
6a7e5e5d | 131 | 'localizable' => 0, |
e501603b | 132 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 133 | 'add' => '3.2', |
c3fc2621 CW |
134 | ], |
135 | 'url' => [ | |
e501603b TO |
136 | 'name' => 'url', |
137 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 138 | 'title' => ts('Website'), |
215b423e | 139 | 'description' => ts('Website'), |
e501603b TO |
140 | 'maxlength' => 128, |
141 | 'size' => 30, | |
c3fc2621 | 142 | 'import' => TRUE, |
e501603b TO |
143 | 'where' => 'civicrm_website.url', |
144 | 'headerPattern' => '/Website/i', | |
145 | 'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/', | |
c3fc2621 | 146 | 'export' => TRUE, |
522a26c9 | 147 | 'table_name' => 'civicrm_website', |
148 | 'entity' => 'Website', | |
149 | 'bao' => 'CRM_Core_BAO_Website', | |
6a7e5e5d | 150 | 'localizable' => 0, |
c3fc2621 | 151 | 'html' => [ |
e501603b | 152 | 'type' => 'Text', |
c3fc2621 | 153 | ], |
a9d0587b | 154 | 'add' => '3.2', |
c3fc2621 CW |
155 | ], |
156 | 'website_type_id' => [ | |
e501603b TO |
157 | 'name' => 'website_type_id', |
158 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 159 | 'title' => ts('Website Type'), |
215b423e | 160 | 'description' => ts('Which Website type does this website belong to.'), |
a36434b9 | 161 | 'where' => 'civicrm_website.website_type_id', |
522a26c9 | 162 | 'table_name' => 'civicrm_website', |
163 | 'entity' => 'Website', | |
164 | 'bao' => 'CRM_Core_BAO_Website', | |
6a7e5e5d | 165 | 'localizable' => 0, |
c3fc2621 | 166 | 'html' => [ |
e501603b | 167 | 'type' => 'Select', |
c3fc2621 CW |
168 | ], |
169 | 'pseudoconstant' => [ | |
e501603b TO |
170 | 'optionGroupName' => 'website_type', |
171 | 'optionEditPath' => 'civicrm/admin/options/website_type', | |
e6ca0a57 | 172 | ], |
a9d0587b | 173 | 'add' => '3.2', |
c3fc2621 CW |
174 | ], |
175 | ]; | |
346aaaba | 176 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 177 | } |
346aaaba | 178 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 179 | } |
c3fc2621 | 180 | |
e501603b | 181 | /** |
bd8e0b14 | 182 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
183 | * |
184 | * @return array | |
bd8e0b14 | 185 | * Array(string $name => string $uniqueName). |
e501603b | 186 | */ |
c3fc2621 | 187 | public static function &fieldKeys() { |
bd8e0b14 TO |
188 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
189 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 190 | } |
bd8e0b14 | 191 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 192 | } |
c3fc2621 | 193 | |
e501603b TO |
194 | /** |
195 | * Returns the names of this table | |
196 | * | |
197 | * @return string | |
198 | */ | |
c3fc2621 | 199 | public static function getTableName() { |
e501603b TO |
200 | return self::$_tableName; |
201 | } | |
c3fc2621 | 202 | |
e501603b TO |
203 | /** |
204 | * Returns if this table needs to be logged | |
205 | * | |
c3fc2621 | 206 | * @return bool |
e501603b | 207 | */ |
c3fc2621 | 208 | public function getLog() { |
e501603b TO |
209 | return self::$_log; |
210 | } | |
c3fc2621 | 211 | |
e501603b TO |
212 | /** |
213 | * Returns the list of fields that can be imported | |
214 | * | |
215 | * @param bool $prefix | |
216 | * | |
217 | * @return array | |
218 | */ | |
c3fc2621 CW |
219 | public static function &import($prefix = FALSE) { |
220 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'website', $prefix, []); | |
60808919 | 221 | return $r; |
e501603b | 222 | } |
c3fc2621 | 223 | |
e501603b TO |
224 | /** |
225 | * Returns the list of fields that can be exported | |
226 | * | |
227 | * @param bool $prefix | |
228 | * | |
229 | * @return array | |
230 | */ | |
c3fc2621 CW |
231 | public static function &export($prefix = FALSE) { |
232 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'website', $prefix, []); | |
60808919 | 233 | return $r; |
e501603b | 234 | } |
c3fc2621 | 235 | |
e7a6b91a AS |
236 | /** |
237 | * Returns the list of indices | |
c3fc2621 CW |
238 | * |
239 | * @param bool $localize | |
240 | * | |
241 | * @return array | |
e7a6b91a AS |
242 | */ |
243 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
244 | $indices = [ |
245 | 'UI_website_type_id' => [ | |
e7a6b91a | 246 | 'name' => 'UI_website_type_id', |
c3fc2621 | 247 | 'field' => [ |
e7a6b91a | 248 | 0 => 'website_type_id', |
c3fc2621 CW |
249 | ], |
250 | 'localizable' => FALSE, | |
e7a6b91a | 251 | 'sig' => 'civicrm_website::0::website_type_id', |
c3fc2621 CW |
252 | ], |
253 | ]; | |
e7a6b91a AS |
254 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
255 | } | |
c3fc2621 | 256 | |
e501603b | 257 | } |