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(64) COMMENT 'Name of Group.'",
97 'civicrm_contribution_page' => [
98 'title' => "varchar(255) COMMENT 'Contribution Page title. For top of page display'",
99 'intro_text' => "text COMMENT 'Text and html allowed. Displayed below title.'",
100 'pay_later_text' => "text COMMENT 'The text displayed to the user in the main form'",
101 'pay_later_receipt' => "text COMMENT 'The receipt sent to the user instead of the normal receipt text'",
102 'initial_amount_label' => "varchar(255) COMMENT 'Initial amount label for partial payment'",
103 'initial_amount_help_text' => "text COMMENT 'Initial amount help text for partial payment'",
104 'thankyou_title' => "varchar(255) COMMENT 'Title for Thank-you page (header title tag, and display at the top of the page).'",
105 'thankyou_text' => "text COMMENT 'text and html allowed. displayed above result on success page'",
106 '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.'",
107 'receipt_from_name' => "varchar(255) COMMENT 'FROM email name used for receipts generated by contributions to this contribution page.'",
108 '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'",
109 'footer_text' => "text COMMENT 'Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.'",
110 'frontend_title' => "varchar(255) DEFAULT NULL COMMENT 'Contribution Page Public title'",
112 'civicrm_product' => [
113 'name' => "varchar(255) NOT NULL COMMENT 'Required product/premium name'",
114 'description' => "text COMMENT 'Optional description of the product/premium.'",
115 'options' => "text COMMENT 'Store comma-delimited list of color, size, etc. options for the product.'",
117 'civicrm_payment_processor' => [
118 'title' => "varchar(127) COMMENT 'Payment Processor Descriptive Name.'",
120 'civicrm_membership_type' => [
121 'name' => "varchar(128) COMMENT 'Name of Membership Type'",
122 'description' => "varchar(255) COMMENT 'Description of Membership Type'",
124 'civicrm_membership_block' => [
125 'new_title' => "varchar(255) COMMENT 'Title to display at top of block'",
126 'new_text' => "text COMMENT 'Text to display below title'",
127 'renewal_title' => "varchar(255) COMMENT 'Title for renewal'",
128 'renewal_text' => "text COMMENT 'Text to display for member renewal'",
130 'civicrm_price_set' => [
131 'title' => "varchar(255) NOT NULL COMMENT 'Displayed title for the Price Set.'",
132 'help_pre' => "text COMMENT 'Description and/or help text to display before fields in form.'",
133 'help_post' => "text COMMENT 'Description and/or help text to display after fields in form.'",
135 'civicrm_dashboard' => [
136 'label' => "varchar(255) COMMENT 'dashlet title'",
138 'civicrm_uf_group' => [
139 'title' => "varchar(64) NOT NULL COMMENT 'Form title.'",
140 'frontend_title' => "varchar(64) COMMENT 'Profile Form Public title'",
141 'help_pre' => "text COMMENT 'Description and/or help text to display before fields in form.'",
142 'help_post' => "text COMMENT 'Description and/or help text to display after fields in form.'",
143 'cancel_button_text' => "varchar(64) DEFAULT NULL COMMENT 'Custom Text to display on the Cancel button when used in create or edit mode'",
144 'submit_button_text' => "varchar(64) DEFAULT NULL COMMENT 'Custom Text to display on the submit button on profile edit/create screens'",
146 'civicrm_uf_field' => [
147 'help_post' => "text COMMENT 'Description and/or help text to display after this field.'",
148 'help_pre' => "text COMMENT 'Description and/or help text to display before this field.'",
149 'label' => "varchar(255) NOT NULL COMMENT 'To save label for fields.'",
151 'civicrm_price_field' => [
152 'label' => "varchar(255) NOT NULL COMMENT 'Text for form field label (also friendly name for administering this field).'",
153 'help_pre' => "text COMMENT 'Description and/or help text to display before this field.'",
154 'help_post' => "text COMMENT 'Description and/or help text to display after this field.'",
156 'civicrm_price_field_value' => [
157 'label' => "varchar(255) COMMENT 'Price field option label'",
158 'description' => "text DEFAULT NULL COMMENT 'Price field option description.'",
159 'help_pre' => "text DEFAULT NULL COMMENT 'Price field option pre help text.'",
160 'help_post' => "text DEFAULT NULL COMMENT 'Price field option post field help.'",
162 'civicrm_pcp_block' => [
163 'link_text' => "varchar(255) DEFAULT NULL COMMENT 'Link text for PCP.'",
166 'title' => "varchar(255) COMMENT 'Event Title (e.g. Fall Fundraiser Dinner)'",
167 '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.'",
168 'description' => "text COMMENT 'Full description of event. Text and html allowed. Displayed on built-in Event Information screens.'",
169 '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.'",
170 '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.'",
171 'fee_label' => "varchar(255)",
172 'intro_text' => "text COMMENT 'Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.'",
173 'footer_text' => "text COMMENT 'Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.'",
174 'confirm_title' => "varchar(255) DEFAULT NULL COMMENT 'Title for Confirmation page.'",
175 'confirm_text' => "text COMMENT 'Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.'",
176 'confirm_footer_text' => "text COMMENT 'Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.'",
177 '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'",
178 'confirm_from_name' => "varchar(255) COMMENT 'FROM email name used for confirmation emails.'",
179 'thankyou_title' => "varchar(255) DEFAULT NULL COMMENT 'Title for ThankYou page.'",
180 'thankyou_text' => "text COMMENT 'ThankYou Text.'",
181 'thankyou_footer_text' => "text COMMENT 'Footer message.'",
182 'pay_later_text' => "text COMMENT 'The text displayed to the user in the main form'",
183 'pay_later_receipt' => "text COMMENT 'The receipt sent to the user instead of the normal receipt text'",
184 'initial_amount_label' => "varchar(255) COMMENT 'Initial amount label for partial payment'",
185 'initial_amount_help_text' => "text COMMENT 'Initial amount help text for partial payment'",
186 'waitlist_text' => "text COMMENT 'Text to display when the event is full, but participants can signup for a waitlist.'",
187 'approval_req_text' => "text COMMENT 'Text to display when the approval is required to complete registration for an event.'",
188 'template_title' => "varchar(255) COMMENT 'Event Template Title'",
196 * Get a table indexed array of the indices for translatable fields.
199 * Indices for translatable fields.
201 public static function &indices() {
202 static $result = NULL;
205 'civicrm_custom_group' => [
206 'UI_title_extends' => [
207 'name' => 'UI_title_extends',
215 'civicrm_custom_field' => [
216 'UI_label_custom_group_id' => [
217 'name' => 'UI_label_custom_group_id',
227 'name' => 'UI_title',
240 * Get tables with translatable fields.
243 * Array of names of tables with fields that can be translated.
245 public static function &tables() {
246 static $result = NULL;
248 $result = array_keys(self
::columns());
254 * Get a list of widgets for editing translatable fields.
257 * Array of the widgets for editing translatable fields.
259 public static function &widgets() {
260 static $result = NULL;
263 'civicrm_location_type' => [
268 'civicrm_option_group' => [
276 'civicrm_relationship_type' => [
287 'civicrm_contact_type' => [
292 'type' => "TextArea",
302 'type' => "TextArea",
307 'civicrm_premiums' => [
308 'premiums_intro_title' => [
311 'premiums_intro_text' => [
314 'premiums_nothankyou_label' => [
318 'civicrm_membership_status' => [
323 'civicrm_survey' => [
326 'required' => "true",
329 'type' => "TextArea",
333 'thankyou_title' => [
337 'type' => "TextArea",
342 'civicrm_participant_status_type' => [
347 'civicrm_case_type' => [
350 'required' => "true",
356 'civicrm_tell_friend' => [
363 'suggested_message' => [
366 'thankyou_title' => [
373 'civicrm_custom_group' => [
376 'required' => "true",
379 'type' => "TextArea",
384 'type' => "TextArea",
389 'civicrm_custom_field' => [
392 'required' => "true",
401 'civicrm_option_value' => [
404 'required' => "true",
407 'type' => "TextArea",
417 'civicrm_contribution_page' => [
422 'type' => "RichTextEditor",
426 'pay_later_text' => [
429 'pay_later_receipt' => [
432 'initial_amount_label' => [
435 'initial_amount_help_text' => [
438 'thankyou_title' => [
442 'type' => "RichTextEditor",
446 'thankyou_footer' => [
447 'type' => "RichTextEditor",
451 'receipt_from_name' => [
455 'type' => "TextArea",
460 'type' => "RichTextEditor",
464 'frontend_title' => [
468 'civicrm_product' => [
471 'required' => "true",
480 'civicrm_payment_processor' => [
485 'civicrm_membership_type' => [
491 'type' => "TextArea",
494 'label' => "Description",
497 'civicrm_membership_block' => [
511 'civicrm_price_set' => [
514 'required' => "true",
517 'type' => "TextArea",
522 'type' => "TextArea",
527 'civicrm_dashboard' => [
532 'civicrm_uf_group' => [
535 'required' => "true",
537 'frontend_title' => [
541 'type' => "TextArea",
546 'type' => "TextArea",
550 'cancel_button_text' => [
553 'submit_button_text' => [
557 'civicrm_uf_field' => [
566 'required' => "true",
569 'civicrm_price_field' => [
572 'required' => "true",
575 'type' => "TextArea",
580 'type' => "TextArea",
585 'civicrm_price_field_value' => [
590 'type' => "TextArea",
595 'type' => "TextArea",
600 'type' => "TextArea",
605 'civicrm_pcp_block' => [
615 'type' => "TextArea",
620 'type' => "RichTextEditor",
624 'registration_link_text' => [
627 'event_full_text' => [
628 'type' => "TextArea",
636 'type' => "RichTextEditor",
641 'type' => "RichTextEditor",
649 'type' => "RichTextEditor",
653 'confirm_footer_text' => [
654 'type' => "RichTextEditor",
658 'confirm_email_text' => [
659 'type' => "TextArea",
663 'confirm_from_name' => [
666 'thankyou_title' => [
670 'type' => "RichTextEditor",
674 'thankyou_footer_text' => [
675 'type' => "RichTextEditor",
679 'pay_later_text' => [
680 'type' => "RichTextEditor",
682 'pay_later_receipt' => [
685 'initial_amount_label' => [
688 'initial_amount_help_text' => [
692 'type' => "TextArea",
696 'approval_req_text' => [
697 'type' => "TextArea",
701 'template_title' => [