templates/CRM/Custom/Form/Field.tpl

   1 {*
   2  +--------------------------------------------------------------------+
   3  | CiviCRM version 4.7                                                |
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC (c) 2004-2015                                |
   6  +--------------------------------------------------------------------+
   7  | This file is a part of CiviCRM.                                    |
   8  |                                                                    |
   9  | CiviCRM is free software; you can copy, modify, and distribute it  |
  10  | under the terms of the GNU Affero General Public License           |
  11  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  12  |                                                                    |
  13  | CiviCRM is distributed in the hope that it will be useful, but     |
  14  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  16  | See the GNU Affero General Public License for more details.        |
  17  |                                                                    |
  18  | You should have received a copy of the GNU Affero General Public   |
  19  | License and the CiviCRM Licensing Exception along                  |
  20  | with this program; if not, contact CiviCRM LLC                     |
  21  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  22  | GNU Affero General Public License or the licensing of CiviCRM,     |
  23  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  24  +--------------------------------------------------------------------+
  25 *}
  26 {*Javascript function controls showing and hiding of form elements based on html type.*}
  27 {literal}
  28 <script type="text/Javascript">
  29 function custom_option_html_type( ) {
  30     var html_type_name = document.getElementsByName("data_type[1]")[0].value;
  31     var data_type_id   = document.getElementsByName("data_type[0]")[0].value;
  32
  33     if ( !html_type_name && !data_type_id ) {
  34         return;
  35     }
  36
  37     if ( data_type_id == 11) {
  38       toggleContactRefFilter( );
  39     } else {
  40       cj('#field_advance_filter').hide();
  41       cj('#contact_reference_group').hide();
  42     }
  43
  44     if ( data_type_id < 4 ) {
  45         if ( html_type_name != "Text" ) {
  46             cj("#showoption").show();
  47             cj("#hideDefault").hide();
  48             cj("#hideDesc").hide();
  49             cj("#searchByRange").hide();
  50             cj("#searchable").show();
  51         } else {
  52             cj("#showoption").hide();
  53             cj("#hideDefault").show();
  54             cj("#hideDesc").show();
  55             cj("#searchable").show();
  56         }
  57     } else {
  58         if ( data_type_id == 9 ) {
  59             document.getElementById("default_value").value = '';
  60             cj("#hideDefault").hide();
  61             cj("#searchable").hide();
  62             cj("#hideDesc").hide();
  63         } else if ( data_type_id == 11 ) {
  64             cj("#hideDefault").hide();
  65         } else {
  66             cj("#hideDefault").show();
  67             cj("#searchable").show();
  68             cj("#hideDesc").show();
  69         }
  70         cj("#showoption").hide();
  71     }
  72
  73     var radioOption, checkBoxOption;
  74
  75     for ( var i=1; i<=11; i++) {
  76         radioOption = 'radio'+i;
  77         checkBoxOption = 'checkbox'+i
  78         if ( data_type_id < 4 ) {
  79             if ( html_type_name != "Text") {
  80                 if ( html_type_name == "CheckBox" || html_type_name == "Multi-Select") {
  81                     cj("#"+checkBoxOption).show();
  82                     cj("#"+radioOption).hide();
  83                 } else {
  84                     cj("#"+radioOption).show();
  85                     cj("#"+checkBoxOption).hide();
  86                 }
  87             }
  88         }
  89     }
  90
  91     if ( data_type_id < 4 ) {
  92         if (html_type_name == "CheckBox" || html_type_name == "Radio") {
  93             cj("#optionsPerLine").show();
  94         } else {
  95             cj("#optionsPerLine").hide();
  96         }
  97     }
  98
  99     if ( data_type_id == 5) {
 100         cj("#startDateRange").show();
 101         cj("#endDateRange").show();
 102         cj("#includedDatePart").show();
 103     } else {
 104         cj("#startDateRange").hide();
 105         cj("#endDateRange").hide();
 106         cj("#includedDatePart").hide();
 107     }
 108
 109     if ( data_type_id == 0 ) {
 110         cj("#textLength").show();
 111     } else {
 112         cj("#textLength").hide();
 113     }
 114
 115     if ( data_type_id == 4 ) {
 116         cj("#noteColumns").show();
 117         cj("#noteRows").show();
 118         cj("#noteLength").show();
 119     } else {
 120         cj("#noteColumns").hide();
 121         cj("#noteRows").hide();
 122         cj("#noteLength").hide();
 123     }
 124
 125     if ( data_type_id > 3) {
 126         cj("#optionsPerLine").hide();
 127     }
 128
 129     {/literal}{if $action eq 1}{literal}
 130     clearSearchBoxes( );
 131     {/literal}{/if}{literal}
 132 }
 133 </script>
 134 {/literal}
 135 <div class="crm-block crm-form-block crm-custom-field-form-block">
 136 <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"}</div>
 137     <table class="form-layout">
 138         <tr class="crm-custom-field-form-block-label">
 139             <td class="label">{$form.label.label}
 140             {if $action == 2}
 141                 {include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_custom_field' field='label' id=$id}
 142             {/if}
 143             </td>
 144             <td class="html-adjust">{$form.label.html}</td>
 145         </tr>
 146         <tr class="crm-custom-field-form-block-data_type">
 147             <td class="label">{$form.data_type.label}</td>
 148             <td class="html-adjust">{$form.data_type.html}
 149                 {if $action neq 4 and $action neq 2}
 150                     <br /><span class="description">{ts}Select the type of data you want to collect and store for this contact. Then select from the available HTML input field types (choices are based on the type of data being collected).{/ts}</span>
 151                 {/if}
 152     {if $action eq 2 and $changeFieldType}
 153     <br />
 154     <a class="action-item crm-hover-button" href='{crmURL p="civicrm/admin/custom/group/field/changetype" q="reset=1&id=`$id`"}'>
 155       <i class="crm-i fa-wrench"></i>
 156       {ts}Change Input Field Type{/ts}
 157     </a>
 158     <div class='clear'></div>
 159     {/if}
 160             </td>
 161         </tr>
 162        {if $form.in_selector}
 163        <tr class='crm-custom-field-form-block-in_selector'>
 164           <td class='label'>{$form.in_selector.label}</td>
 165           <td class='html-adjust'>{$form.in_selector.html} {help id="id-in_selector"}</td>
 166        </tr>
 167        {/if}
 168        <tr class="crm-custom-field-form-block-text_length"  id="textLength" {if !( $action eq 1 || $action eq 2 ) && ($form.data_type.value.0.0 != 0)}class="hiddenElement"{/if}>
 169             <td class="label">{$form.text_length.label}</td>
 170             <td class="html-adjust">{$form.text_length.html}</td>
 171         </tr>
 172
 173         <tr id='showoption' {if $action eq 1 or $action eq 2 }class="hiddenElement"{/if}>
 174             <td colspan="2">
 175             <table class="form-layout-compressed">
 176                 {* Conditionally show table for setting up selection options - for field types = radio, checkbox or select *}
 177                 {include file="CRM/Custom/Form/Optionfields.tpl"}
 178             </table>
 179             </td>
 180         </tr>
 181         <tr id='contact_reference_group'>
 182             <td class="label">{$form.group_id.label}</td>
 183             <td class="html-adjust">
 184               {$form.group_id.html}
 185             &nbsp;&nbsp;<span><a href="#" onclick="toggleContactRefFilter('Advance'); return false;">{ts}Advanced Filter{/ts}</a></span>
 186               {capture assign=searchPreferences}{crmURL p="civicrm/admin/setting/search" q="reset=1"}{/capture}
 187             <div class="messages status no-popup"><i class="crm-i fa-exclamation-triangle"></i> {ts 1=$searchPreferences}If you are planning on using this field in front-end profile, event registration or contribution forms, you should 'Limit List to Group' or configure an 'Advanced Filter'  (so that you do not unintentionally expose your entire set of contacts). Users must have either 'access contact reference fields' OR 'access CiviCRM' permission in order to use contact reference autocomplete fields. You can assign 'access contact reference fields' to the anonymous role if you want un-authenticated visitors to use this field. Use <a href='%1'>Search Preferences - Contact Reference Options</a> to control the fields included in the search results.{/ts}
 188           </td>
 189         </tr>
 190       <tr id='field_advance_filter'>
 191             <td class="label">{$form.filter.label}</td>
 192             <td class="html-adjust">
 193               {$form.filter.html}
 194               &nbsp;&nbsp;<span><a href="#" onclick="toggleContactRefFilter('Group'); return false;">{ts}Filter by Group{/ts}</a></span>
 195         <br />
 196         <span class="description">{ts}Filter contact search results for this field using Contact get API parameters. EXAMPLE: To list Students in group 3:{/ts} "action=get&group=3&contact_sub_type=Student" {docURL page="Using the API" resource="wiki"}</span>
 197             </td>
 198         </tr>
 199         <tr  class="crm-custom-field-form-block-options_per_line" id="optionsPerLine" {if $action neq 2 && ($form.data_type.value.0.0 >= 4 && $form.data_type.value.1.0 neq 'CheckBox' || $form.data_type.value.1.0 neq 'Radio' )}class="hiddenElement"{/if}>
 200             <td class="label">{$form.options_per_line.label}</td>
 201             <td class="html-adjust">{$form.options_per_line.html|crmAddClass:two}</td>
 202         </tr>
 203       <tr  class="crm-custom-field-form-block-start_date_years" id="startDateRange" {if $action neq 2 && ($form.data_type.value.0.0 != 5)}class="hiddenElement"{/if}>
 204             <td class="label">{$form.start_date_years.label}</td>
 205             <td class="html-adjust">{$form.start_date_years.html} {ts}years prior to current date.{/ts}</td>
 206         </tr>
 207         <tr class="crm-custom-field-form-block-end_date_years" id="endDateRange" {if $action neq 2 && ($form.data_type.value.0.0 != 5)}class="hiddenElement"{/if}>
 208             <td class="label">{$form.end_date_years.label}</td>
 209             <td class="html-adjust">{$form.end_date_years.html} {ts}years after the current date.{/ts}</td>
 210         </tr>
 211         <tr  class="crm-custom-field-form-block-date_format"  id="includedDatePart" {if $action neq 2 && ($form.data_type.value.0.0 != 5)}class="hiddenElement"{/if}>
 212             <td class="label">{$form.date_format.label}</td>
 213             <td class="html-adjust">{$form.date_format.html}&nbsp;&nbsp;&nbsp;{$form.time_format.label}&nbsp;&nbsp;{$form.time_format.html}</td>
 214         </tr>
 215         <tr  class="crm-custom-field-form-block-note_rows"  id="noteRows" {if $action neq 2 && ($form.data_type.value.0.0 != 4)}class="hiddenElement"{/if}>
 216             <td class="label">{$form.note_rows.label}</td>
 217             <td class="html-adjust">{$form.note_rows.html}</td>
 218         </tr>
 219       <tr class="crm-custom-field-form-block-note_columns" id="noteColumns" {if $action neq 2 && ($form.data_type.value.0.0 != 4)}class="hiddenElement"{/if}>
 220             <td class="label">{$form.note_columns.label}</td>
 221             <td class="html-adjust">{$form.note_columns.html}</td>
 222         </tr>
 223         <tr class="crm-custom-field-form-block-note_length" id="noteLength" {if $action neq 2 && ($form.data_type.value.0.0 != 4)}class="hiddenElement"{/if}>
 224             <td class="label">{$form.note_length.label}</td>
 225             <td class="html-adjust">{$form.note_length.html} <span class="description">{ts}Leave blank for unlimited. This limit is not implemented by all browsers and rich text editors.{/ts}</span></td>
 226         </tr>
 227         <tr class="crm-custom-field-form-block-weight" >
 228             <td class="label">{$form.weight.label}</td>
 229             <td>{$form.weight.html|crmAddClass:two}
 230                 {if $action neq 4}
 231                 <span class="description">{ts}Weight controls the order in which fields are displayed in a group. Enter a positive or negative integer - lower numbers are displayed ahead of higher numbers.{/ts}</span>
 232                 {/if}
 233             </td>
 234         </tr>
 235         <tr class="crm-custom-field-form-block-default_value" id="hideDefault" {if $action eq 2 && ($form.data_type.value.0.0 < 4 && $form.data_type.value.1.0 NEQ 'Text')}class="hiddenElement"{/if}>
 236             <td title="hideDefaultValTxt" class="label">{$form.default_value.label}</td>
 237             <td title="hideDefaultValDef" class="html-adjust">{$form.default_value.html}</td>
 238         </tr>
 239         <tr  class="crm-custom-field-form-block-description"  id="hideDesc" {if $action neq 4 && $action eq 2 && ($form.data_type.value.0.0 < 4 && $form.data_type.value.1.0 NEQ 'Text')}class="hiddenElement"{/if}>
 240             <td title="hideDescTxt" class="label">&nbsp;</td>
 241             <td title="hideDescDef" class="html-adjust"><span class="description">{ts}If you want to provide a default value for this field, enter it here. For date fields, format is YYYY-MM-DD.{/ts}</span></td>
 242         </tr>
 243         <tr class="crm-custom-field-form-block-help_pre">
 244             <td class="label">{$form.help_pre.label} {if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_custom_field' field='help_pre' id=$id}{/if}</td>
 245             <td class="html-adjust">{$form.help_pre.html|crmAddClass:huge}</td>
 246         </tr>
 247         <tr class="crm-custom-field-form-block-help_post">
 248             <td class="label">{$form.help_post.label} {if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_custom_field' field='help_post' id=$id}{/if}</td>
 249             <td class="html-adjust">{$form.help_post.html|crmAddClass:huge}
 250                 {if $action neq 4}
 251                     <span class="description">{ts}Explanatory text displayed on back-end forms. Pre help is displayed inline on the form (above the field). Post help is displayed in a pop-up - users click the help balloon to view help text.{/ts}</span>
 252                 {/if}
 253             </td>
 254         </tr>
 255         <tr class="crm-custom-field-form-block-is_required">
 256             <td class="label">{$form.is_required.label}</td>
 257             <td class="html-adjust">{$form.is_required.html}
 258             {if $action neq 4}
 259                 <br /><span class="description">{ts}Do not make custom fields required unless you want to force all users to enter a value anytime they add or edit this type of record. You can always make the field required when used in a specific Profile form.{/ts}</span>
 260             {/if}
 261             </td>
 262         </tr>
 263         <tr id ="searchable" class="crm-custom-field-form-block-is_searchable">
 264             <td class="label">{$form.is_searchable.label}</td>
 265             <td class="html-adjust">{$form.is_searchable.html}
 266                 {if $action neq 4}
 267                     <br /><span class="description">{ts}Can you search on this field in the Advanced and component search forms? Also determines whether you can include this field as a display column and / or filter in related detail reports.{/ts}</span>
 268                 {/if}
 269             </td>
 270         </tr>
 271         <tr id="searchByRange" class="crm-custom-field-form-block-is_search_range">
 272       <td class="label">{$form.is_search_range.label}</td>
 273             <td class="html-adjust">{$form.is_search_range.html}</td>
 274         </tr>
 275         <tr class="crm-custom-field-form-block-is_active">
 276             <td class="label">{$form.is_active.label}</td>
 277             <td class="html-adjust">{$form.is_active.html}</td>
 278         </tr>
 279         <tr class="crm-custom-field-form-block-is_view">
 280             <td class="label">{$form.is_view.label}</td>
 281             <td class="html-adjust">{$form.is_view.html}
 282                 <span class="description">{ts}Is this field set by PHP code (via a custom hook). This field will not be updated by CiviCRM.{/ts}</span>
 283             </td>
 284         </tr>
 285     </table>
 286          {if $action ne 4}
 287          <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>
 288       {else}
 289          <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>
 290       {/if} {* $action ne view *}
 291     </div>
 292 {literal}
 293 <script type="text/javascript">
 294   CRM.$(function($) {
 295     var $form = $('form.{/literal}{$form.formClass}{literal}'),
 296       deprecatedNotice;
 297     function deprecatedWidgets() {
 298       deprecatedNotice && deprecatedNotice.close && deprecatedNotice.close();
 299       switch ($('#data_type_1', $form).val()) {
 300         case 'AdvMulti-Select':
 301           deprecatedNotice = CRM.alert({/literal}'{ts escape="js"}The old "Advance Multi-Select" widget is being phased out and will be removed in a future version of CiviCRM. "Multi-Select" is the recommended substitute.{/ts}', '{ts escape="js"}Obsolete widget{/ts}'{literal}, 'alert', {expires: 0});
 302           break;
 303       }
 304     }
 305     $('#data_type_1', $form).each(deprecatedWidgets).change(deprecatedWidgets);
 306   });
 307
 308     //when page is reload, build show hide boxes
 309     //as per data type and html type selected.
 310     custom_option_html_type( );
 311
 312     function showSearchRange(chkbox) {
 313         var html_type = document.getElementsByName("data_type[1]")[0].value;
 314       var data_type = document.getElementsByName("data_type[0]")[0].value;
 315
 316         if ( ((data_type == 1 || data_type == 2 || data_type == 3) && (html_type == "Text")) || data_type == 5) {
 317             if (chkbox.checked) {
 318             document.getElementsByName("is_search_range")[0].checked = true;
 319                 cj("#searchByRange").show();
 320             } else {
 321                 clearSearchBoxes( );
 322             }
 323         }
 324     }
 325
 326     //should not clear search boxes for update mode.
 327     function clearSearchBoxes( ) {
 328       document.getElementsByName("is_searchable")[0].checked   = false;
 329       document.getElementsByName("is_search_range")[1].checked = true;
 330         cj("#searchByRange").hide();
 331     }
 332
 333     function toggleContactRefFilter(setSelected) {
 334       if ( !setSelected ) {
 335         setSelected =  cj('#filter_selected').val();
 336       } else {
 337         cj('#filter_selected').val(setSelected);
 338       }
 339       if ( setSelected == 'Advance' ) {
 340         cj('#contact_reference_group').hide( );
 341         cj('#field_advance_filter').show( );
 342       } else {
 343         cj('#field_advance_filter').hide( );
 344         cj('#contact_reference_group').show( );
 345       }
 346     }
 347 </script>
 348 {/literal}
 349 {* Give link to view/edit choice options if in edit mode and html_type is one of the multiple choice types *}
 350 {if $action eq 2 AND ($form.data_type.value.1.0 eq 'CheckBox' OR ($form.data_type.value.1.0 eq 'Radio' AND $form.data_type.value.0.0 neq 6) OR $form.data_type.value.1.0 eq 'Select' OR ($form.data_type.value.1.0 eq 'Multi-Select' AND $dontShowLink neq 1 ) ) }
 351     <div class="action-link">
 352       {crmButton p="civicrm/admin/custom/group/field/option" q="reset=1&action=browse&fid=`$id`&gid=`$gid`" icon="pencil"}{ts}View / Edit Multiple Choice Options{/ts}{/crmButton}
 353     </div>
 354 {/if}