3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 * Generated from schema_structure.tpl
18 * DO NOT EDIT. Generated by CRM_Core_CodeGen
20 class CRM_Core_I18n_SchemaStructure
{
23 * Get translatable columns.
26 * A table-indexed array of translatable columns.
28 public static function &columns() {
29 static $result = NULL;
32 'civicrm_location_type' => [
33 'display_name' => "varchar(64) COMMENT 'Location Type Display Name.'",
35 'civicrm_option_group' => [
36 'title' => "varchar(255) COMMENT 'Option Group title.'",
37 'description' => "varchar(255) COMMENT 'Option group description.'",
39 'civicrm_relationship_type' => [
40 'label_a_b' => "varchar(64) COMMENT 'label for relationship of contact_a to contact_b.'",
41 'label_b_a' => "varchar(64) COMMENT 'Optional label for relationship of contact_b to contact_a.'",
42 'description' => "varchar(255) COMMENT 'Optional verbose description of the relationship type.'",
44 'civicrm_contact_type' => [
45 'label' => "varchar(64) COMMENT 'localized Name of Contact Type.'",
46 'description' => "text COMMENT 'localized Optional verbose description of the type.'",
49 'title' => "varchar(255) COMMENT 'Friendly Name.'",
50 'description' => "text COMMENT 'Description of this batch set.'",
52 'civicrm_premiums' => [
53 'premiums_intro_title' => "varchar(255) COMMENT 'Title for Premiums section.'",
54 'premiums_intro_text' => "text COMMENT 'Displayed in <div> at top of Premiums section of page. Text and HTML allowed.'",
55 'premiums_nothankyou_label' => "varchar(255) COMMENT 'Label displayed for No Thank-you option in premiums block (e.g. No thank you)'",
57 'civicrm_membership_status' => [
58 'label' => "varchar(128) COMMENT 'Label for Membership Status'",
61 'title' => "varchar(255) NOT NULL COMMENT 'Title of the Survey.'",
62 'instructions' => "text COMMENT 'Script instructions for volunteers to use for the survey.'",
63 'thankyou_title' => "varchar(255) COMMENT 'Title for Thank-you page (header title tag, and display at the top of the page).'",
64 'thankyou_text' => "text COMMENT 'text and html allowed. displayed above result on success page'",
66 'civicrm_participant_status_type' => [
67 'label' => "varchar(255) COMMENT 'localized label for display of this status type'",
69 'civicrm_case_type' => [
70 'title' => "varchar(64) NOT NULL COMMENT 'Natural language name for Case Type'",
71 'description' => "varchar(255) COMMENT 'Description of the Case Type'",
73 'civicrm_tell_friend' => [
74 'title' => "varchar(255)",
75 'intro' => "text COMMENT 'Introductory message to contributor or participant displayed on the Tell a Friend form.'",
76 'suggested_message' => "text COMMENT 'Suggested message to friends, provided as default on the Tell A Friend form.'",
77 'thankyou_title' => "varchar(255) COMMENT 'Text for Tell a Friend thank you page header and HTML title.'",
78 'thankyou_text' => "text COMMENT 'Thank you message displayed on success page.'",
80 'civicrm_custom_group' => [
81 'title' => "varchar(64) NOT NULL COMMENT 'Friendly Name.'",
82 'help_pre' => "text COMMENT 'Description and/or help text to display before fields in form.'",
83 'help_post' => "text COMMENT 'Description and/or help text to display after fields in form.'",
85 'civicrm_custom_field' => [
86 'label' => "varchar(255) NOT NULL COMMENT 'Text for form field label (also friendly name for administering this custom property).'",
87 'help_pre' => "text COMMENT 'Description and/or help text to display before this field.'",
88 'help_post' => "text COMMENT 'Description and/or help text to display after this field.'",
90 'civicrm_option_value' => [
91 'label' => "varchar(512) NOT NULL COMMENT 'Option string as displayed to users - e.g. the label in an HTML OPTION tag.'",
92 'description' => "text COMMENT 'Optional description.'",
95 'title' => "varchar(255) NOT NULL COMMENT 'Name of Group.'",
96 'frontend_title' => "varchar(255) DEFAULT NULL COMMENT 'Alternative public title for this Group.'",
97 'frontend_description' => "text DEFAULT NULL COMMENT 'Alternative public description of the group.'",
99 'civicrm_contribution_page' => [
100 'title' => "varchar(255) COMMENT 'Contribution Page title. For top of page display'",
101 'intro_text' => "text COMMENT 'Text and html allowed. Displayed below title.'",
102 'pay_later_text' => "text COMMENT 'The text displayed to the user in the main form'",
103 'pay_later_receipt' => "text COMMENT 'The receipt sent to the user instead of the normal receipt text'",
104 'initial_amount_label' => "varchar(255) COMMENT 'Initial amount label for partial payment'",
105 'initial_amount_help_text' => "text COMMENT 'Initial amount help text for partial payment'",
106 'thankyou_title' => "varchar(255) COMMENT 'Title for Thank-you page (header title tag, and display at the top of the page).'",
107 'thankyou_text' => "text COMMENT 'text and html allowed. displayed above result on success page'",
108 'thankyou_footer' => "text COMMENT 'Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.'",
109 'receipt_from_name' => "varchar(255) COMMENT 'FROM email name used for receipts generated by contributions to this contribution page.'",
110 'receipt_text' => "text COMMENT 'text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now'",
111 'footer_text' => "text COMMENT 'Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.'",
112 'frontend_title' => "varchar(255) DEFAULT NULL COMMENT 'Contribution Page Public title'",
114 'civicrm_product' => [
115 'name' => "varchar(255) NOT NULL COMMENT 'Required product/premium name'",
116 'description' => "text COMMENT 'Optional description of the product/premium.'",
117 'options' => "text COMMENT 'Store comma-delimited list of color, size, etc. options for the product.'",
119 'civicrm_payment_processor' => [
120 'title' => "varchar(127) COMMENT 'Payment Processor Descriptive Name.'",
122 'civicrm_membership_type' => [
123 'name' => "varchar(128) NOT NULL COMMENT 'Name of Membership Type'",
124 'description' => "varchar(255) COMMENT 'Description of Membership Type'",
126 'civicrm_membership_block' => [
127 'new_title' => "varchar(255) COMMENT 'Title to display at top of block'",
128 'new_text' => "text COMMENT 'Text to display below title'",
129 'renewal_title' => "varchar(255) COMMENT 'Title for renewal'",
130 'renewal_text' => "text COMMENT 'Text to display for member renewal'",
132 'civicrm_price_set' => [
133 'title' => "varchar(255) NOT NULL COMMENT 'Displayed title for the Price Set.'",
134 'help_pre' => "text COMMENT 'Description and/or help text to display before fields in form.'",
135 'help_post' => "text COMMENT 'Description and/or help text to display after fields in form.'",
137 'civicrm_dashboard' => [
138 'label' => "varchar(255) COMMENT 'dashlet title'",
140 'civicrm_uf_group' => [
141 'title' => "varchar(64) NOT NULL COMMENT 'Form title.'",
142 'frontend_title' => "varchar(64) COMMENT 'Profile Form Public title'",
143 'help_pre' => "text COMMENT 'Description and/or help text to display before fields in form.'",
144 'help_post' => "text COMMENT 'Description and/or help text to display after fields in form.'",
145 'cancel_button_text' => "varchar(64) DEFAULT NULL COMMENT 'Custom Text to display on the Cancel button when used in create or edit mode'",
146 'submit_button_text' => "varchar(64) DEFAULT NULL COMMENT 'Custom Text to display on the submit button on profile edit/create screens'",
148 'civicrm_uf_field' => [
149 'help_post' => "text COMMENT 'Description and/or help text to display after this field.'",
150 'help_pre' => "text COMMENT 'Description and/or help text to display before this field.'",
151 'label' => "varchar(255) NOT NULL COMMENT 'To save label for fields.'",
153 'civicrm_price_field' => [
154 'label' => "varchar(255) NOT NULL COMMENT 'Text for form field label (also friendly name for administering this field).'",
155 'help_pre' => "text COMMENT 'Description and/or help text to display before this field.'",
156 'help_post' => "text COMMENT 'Description and/or help text to display after this field.'",
158 'civicrm_price_field_value' => [
159 'label' => "varchar(255) DEFAULT NULL COMMENT 'Price field option label'",
160 'description' => "text DEFAULT NULL COMMENT 'Price field option description.'",
161 'help_pre' => "text DEFAULT NULL COMMENT 'Price field option pre help text.'",
162 'help_post' => "text DEFAULT NULL COMMENT 'Price field option post field help.'",
164 'civicrm_pcp_block' => [
165 'link_text' => "varchar(255) DEFAULT NULL COMMENT 'Link text for PCP.'",
168 'title' => "varchar(255) COMMENT 'Event Title (e.g. Fall Fundraiser Dinner)'",
169 'summary' => "text COMMENT 'Brief summary of event. Text and html allowed. Displayed on Event Registration form and can be used on other CMS pages which need an event summary.'",
170 'description' => "text COMMENT 'Full description of event. Text and html allowed. Displayed on built-in Event Information screens.'",
171 'registration_link_text' => "varchar(255) COMMENT 'Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.'",
172 'event_full_text' => "text COMMENT 'Message to display on Event Information page and INSTEAD OF Event Registration form if maximum participants are signed up. Can include email address/info about getting on a waiting list, etc. Text and html allowed.'",
173 'fee_label' => "varchar(255)",
174 'intro_text' => "text COMMENT 'Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.'",
175 'footer_text' => "text COMMENT 'Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.'",
176 'confirm_title' => "varchar(255) DEFAULT NULL COMMENT 'Title for Confirmation page.'",
177 'confirm_text' => "text COMMENT 'Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.'",
178 'confirm_footer_text' => "text COMMENT 'Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.'",
179 'confirm_email_text' => "text COMMENT 'text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now'",
180 'confirm_from_name' => "varchar(255) COMMENT 'FROM email name used for confirmation emails.'",
181 'thankyou_title' => "varchar(255) DEFAULT NULL COMMENT 'Title for ThankYou page.'",
182 'thankyou_text' => "text COMMENT 'ThankYou Text.'",
183 'thankyou_footer_text' => "text COMMENT 'Footer message.'",
184 'pay_later_text' => "text COMMENT 'The text displayed to the user in the main form'",
185 'pay_later_receipt' => "text COMMENT 'The receipt sent to the user instead of the normal receipt text'",
186 'initial_amount_label' => "varchar(255) COMMENT 'Initial amount label for partial payment'",
187 'initial_amount_help_text' => "text COMMENT 'Initial amount help text for partial payment'",
188 'waitlist_text' => "text COMMENT 'Text to display when the event is full, but participants can signup for a waitlist.'",
189 'approval_req_text' => "text COMMENT 'Text to display when the approval is required to complete registration for an event.'",
190 'template_title' => "varchar(255) COMMENT 'Event Template Title'",
198 * Get a table indexed array of the indices for translatable fields.
201 * Indices for translatable fields.
203 public static function &indices() {
204 static $result = NULL;
207 'civicrm_custom_group' => [
208 'UI_title_extends' => [
209 'name' => 'UI_title_extends',
217 'civicrm_custom_field' => [
218 'UI_label_custom_group_id' => [
219 'name' => 'UI_label_custom_group_id',
229 'name' => 'UI_title',
242 * Get tables with translatable fields.
245 * Array of names of tables with fields that can be translated.
247 public static function &tables() {
248 static $result = NULL;
250 $result = array_keys(self
::columns());
256 * Get a list of widgets for editing translatable fields.
259 * Array of the widgets for editing translatable fields.
261 public static function &widgets() {
262 static $result = NULL;
265 'civicrm_location_type' => [
270 'civicrm_option_group' => [
278 'civicrm_relationship_type' => [
289 'civicrm_contact_type' => [
294 'type' => "TextArea",
304 'type' => "TextArea",
309 'civicrm_premiums' => [
310 'premiums_intro_title' => [
313 'premiums_intro_text' => [
316 'premiums_nothankyou_label' => [
320 'civicrm_membership_status' => [
325 'civicrm_survey' => [
328 'required' => "true",
331 'type' => "TextArea",
335 'thankyou_title' => [
339 'type' => "TextArea",
344 'civicrm_participant_status_type' => [
349 'civicrm_case_type' => [
352 'required' => "true",
358 'civicrm_tell_friend' => [
365 'suggested_message' => [
368 'thankyou_title' => [
375 'civicrm_custom_group' => [
378 'required' => "true",
381 'type' => "TextArea",
386 'type' => "TextArea",
391 'civicrm_custom_field' => [
394 'required' => "true",
403 'civicrm_option_value' => [
406 'required' => "true",
409 'type' => "TextArea",
417 'required' => "true",
419 'frontend_title' => [
422 'frontend_description' => [
423 'type' => "TextArea",
428 'civicrm_contribution_page' => [
433 'type' => "RichTextEditor",
437 'pay_later_text' => [
440 'pay_later_receipt' => [
443 'initial_amount_label' => [
446 'initial_amount_help_text' => [
449 'thankyou_title' => [
453 'type' => "RichTextEditor",
457 'thankyou_footer' => [
458 'type' => "RichTextEditor",
462 'receipt_from_name' => [
466 'type' => "TextArea",
471 'type' => "RichTextEditor",
475 'frontend_title' => [
479 'civicrm_product' => [
482 'required' => "true",
491 'civicrm_payment_processor' => [
496 'civicrm_membership_type' => [
500 'required' => "true",
503 'type' => "TextArea",
506 'label' => "Description",
509 'civicrm_membership_block' => [
523 'civicrm_price_set' => [
526 'required' => "true",
529 'type' => "TextArea",
534 'type' => "TextArea",
539 'civicrm_dashboard' => [
544 'civicrm_uf_group' => [
547 'required' => "true",
549 'frontend_title' => [
553 'type' => "TextArea",
558 'type' => "TextArea",
562 'cancel_button_text' => [
565 'submit_button_text' => [
569 'civicrm_uf_field' => [
578 'required' => "true",
581 'civicrm_price_field' => [
584 'required' => "true",
587 'type' => "TextArea",
592 'type' => "TextArea",
597 'civicrm_price_field_value' => [
602 'type' => "TextArea",
607 'type' => "TextArea",
612 'type' => "TextArea",
617 'civicrm_pcp_block' => [
627 'type' => "TextArea",
632 'type' => "RichTextEditor",
636 'registration_link_text' => [
639 'event_full_text' => [
640 'type' => "TextArea",
648 'type' => "RichTextEditor",
653 'type' => "RichTextEditor",
661 'type' => "RichTextEditor",
665 'confirm_footer_text' => [
666 'type' => "RichTextEditor",
670 'confirm_email_text' => [
671 'type' => "TextArea",
675 'confirm_from_name' => [
678 'thankyou_title' => [
682 'type' => "RichTextEditor",
686 'thankyou_footer_text' => [
687 'type' => "RichTextEditor",
691 'pay_later_text' => [
692 'type' => "RichTextEditor",
694 'pay_later_receipt' => [
697 'initial_amount_label' => [
700 'initial_amount_help_text' => [
704 'type' => "TextArea",
708 'approval_req_text' => [
709 'type' => "TextArea",
713 'template_title' => [