1 // https://civicrm.org/licensing
4 var cj
= CRM
.$ = jQuery
;
8 * Short-named function for string translation, defined in global scope so it's available everywhere.
10 * @param text string for translating
11 * @param params object key:value of additional parameters
15 function ts(text
, params
) {
17 var d
= (params
&& params
.domain
) ? ('strings::' + params
.domain
) : null;
18 if (d
&& CRM
[d
] && CRM
[d
][text
]) {
21 else if (CRM
.strings
[text
]) {
22 text
= CRM
.strings
[text
];
24 if (typeof(params
) === 'object') {
25 for (var i
in params
) {
26 if (typeof(params
[i
]) === 'string' || typeof(params
[i
]) === 'number') {
27 // sprintf emulation: escape % characters in the replacements to avoid conflicts
28 text
= text
.replace(new RegExp('%' + i
, 'g'), String(params
[i
]).replace(/%/g
, '%-crmescaped-'));
31 return text
.replace(/%-crmescaped-/g, '%');
36 // Legacy code - ignore warnings
37 /* jshint ignore:start */
40 * This function is called by default at the bottom of template files which have forms that have
41 * conditionally displayed/hidden sections and elements. The PHP is responsible for generating
42 * a list of 'blocks to show' and 'blocks to hide' and the template passes these parameters to
46 * @param showBlocks Array of element Id's to be displayed
47 * @param hideBlocks Array of element Id's to be hidden
48 * @param elementType Value to set display style to for showBlocks (e.g. 'block' or 'table-row' or ...)
50 function on_load_init_blocks(showBlocks
, hideBlocks
, elementType
) {
51 if (elementType
== null) {
52 elementType
= 'block';
57 /* This loop is used to display the blocks whose IDs are present within the showBlocks array */
58 for (i
= 0; i
< showBlocks
.length
; i
++) {
59 myElement
= document
.getElementById(showBlocks
[i
]);
60 /* getElementById returns null if element id doesn't exist in the document */
61 if (myElement
!= null) {
62 myElement
.style
.display
= elementType
;
65 alert('showBlocks array item not in .tpl = ' + showBlocks
[i
]);
69 /* This loop is used to hide the blocks whose IDs are present within the hideBlocks array */
70 for (i
= 0; i
< hideBlocks
.length
; i
++) {
71 myElement
= document
.getElementById(hideBlocks
[i
]);
72 /* getElementById returns null if element id doesn't exist in the document */
73 if (myElement
!= null) {
74 myElement
.style
.display
= 'none';
77 alert('showBlocks array item not in .tpl = ' + hideBlocks
[i
]);
83 * This function is called when we need to show or hide a related form element (target_element)
84 * based on the value (trigger_value) of another form field (trigger_field).
87 * @param trigger_field_id HTML id of field whose onchange is the trigger
88 * @param trigger_value List of integers - option value(s) which trigger show-element action for target_field
89 * @param target_element_id HTML id of element to be shown or hidden
90 * @param target_element_type Type of element to be shown or hidden ('block' or 'table-row')
91 * @param field_type Type of element radio/select
92 * @param invert Boolean - if true, we HIDE target on value match; if false, we SHOW target on value match
94 function showHideByValue(trigger_field_id
, trigger_value
, target_element_id
, target_element_type
, field_type
, invert
) {
97 if (field_type
== 'select') {
98 var trigger
= trigger_value
.split("|");
99 var selectedOptionValue
= cj('#' + trigger_field_id
).val();
101 target
= target_element_id
.split("|");
102 for (j
= 0; j
< target
.length
; j
++) {
104 cj('#' + target
[j
]).show();
107 cj('#' + target
[j
]).hide();
109 for (var i
= 0; i
< trigger
.length
; i
++) {
110 if (selectedOptionValue
== trigger
[i
]) {
112 cj('#' + target
[j
]).hide();
115 cj('#' + target
[j
]).show();
123 if (field_type
== 'radio') {
124 target
= target_element_id
.split("|");
125 for (j
= 0; j
< target
.length
; j
++) {
126 if (cj('[name="' + trigger_field_id
+ '"]:first').is(':checked')) {
128 cj('#' + target
[j
]).hide();
131 cj('#' + target
[j
]).show();
136 cj('#' + target
[j
]).show();
139 cj('#' + target
[j
]).hide();
148 * Function to change button text and disable one it is clicked
150 * @param obj object - the button clicked
151 * @param formID string - the id of the form being submitted
152 * @param string procText - button text after user clicks it
156 /* Changes button label on submit, and disables button after submit for newer browsers.
157 Puts up alert for older browsers. */
158 function submitOnce(obj
, formId
, procText
) {
159 // if named button clicked, change text
160 if (obj
.value
!= null) {
161 cj('input[name=' + obj
.name
+ ']').val(procText
+ " ...");
163 cj(obj
).closest('form').attr('data-warn-changes', 'false');
164 if (document
.getElementById
) { // disable submit button for newer browsers
165 cj('input[name=' + obj
.name
+ ']').attr("disabled", true);
166 document
.getElementById(formId
).submit();
169 else { // for older browsers
170 if (submitcount
== 0) {
175 alert("Your request is currently being processed ... Please wait.");
182 * Function to show / hide the row in optionFields
184 * @param index string, element whose innerHTML is to hide else will show the hidden row.
186 function showHideRow(index
) {
188 cj('tr#optionField_' + index
).hide();
189 if (cj('table#optionField tr:hidden:first').length
) {
190 cj('div#optionFieldLink').show();
194 cj('table#optionField tr:hidden:first').show();
195 if (!cj('table#optionField tr:hidden:last').length
) {
196 cj('div#optionFieldLink').hide();
202 /* jshint ignore:end */
204 if (!CRM
.utils
) CRM
.utils
= {};
205 if (!CRM
.strings
) CRM
.strings
= {};
206 if (!CRM
.vars
) CRM
.vars
= {};
208 (function ($, _
, undefined) {
210 /* jshint validthis: true */
212 // Theme classes for unattached elements
213 $.fn
.select2
.defaults
.dropdownCssClass
= $.ui
.dialog
.prototype.options
.dialogClass
= 'crm-container';
215 // https://github.com/ivaynberg/select2/pull/2090
216 $.fn
.select2
.defaults
.width
= 'resolve';
218 // Workaround for https://github.com/ivaynberg/select2/issues/1246
219 $.ui
.dialog
.prototype._allowInteraction = function(e
) {
220 return !!$(e
.target
).closest('.ui-dialog, .ui-datepicker, .select2-drop, .cke_dialog, #civicrm-menu').length
;
223 // Implements jQuery hook.prop
224 $.propHooks
.disabled
= {
225 set: function (el
, value
, name
) {
226 // Sync button enabled status with wrapper css
227 if ($(el
).is('span.crm-button > input.crm-form-submit')) {
228 $(el
).parent().toggleClass('crm-button-disabled', !!value
);
230 // Sync button enabled status with dialog button
231 if ($(el
).is('.ui-dialog input.crm-form-submit')) {
232 $(el
).closest('.ui-dialog').find('.ui-dialog-buttonset button[data-identifier='+ $(el
).attr('name') +']').prop('disabled', value
);
234 if ($(el
).is('.crm-form-date-wrapper .crm-hidden-date')) {
235 $(el
).siblings().prop('disabled', value
);
240 var scriptsLoaded
= {};
241 CRM
.loadScript = function(url
) {
242 if (!scriptsLoaded
[url
]) {
243 var script
= document
.createElement('script');
244 scriptsLoaded
[url
] = $.Deferred();
245 script
.onload = function () {
246 scriptsLoaded
[url
].resolve();
249 document
.getElementsByTagName("head")[0].appendChild(script
);
251 return scriptsLoaded
[url
];
255 * Populate a select list, overwriting the existing options except for the placeholder.
256 * @param select jquery selector - 1 or more select elements
257 * @param options array in format returned by api.getoptions
258 * @param placeholder string|bool - new placeholder or false (default) to keep the old one
259 * @param value string|array - will silently update the element with new value without triggering change
261 CRM
.utils
.setOptions = function(select
, options
, placeholder
, value
) {
262 $(select
).each(function() {
265 val
= value
|| $elect
.val() || [],
266 opts
= placeholder
|| placeholder
=== '' ? '' : '[value!=""]';
267 $elect
.find('option' + opts
).remove();
268 var newOptions
= CRM
.utils
.renderOptions(options
, val
);
269 if (typeof placeholder
=== 'string') {
270 if ($elect
.is('[multiple]')) {
271 select
.attr('placeholder', placeholder
);
273 newOptions
= '<option value="">' + placeholder
+ '</option>' + newOptions
;
276 $elect
.append(newOptions
);
278 $elect
.trigger('crmOptionsUpdated', $.extend({}, options
)).trigger('change');
284 * Render an option list
285 * @param options {array}
286 * @param val {string} default value
287 * @param escapeHtml {bool}
290 CRM
.utils
.renderOptions = function(options
, val
, escapeHtml
) {
292 esc
= escapeHtml
=== false ? _
.identity
: _
.escape
;
293 if (!$.isArray(val
)) {
296 _
.each(options
, function(option
) {
297 if (option
.children
) {
298 rendered
+= '<optgroup label="' + esc(option
.value
) + '">' +
299 CRM
.utils
.renderOptions(option
.children
, val
) +
302 var selected
= ($.inArray('' + option
.key
, val
) > -1) ? 'selected="selected"' : '';
303 rendered
+= '<option value="' + esc(option
.key
) + '"' + selected
+ '>' + esc(option
.value
) + '</option>';
309 function chainSelect() {
310 var $form
= $(this).closest('form'),
311 $target
= $('select[data-name="' + $(this).data('target') + '"]', $form
),
312 data
= $target
.data(),
314 $target
.prop('disabled', true);
315 if ($target
.is('select.crm-chain-select-control')) {
316 $('select[data-name="' + $target
.data('target') + '"]', $form
).prop('disabled', true).blur();
318 if (!(val
&& val
.length
)) {
319 CRM
.utils
.setOptions($target
.blur(), [], data
.emptyPrompt
);
321 $target
.addClass('loading');
322 $.getJSON(CRM
.url(data
.callback
), {_value
: val
}, function(vals
) {
323 $target
.prop('disabled', false).removeClass('loading');
324 CRM
.utils
.setOptions($target
, vals
|| [], (vals
&& vals
.length
? data
.selectPrompt
: data
.nonePrompt
));
330 * Compare Form Input values against cached initial value.
332 * @return {Boolean} true if changes have been made.
334 CRM
.utils
.initialValueChanged = function(el
) {
336 $(':input:visible, .select2-container:visible+:input:hidden', el
).not('[type=submit], [type=button], .crm-action-menu, :disabled').each(function () {
338 initialValue
= $(this).data('crm-initial-value'),
339 currentValue
= $(this).is(':checkbox, :radio') ? $(this).prop('checked') : $(this).val();
340 // skip change of value for submit buttons
341 if (initialValue
!== undefined && !_
.isEqual(initialValue
, currentValue
)) {
349 * This provides defaults for ui.dialog which either need to be calculated or are different from global defaults
354 CRM
.utils
.adjustDialogDefaults = function(settings
) {
355 settings
= $.extend({width
: '65%', height
: '65%', modal
: true}, settings
|| {});
356 // Support relative height
357 if (typeof settings
.height
=== 'string' && settings
.height
.indexOf('%') > 0) {
358 settings
.height
= parseInt($(window
).height() * (parseFloat(settings
.height
)/100), 10);
360 // Responsive adjustment - increase percent width on small screens
361 if (typeof settings
.width
=== 'string' && settings
.width
.indexOf('%') > 0) {
362 var screenWidth
= $(window
).width(),
363 percentage
= parseInt(settings
.width
.replace('%', ''), 10),
364 gap
= 100-percentage
;
365 if (screenWidth
< 701) {
366 settings
.width
= '100%';
368 else if (screenWidth
< 1400) {
369 settings
.width
= '' + parseInt(percentage
+gap
-((screenWidth
- 700)/7*(gap)/100), 10) + '%';
375 function formatCrmSelect2(row
) {
376 var icon
= row
.icon
|| $(row
.element
).data('icon'),
377 color
= row
.color
|| $(row
.element
).data('color'),
378 description
= row
.description
|| $(row
.element
).data('description'),
381 ret
+= '<i class="crm-i ' + icon
+ '"></i> ';
384 ret
+= '<span class="crm-select-item-color" style="background-color: ' + color
+ '"></span> ';
386 return ret
+ _
.escape(row
.text
) + (description
? '<div class="crm-select2-row-description"><p>' + _
.escape(description
) + '</p></div>' : '');
390 * Wrapper for select2 initialization function; supplies defaults
391 * @param options object
393 $.fn
.crmSelect2 = function(options
) {
394 if (options
=== 'destroy') {
395 return $(this).each(function() {
397 .removeClass('crm-ajax-select')
401 return $(this).each(function () {
406 allowClear
: !$el
.hasClass('required'),
407 formatResult
: formatCrmSelect2
,
408 formatSelection
: formatCrmSelect2
410 // quickform doesn't support optgroups so here's a hack :(
411 $('option[value^=crm_optgroup]', this).each(function () {
412 $(this).nextUntil('option[value^=crm_optgroup]').wrapAll('<optgroup label="' + $(this).text() + '" />');
416 // quickform does not support disabled option, so yet another hack to
417 // add disabled property for option values
418 $('option[value^=crm_disabled_opt]', this).attr('disabled', 'disabled');
420 // Placeholder icon - total hack hikacking the escapeMarkup function but select2 3.5 dosn't have any other callbacks for this :(
421 if ($el
.is('[class*=fa-]')) {
422 settings
.escapeMarkup = function (m
) {
423 var out
= _
.escape(m
),
424 placeholder
= settings
.placeholder
|| $el
.data('placeholder') || $el
.attr('placeholder') || $('option[value=""]', $el
).text();
425 if (m
.length
&& placeholder
=== m
) {
426 iconClass
= $el
.attr('class').match(/(fa-\S*)/)[1];
427 out
= '<i class="crm-i ' + iconClass
+ '"></i> ' + out
;
433 // Defaults for single-selects
434 if ($el
.is('select:not([multiple])')) {
435 settings
.minimumResultsForSearch
= 10;
436 if ($('option:first', this).val() === '') {
437 settings
.placeholderOption
= 'first';
440 $.extend(settings
, $el
.data('select-params') || {}, options
|| {});
442 $el
.addClass('crm-ajax-select');
444 $el
.select2(settings
);
449 * @see CRM_Core_Form::addEntityRef for docs
450 * @param options object
452 $.fn
.crmEntityRef = function(options
) {
453 if (options
=== 'destroy') {
454 return $(this).each(function() {
455 var entity
= $(this).data('api-entity') || '';
458 .removeClass('crm-form-entityref crm-' + entity
.toLowerCase() + '-ref')
459 .crmSelect2('destroy');
462 options
= options
|| {};
463 options
.select
= options
.select
|| {};
464 return $(this).each(function() {
466 $el
= $(this).off('.crmEntity'),
467 entity
= options
.entity
|| $el
.data('api-entity') || 'contact',
469 $el
.data('api-entity', entity
);
470 $el
.data('select-params', $.extend({}, $el
.data('select-params') || {}, options
.select
));
471 $el
.data('api-params', $.extend(true, {}, $el
.data('api-params') || {}, options
.api
));
472 $el
.data('create-links', options
.create
|| $el
.data('create-links'));
473 $el
.addClass('crm-form-entityref crm-' + entity
.toLowerCase() + '-ref');
475 // Use select2 ajax helper instead of CRM.api3 because it provides more value
477 url
: CRM
.url('civicrm/ajax/rest'),
479 data: function (input
, page_num
) {
480 var params
= getEntityRefApiParams($el
);
481 params
.input
= input
;
482 params
.page_num
= page_num
;
484 entity
: $el
.data('api-entity'),
486 json
: JSON
.stringify(params
)
489 results: function(data
) {
490 return {more
: data
.more_results
, results
: data
.values
|| []};
493 minimumInputLength
: 1,
494 formatResult
: CRM
.utils
.formatSelect2Result
,
495 formatSelection
: formatEntityRefSelection
,
496 escapeMarkup
: _
.identity
,
497 initSelection: function($el
, callback
) {
499 multiple
= !!$el
.data('select-params').multiple
,
501 stored
= $el
.data('entity-value') || [];
505 // If we already have this data, just return it
506 if (!_
.xor(val
.split(','), _
.pluck(stored
, 'id')).length
) {
507 callback(multiple
? stored
: stored
[0]);
509 var params
= $.extend({}, $el
.data('api-params') || {}, {id
: val
});
510 CRM
.api3($el
.data('api-entity'), 'getlist', params
).done(function(result
) {
511 callback(multiple
? result
.values
: result
.values
[0]);
512 // Trigger change (store data to avoid an infinite loop of lookups)
513 $el
.data('entity-value', result
.values
).trigger('change');
518 // Create new items inline - works for tags
519 if ($el
.data('create-links') && entity
.toLowerCase() === 'tag') {
520 selectParams
.createSearchChoice = function(term
, data
) {
521 if (!_
.findKey(data
, {label
: term
})) {
522 return {id
: "0", term
: term
, label
: term
+ ' (' + ts('new tag') + ')'};
525 selectParams
.tokenSeparators
= [','];
526 selectParams
.createSearchChoicePosition
= 'bottom';
527 $el
.on('select2-selecting.crmEntity', function(e
) {
530 e
.object
.label
= e
.object
.term
;
531 CRM
.api3(entity
, 'create', $.extend({name
: e
.object
.term
}, $el
.data('api-params').params
|| {}))
532 .done(function(created
) {
534 val
= $el
.select2('val'),
535 data
= $el
.select2('data'),
536 item
= {id
: created
.id
, label
: e
.object
.term
};
538 $el
.select2('data', item
, true);
540 else if ($.isArray(val
) && $.inArray("0", val
) > -1) {
541 _
.remove(data
, {id
: "0"});
543 $el
.select2('data', data
, true);
550 selectParams
.formatInputTooShort = function() {
551 var txt
= $el
.data('select-params').formatInputTooShort
|| $.fn
.select2
.defaults
.formatInputTooShort
.call(this);
552 txt
+= entityRefFiltersMarkup($el
) + renderEntityRefCreateLinks($el
);
555 selectParams
.formatNoMatches = function() {
556 var txt
= $el
.data('select-params').formatNoMatches
|| $.fn
.select2
.defaults
.formatNoMatches
;
557 txt
+= entityRefFiltersMarkup($el
) + renderEntityRefCreateLinks($el
);
560 $el
.on('select2-open.crmEntity', function() {
562 renderEntityRefFilterValue($el
);
565 .on('click.crmEntity', 'a.crm-add-entity', function(e
) {
566 var extra
= $el
.data('api-params').extra
,
567 formUrl
= $(this).attr('href') + '&returnExtra=display_name,sort_name' + (extra
? (',' + extra
) : '');
568 $el
.select2('close');
569 CRM
.loadForm(formUrl
, {
570 dialog
: {width
: 500, height
: 220}
571 }).on('crmFormSuccess', function(e
, data
) {
572 if (data
.status
=== 'success' && data
.id
) {
573 data
.label
= data
.extra
.sort_name
;
574 CRM
.status(ts('%1 Created', {1: data
.extra
.display_name
}));
575 if ($el
.select2('container').hasClass('select2-container-multi')) {
576 var selection
= $el
.select2('data');
577 selection
.push(data
);
578 $el
.select2('data', selection
, true);
580 $el
.select2('data', data
, true);
586 .on('change.crmEntity', '.crm-entityref-filter-value', function() {
587 var filter
= $el
.data('user-filter') || {};
588 filter
.value
= $(this).val();
589 $(this).toggleClass('active', !!filter
.value
);
590 $el
.data('user-filter', filter
);
592 // Once a filter has been chosen, rerender create links and refocus the search box
593 $el
.select2('close');
596 $('.crm-entityref-links', '#select2-drop').replaceWith(renderEntityRefCreateLinks($el
));
599 .on('change.crmEntity', 'select.crm-entityref-filter-key', function() {
600 var filter
= {key
: $(this).val()};
601 $(this).toggleClass('active', !!filter
.key
);
602 $el
.data('user-filter', filter
);
603 renderEntityRefFilterValue($el
);
604 $('.crm-entityref-filter-key', '#select2-drop').focus();
608 $el
.crmSelect2($.extend(settings
, $el
.data('select-params'), selectParams
));
613 * Combine api-params with user-filter
617 function getEntityRefApiParams($el
) {
619 params
= $.extend({params
: {}}, $el
.data('api-params') || {}),
620 // Prevent original data from being modified - $.extend and _.clone don't cut it, they pass nested objects by reference!
621 combined
= _
.cloneDeep(params
),
622 filter
= $.extend({}, $el
.data('user-filter') || {});
623 if (filter
.key
&& filter
.value
) {
624 // Fieldname may be prefixed with joins
625 var fieldName
= _
.last(filter
.key
.split('.'));
626 // Special case for contact type/sub-type combo
627 if (fieldName
=== 'contact_type' && (filter
.value
.indexOf('__') > 0)) {
628 combined
.params
[filter
.key
] = filter
.value
.split('__')[0];
629 combined
.params
[filter
.key
.replace('contact_type', 'contact_sub_type')] = filter
.value
.split('__')[1];
631 // Allow json-encoded api filters e.g. {"BETWEEN":[123,456]}
632 combined
.params
[filter
.key
] = filter
.value
.charAt(0) === '{' ? $.parseJSON(filter
.value
) : filter
.value
;
638 function copyAttributes($source
, $target
, attributes
) {
639 _
.each(attributes
, function(name
) {
640 if ($source
.attr(name
) !== undefined) {
641 $target
.attr(name
, $source
.attr(name
));
647 * @see http://wiki.civicrm.org/confluence/display/CRMDOC/crmDatepicker
649 $.fn
.crmDatepicker = function(options
) {
650 return $(this).each(function() {
651 if ($(this).is('.crm-form-date-wrapper .crm-hidden-date')) {
652 // Already initialized - destroy
654 .off('.crmDatepicker')
656 .removeClass('crm-hidden-date')
657 .siblings().remove();
660 if (options
=== 'destroy') {
664 $dataField
= $(this).wrap('<span class="crm-form-date-wrapper" />'),
665 settings
= _
.cloneDeep(options
|| {}),
669 hasDatepicker
= settings
.date
!== false && settings
.date
!== 'yy',
670 type
= hasDatepicker
? 'text' : 'number';
672 if (settings
.allowClear
!== undefined ? settings
.allowClear
: !$dataField
.is('.required, [required]')) {
673 $clearLink
= $('<a class="crm-hover-button crm-clear-link" title="'+ _
.escape(ts('Clear')) +'"><i class="crm-i fa-times"></i></a>')
674 .insertAfter($dataField
);
676 if (settings
.time
!== false) {
677 $timeField
= $('<input>').insertAfter($dataField
);
678 copyAttributes($dataField
, $timeField
, ['class', 'disabled']);
680 .addClass('crm-form-text crm-form-time')
681 .attr('placeholder', $dataField
.attr('time-placeholder') === undefined ? ts('Time') : $dataField
.attr('time-placeholder'))
682 .change(updateDataField
)
685 show24Hours
: settings
.time
=== true || settings
.time
=== undefined ? CRM
.config
.timeIs24Hr
: settings
.time
== '24'
688 if (settings
.date
!== false) {
689 // Render "number" field for year-only format, calendar popup for all other formats
690 $dateField
= $('<input type="' + type
+ '">').insertAfter($dataField
);
691 copyAttributes($dataField
, $dateField
, ['placeholder', 'style', 'class', 'disabled']);
692 $dateField
.addClass('crm-form-' + type
);
694 settings
.minDate
= settings
.minDate
? CRM
.utils
.makeDate(settings
.minDate
) : null;
695 settings
.maxDate
= settings
.maxDate
? CRM
.utils
.makeDate(settings
.maxDate
) : null;
696 settings
.dateFormat
= typeof settings
.date
=== 'string' ? settings
.date
: CRM
.config
.dateInputFormat
;
697 settings
.changeMonth
= _
.includes(settings
.dateFormat
, 'm');
698 settings
.changeYear
= _
.includes(settings
.dateFormat
, 'y');
699 if (!settings
.yearRange
&& settings
.minDate
!== null && settings
.maxDate
!== null) {
700 settings
.yearRange
= '' + CRM
.utils
.formatDate(settings
.minDate
, 'yy') + ':' + CRM
.utils
.formatDate(settings
.maxDate
, 'yy');
702 $dateField
.addClass('crm-form-date').datepicker(settings
);
704 $dateField
.attr('min', settings
.minDate
? CRM
.utils
.formatDate(settings
.minDate
, 'yy') : '1000');
705 $dateField
.attr('max', settings
.maxDate
? CRM
.utils
.formatDate(settings
.maxDate
, 'yy') : '4000');
707 $dateField
.change(updateDataField
);
709 // Rudimentary validation. TODO: Roll into use of jQUery validate and ui.datepicker.validation
710 function isValidDate() {
711 // FIXME: parseDate doesn't work with incomplete date formats; skip validation if no month, day or year in format
712 var lowerFormat
= settings
.dateFormat
.toLowerCase();
713 if (lowerFormat
.indexOf('y') < 0 || lowerFormat
.indexOf('m') < 0 || lowerFormat
.indexOf('d') < 0) {
717 $.datepicker
.parseDate(settings
.dateFormat
, $dateField
.val());
723 function updateInputFields(e
, context
) {
724 var val
= $dataField
.val(),
726 if (context
!== 'userInput' && context
!== 'crmClear') {
728 $dateField
.datepicker('setDate', _
.includes(val
, '-') ? $.datepicker
.parseDate('yy-mm-dd', val
) : null);
729 } else if ($dateField
.length
) {
730 $dateField
.val(val
.slice(0, 4));
732 if ($timeField
.length
) {
733 if (val
.length
=== 8) {
735 } else if (val
.length
=== 19) {
736 time
= val
.split(' ')[1];
738 $timeField
.timeEntry('setTime', time
);
741 $clearLink
.css('visibility', val
? 'visible' : 'hidden');
743 function updateDataField(e
, context
) {
744 // The crmClear event wipes all the field values anyway, so no need to respond
745 if (context
!== 'crmClear') {
747 if ($dateField
.val()) {
748 if (hasDatepicker
&& isValidDate()) {
749 val
= $.datepicker
.formatDate('yy-mm-dd', $dateField
.datepicker('getDate'));
750 $dateField
.removeClass('crm-error');
751 } else if (!hasDatepicker
) {
752 val
= $dateField
.val() + '-01-01';
754 $dateField
.addClass('crm-error');
757 if ($timeField
.val()) {
758 val
+= (val
? ' ' : '') + $timeField
.timeEntry('getTime').toTimeString().substr(0, 8);
760 $dataField
.val(val
).trigger('change', ['userInput']);
763 $dataField
.hide().addClass('crm-hidden-date').on('change.crmDatepicker', updateInputFields
);
768 $.fn
.crmAjaxTable = function() {
769 // Strip the ids from ajax urls to make pageLength storage more generic
770 function simplifyUrl(ajax
) {
771 // Datatables ajax prop could be a url string or an object containing the url
772 var url
= typeof ajax
=== 'object' ? ajax
.url
: ajax
;
773 return typeof url
=== 'string' ? url
.replace(/[&?]\w*id=\d+/g, '') : null;
776 return $(this).each(function() {
777 // Recall pageLength for this table
778 var url
= simplifyUrl($(this).data('ajax'));
779 if (url
&& window
.localStorage
&& localStorage
['dataTablePageLength:' + url
]) {
780 $(this).data('pageLength', localStorage
['dataTablePageLength:' + url
]);
782 // Declare the defaults for DataTables
787 "dom": '<"crm-datatable-pager-top"lfp>rt<"crm-datatable-pager-bottom"ip>',
789 "pagingType": "full_numbers",
790 "drawCallback": function(settings
) {
791 //Add data attributes to cells
792 $('thead th', settings
.nTable
).each( function( index
) {
793 $.each(this.attributes
, function() {
794 if(this.name
.match("^cell-")) {
795 var cellAttr
= this.name
.substring(5);
796 var cellValue
= this.value
;
797 $('tbody tr', settings
.nTable
).each( function() {
798 $('td:eq('+ index
+')', this).attr( cellAttr
, cellValue
);
803 //Reload table after draw
804 $(settings
.nTable
).trigger('crmLoad');
807 //Include any table specific data
808 var settings
= $.extend(true, defaults
, $(this).data('table'));
809 // Remember pageLength
810 $(this).on('length.dt', function(e
, settings
, len
) {
811 if (settings
.ajax
&& window
.localStorage
) {
812 localStorage
['dataTablePageLength:' + simplifyUrl(settings
.ajax
)] = len
;
815 //Make the DataTables call
816 $(this).DataTable(settings
);
820 CRM
.utils
.formatSelect2Result = function (row
) {
821 var markup
= '<div class="crm-select2-row">';
822 if (row
.image
!== undefined) {
823 markup
+= '<div class="crm-select2-image"><img src="' + row
.image
+ '"/></div>';
825 else if (row
.icon_class
) {
826 markup
+= '<div class="crm-select2-icon"><div class="crm-icon ' + row
.icon_class
+ '-icon"></div></div>';
828 markup
+= '<div><div class="crm-select2-row-label '+(row
.label_class
|| '')+'">' +
829 (row
.color
? '<span class="crm-select-item-color" style="background-color: ' + row
.color
+ '"></span> ' : '') +
830 _
.escape((row
.prefix
!== undefined ? row
.prefix
+ ' ' : '') + row
.label
+ (row
.suffix
!== undefined ? ' ' + row
.suffix
: '')) +
832 '<div class="crm-select2-row-description">';
833 $.each(row
.description
|| [], function(k
, text
) {
834 markup
+= '<p>' + _
.escape(text
) + '</p>';
836 markup
+= '</div></div></div>';
840 function formatEntityRefSelection(row
) {
841 return (row
.color
? '<span class="crm-select-item-color" style="background-color: ' + row
.color
+ '"></span> ' : '') +
842 _
.escape((row
.prefix
!== undefined ? row
.prefix
+ ' ' : '') + row
.label
+ (row
.suffix
!== undefined ? ' ' + row
.suffix
: ''));
845 function renderEntityRefCreateLinks($el
) {
847 createLinks
= $el
.data('create-links'),
848 params
= getEntityRefApiParams($el
).params
,
849 markup
= '<div class="crm-entityref-links">';
850 if (!createLinks
|| $el
.data('api-entity').toLowerCase() !== 'contact') {
853 if (createLinks
=== true) {
854 createLinks
= params
.contact_type
? _
.where(CRM
.config
.entityRef
.contactCreate
, {type
: params
.contact_type
}) : CRM
.config
.entityRef
.contactCreate
;
856 _
.each(createLinks
, function(link
) {
864 icon
= 'fa-building';
871 markup
+= ' <a class="crm-add-entity crm-hover-button" href="' + link
.url
+ '">';
873 markup
+= '<i class="crm-i ' + icon
+ '"></i> ';
875 markup
+= _
.escape(link
.label
) + '</a>';
881 function getEntityRefFilters($el
) {
883 entity
= $el
.data('api-entity').toLowerCase(),
884 filters
= $.extend([], CRM
.config
.entityRef
.filters
[entity
] || []),
885 params
= $.extend({params
: {}}, $el
.data('api-params') || {}).params
,
887 $.each(filters
, function() {
888 var filter
= $.extend({type
: 'select', 'attributes': {}, entity
: entity
}, this);
889 if (typeof params
[filter
.key
] === 'undefined') {
892 else if (filter
.key
== 'contact_type' && typeof params
.contact_sub_type
=== 'undefined') {
893 filter
.options
= _
.remove(filter
.options
, function(option
) {
894 return option
.key
.indexOf(params
.contact_type
+ '__') === 0;
903 * Provide markup for entity ref filters
905 function entityRefFiltersMarkup($el
) {
907 filters
= getEntityRefFilters($el
),
908 filter
= $el
.data('user-filter') || {},
909 filterSpec
= filter
.key
? _
.find(filters
, {key
: filter
.key
}) : null;
910 if (!filters
.length
) {
913 var markup
= '<div class="crm-entityref-filters">' +
914 '<select class="crm-entityref-filter-key' + (filter
.key
? ' active' : '') + '">' +
915 '<option value="">' + _
.escape(ts('Refine search...')) + '</option>' +
916 CRM
.utils
.renderOptions(filters
, filter
.key
) +
917 '</select>' + entityRefFilterValueMarkup(filter
, filterSpec
) + '</div>';
922 * Provide markup for entity ref filter value field
924 function entityRefFilterValueMarkup(filter
, filterSpec
) {
928 attributes
= _
.cloneDeep(filterSpec
.attributes
);
929 if (filterSpec
.type
!== 'select') {
930 attributes
.type
= filterSpec
.type
;
931 attributes
.value
= typeof filter
.value
!== 'undefined' ? filter
.value
: '';
933 attributes
.class = 'crm-entityref-filter-value' + (filter
.value
? ' active' : '');
934 $.each(attributes
, function (attr
, val
) {
935 attrs
+= ' ' + attr
+ '="' + val
+ '"';
937 if (filterSpec
.type
=== 'select') {
938 markup
= '<select' + attrs
+ '><option value="">' + _
.escape(ts('- select -')) + '</option>';
939 if (filterSpec
.options
) {
940 markup
+= CRM
.utils
.renderOptions(filterSpec
.options
, filter
.value
);
942 markup
+= '</select>';
944 markup
= '<input' + attrs
+ '/>';
951 * Render the entity ref filter value field
953 function renderEntityRefFilterValue($el
) {
955 filter
= $el
.data('user-filter') || {},
956 filterSpec
= filter
.key
? _
.find(getEntityRefFilters($el
), {key
: filter
.key
}) : null,
957 $keyField
= $('.crm-entityref-filter-key', '#select2-drop'),
960 $('.crm-entityref-filter-value', '#select2-drop').remove();
961 $valField
= $(entityRefFilterValueMarkup(filter
, filterSpec
));
962 $keyField
.after($valField
);
963 if (filterSpec
.type
=== 'select' && !filterSpec
.options
) {
964 loadEntityRefFilterOptions(filter
, filterSpec
, $valField
, $el
);
967 $('.crm-entityref-filter-value', '#select2-drop').hide().val('').change();
972 * Fetch options for a filter via ajax api
974 function loadEntityRefFilterOptions(filter
, filterSpec
, $valField
, $el
) {
975 $valField
.prop('disabled', true);
976 // Fieldname may be prefixed with joins - strip those out
977 var fieldName
= _
.last(filter
.key
.split('.'));
978 CRM
.api3(filterSpec
.entity
, 'getoptions', {field
: fieldName
, context
: 'search', sequential
: 1})
979 .done(function(result
) {
980 var entity
= $el
.data('api-entity').toLowerCase(),
981 globalFilterSpec
= _
.find(CRM
.config
.entityRef
.filters
[entity
], {key
: filter
.key
}) || {};
982 // Store options globally so we don't have to look them up again
983 globalFilterSpec
.options
= result
.values
;
984 $valField
.prop('disabled', false);
985 CRM
.utils
.setOptions($valField
, result
.values
);
986 $valField
.val(filter
.value
|| '');
990 //CRM-15598 - Override url validator method to allow relative url's (e.g. /index.htm)
991 $.validator
.addMethod("url", function(value
, element
) {
992 if (/^\//.test(value
)) {
993 // Relative url: prepend dummy path for validation.
994 value
= 'http://domain.tld' + value
;
996 // From jQuery Validation Plugin v1.12.0
997 return this.optional(element
) || /^(https?|s?ftp):\/\/(((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)+(\/(([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(#((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|\/|\?)*)?$/i.test(value
);
1001 * Wrapper for jQuery validate initialization function; supplies defaults
1003 $.fn
.crmValidate = function(params
) {
1004 return $(this).each(function () {
1006 settings
= $.extend({}, CRM
.validate
._defaults
, CRM
.validate
.params
);
1007 $(this).validate(settings
);
1008 // Call any post-initialization callbacks
1009 if (CRM
.validate
.functions
&& CRM
.validate
.functions
.length
) {
1010 $.each(CRM
.validate
.functions
, function(i
, func
) {
1017 // Initialize widgets
1019 .on('crmLoad', function(e
) {
1020 $('table.row-highlight', e
.target
)
1021 .off('.rowHighlight')
1022 .on('change.rowHighlight', 'input.select-row, input.select-rows', function (e
, data
) {
1023 var filter
, $table
= $(this).closest('table');
1024 if ($(this).hasClass('select-rows')) {
1025 filter
= $(this).prop('checked') ? ':not(:checked)' : ':checked';
1026 $('input.select-row' + filter
, $table
).prop('checked', $(this).prop('checked')).trigger('change', 'master-selected');
1029 $(this).closest('tr').toggleClass('crm-row-selected', $(this).prop('checked'));
1030 if (data
!== 'master-selected') {
1031 $('input.select-rows', $table
).prop('checked', $(".select-row:not(':checked')", $table
).length
< 1);
1035 .find('input.select-row:checked').parents('tr').addClass('crm-row-selected');
1036 $('table.crm-sortable', e
.target
).DataTable();
1037 $('table.crm-ajax-table', e
.target
).each(function() {
1040 $accordion
= $table
.closest('.crm-accordion-wrapper.collapsed, .crm-collapsible.collapsed');
1041 // For tables hidden by collapsed accordions, wait.
1042 if ($accordion
.length
) {
1043 $accordion
.one('crmAccordion:open', function() {
1044 $table
.crmAjaxTable();
1047 $table
.crmAjaxTable();
1050 if ($("input:radio[name=radio_ts]").size() == 1) {
1051 $("input:radio[name=radio_ts]").prop("checked", true);
1053 $('.crm-select2:not(.select2-offscreen, .select2-container)', e
.target
).crmSelect2();
1054 $('.crm-form-entityref:not(.select2-offscreen, .select2-container)', e
.target
).crmEntityRef();
1055 $('select.crm-chain-select-control', e
.target
).off('.chainSelect').on('change.chainSelect', chainSelect
);
1056 $('.crm-form-text[data-crm-datepicker]', e
.target
).each(function() {
1057 $(this).crmDatepicker($(this).data('crmDatepicker'));
1059 // Cache Form Input initial values
1060 $('form[data-warn-changes] :input', e
.target
).each(function() {
1061 $(this).data('crm-initial-value', $(this).is(':checkbox, :radio') ? $(this).prop('checked') : $(this).val());
1063 $('textarea.crm-form-wysiwyg', e
.target
).each(function() {
1064 if ($(this).hasClass("collapsed")) {
1065 CRM
.wysiwyg
.createCollapsed(this);
1067 CRM
.wysiwyg
.create(this);
1071 .on('dialogopen', function(e
) {
1072 var $el
= $(e
.target
);
1073 // Modal dialogs should disable scrollbars
1074 if ($el
.dialog('option', 'modal')) {
1075 $el
.addClass('modal-dialog');
1076 $('body').css({overflow
: 'hidden'});
1078 $el
.parent().find('.ui-dialog-titlebar .ui-icon-closethick').removeClass('ui-icon-closethick').addClass('fa-times');
1079 // Add resize button
1080 if ($el
.parent().hasClass('crm-container') && $el
.dialog('option', 'resizable')) {
1081 $el
.parent().find('.ui-dialog-titlebar').append($('<button class="crm-dialog-titlebar-resize ui-dialog-titlebar-close" title="'+ _
.escape(ts('Toggle fullscreen'))+'" style="right:2em;"/>').button({icons
: {primary
: 'fa-expand'}, text
: false}));
1082 $('.crm-dialog-titlebar-resize', $el
.parent()).click(function(e
) {
1083 if ($el
.data('origSize')) {
1084 $el
.dialog('option', $el
.data('origSize'));
1085 $el
.data('origSize', null);
1087 var menuHeight
= $('#civicrm-menu').outerHeight();
1088 $el
.data('origSize', {
1089 position
: {my
: 'center', at
: 'center center+' + (menuHeight
/ 2), of: window
},
1090 width
: $el
.dialog('option', 'width'),
1091 height
: $el
.dialog('option', 'height')
1093 $el
.dialog('option', {width
: '100%', height
: ($(window
).height() - menuHeight
), position
: {my
: "top", at
: "top+"+menuHeight
, of: window
}});
1095 $el
.trigger('dialogresize');
1100 .on('dialogclose', function(e
) {
1101 // Restore scrollbars when closing modal
1102 if ($('.ui-dialog .modal-dialog:visible').not(e
.target
).length
< 1) {
1103 $('body').css({overflow
: ''});
1106 .on('submit', function(e
) {
1107 // CRM-14353 - disable changes warn when submitting a form
1108 $('[data-warn-changes]').attr('data-warn-changes', 'false');
1111 // CRM-14353 - Warn of unsaved changes for forms which have opted in
1112 window
.onbeforeunload = function() {
1113 if (CRM
.utils
.initialValueChanged($('form[data-warn-changes=true]:visible'))) {
1114 return ts('You have unsaved changes.');
1118 $.fn
.crmtooltip = function () {
1120 .on('mouseover', 'a.crm-summary-link:not(.crm-processed)', function (e
) {
1121 $(this).addClass('crm-processed crm-tooltip-active');
1122 var topDistance
= e
.pageY
- $(window
).scrollTop();
1123 if (topDistance
< 300 || topDistance
< $(this).children('.crm-tooltip-wrapper').height()) {
1124 $(this).addClass('crm-tooltip-down');
1126 if (!$(this).children('.crm-tooltip-wrapper').length
) {
1127 $(this).append('<div class="crm-tooltip-wrapper"><div class="crm-tooltip"></div></div>');
1128 $(this).children().children('.crm-tooltip')
1129 .html('<div class="crm-loading-element"></div>')
1133 .on('mouseout', 'a.crm-summary-link', function () {
1134 $(this).removeClass('crm-processed crm-tooltip-active crm-tooltip-down');
1136 .on('click', 'a.crm-summary-link', false);
1139 var helpDisplay
, helpPrevious
;
1140 // Non-ajax example:
1141 // CRM.help('Example title', 'Here is some text to describe this example');
1142 // Ajax example (will load help id "foo" from templates/CRM/bar.tpl):
1143 // CRM.help('Example title', {id: 'foo', file: 'CRM/bar'});
1144 CRM
.help = function (title
, params
, url
) {
1145 var ajax
= typeof params
!== 'string';
1146 if (helpDisplay
&& helpDisplay
.close
) {
1147 // If the same link is clicked twice, just close the display
1148 if (helpDisplay
.isOpen
&& _
.isEqual(helpPrevious
, params
)) {
1149 helpDisplay
.close();
1152 helpDisplay
.close();
1154 helpPrevious
= _
.cloneDeep(params
);
1155 helpDisplay
= CRM
.alert(ajax
? '...' : params
, title
, 'crm-help ' + (ajax
? 'crm-msg-loading' : 'info'), {expires
: 0});
1158 url
= CRM
.url('civicrm/ajax/inline');
1159 params
.class_name
= 'CRM_Core_Page_Inline_Help';
1160 params
.type
= 'page';
1165 success: function (data
) {
1166 $('#crm-notification-container .crm-help .notify-content:last').html(data
);
1167 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('info');
1169 error: function () {
1170 $('#crm-notification-container .crm-help .notify-content:last').html('Unable to load help file.');
1171 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('error');
1177 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1179 CRM
.status = function(options
, deferred
) {
1180 // For simple usage without async operations you can pass in a string. 2nd param is optional string 'error' if this is not a success msg.
1181 if (typeof options
=== 'string') {
1182 return CRM
.status({start
: options
, success
: options
, error
: options
})[deferred
=== 'error' ? 'reject' : 'resolve']();
1184 var opts
= $.extend({
1185 start
: ts('Saving...'),
1186 success
: ts('Saved'),
1187 error: function(data
) {
1188 var msg
= $.isPlainObject(data
) && data
.error_message
;
1189 CRM
.alert(msg
|| ts('Sorry an error occurred and your information was not saved'), ts('Error'), 'error');
1192 var $msg
= $('<div class="crm-status-box-outer status-start"><div class="crm-status-box-inner"><div class="crm-status-box-msg">' + _
.escape(opts
.start
) + '</div></div></div>')
1194 $msg
.css('min-width', $msg
.width());
1195 function handle(status
, data
) {
1196 var endMsg
= typeof(opts
[status
]) === 'function' ? opts
[status
](data
) : opts
[status
];
1198 $msg
.removeClass('status-start').addClass('status-' + status
).find('.crm-status-box-msg').text(endMsg
);
1199 window
.setTimeout(function() {
1200 $msg
.fadeOut('slow', function() {
1208 return (deferred
|| new $.Deferred())
1209 .done(function(data
) {
1210 // If the server returns an error msg call the error handler
1211 var status
= $.isPlainObject(data
) && (data
.is_error
|| data
.status
=== 'error') ? 'error' : 'success';
1212 handle(status
, data
);
1214 .fail(function(data
) {
1215 handle('error', data
);
1219 // Convert an Angular promise to a jQuery promise
1220 CRM
.toJqPromise = function(aPromise
) {
1221 var jqDeferred
= $.Deferred();
1223 function(data
) { jqDeferred
.resolve(data
); },
1224 function(data
) { jqDeferred
.reject(data
); }
1225 // should we also handle progress events?
1227 return jqDeferred
.promise();
1230 CRM
.toAPromise = function($q
, jqPromise
) {
1231 var aDeferred
= $q
.defer();
1233 function(data
) { aDeferred
.resolve(data
); },
1234 function(data
) { aDeferred
.reject(data
); }
1235 // should we also handle progress events?
1237 return aDeferred
.promise
;
1241 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1243 CRM
.alert = function (text
, title
, type
, options
) {
1244 type
= type
|| 'alert';
1245 title
= title
|| '';
1246 options
= options
|| {};
1247 if ($('#crm-notification-container').length
) {
1253 // By default, don't expire errors and messages containing links
1255 expires
: (type
== 'error' || text
.indexOf('<a ') > -1) ? 0 : (text
? 10000 : 5000),
1258 options
= $.extend(extra
, options
);
1259 options
.expires
= options
.expires
=== false ? 0 : parseInt(options
.expires
, 10);
1260 if (options
.unique
&& options
.unique
!== '0') {
1261 $('#crm-notification-container .ui-notify-message').each(function () {
1262 if (title
=== $('h1', this).html() && text
=== $('.notify-content', this).html()) {
1263 $('.icon.ui-notify-close', this).click();
1267 return $('#crm-notification-container').notify('create', params
, options
);
1271 text
= title
+ "\n" + text
;
1279 * Close whichever alert contains the given node
1283 CRM
.closeAlertByChild = function (node
) {
1284 $(node
).closest('.ui-notify-message').find('.icon.ui-notify-close').click();
1288 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1290 CRM
.confirm = function (options
) {
1291 var dialog
, url
, msg
, buttons
= [], settings
= {
1292 title
: ts('Confirm'),
1293 message
: ts('Are you sure you want to continue?'),
1298 dialogClass
: 'crm-container crm-confirm',
1299 close: function () {
1300 $(this).dialog('destroy').remove();
1307 if (options
&& options
.url
) {
1308 settings
.resizable
= true;
1309 settings
.height
= '50%';
1311 $.extend(settings
, ($.isFunction(options
) ? arguments
[1] : options
) || {});
1312 settings
= CRM
.utils
.adjustDialogDefaults(settings
);
1313 if (!settings
.buttons
&& $.isPlainObject(settings
.options
)) {
1314 $.each(settings
.options
, function(op
, label
) {
1318 icons
: {primary
: op
=== 'no' ? 'fa-times' : 'fa-check'},
1320 var event
= $.Event('crmConfirm:' + op
);
1321 $(this).trigger(event
);
1322 if (!event
.isDefaultPrevented()) {
1323 dialog
.dialog('close');
1328 // Order buttons so that "no" goes on the right-hand side
1329 settings
.buttons
= _
.sortBy(buttons
, 'data-op').reverse();
1332 msg
= url
? '' : settings
.message
;
1333 delete settings
.options
;
1334 delete settings
.message
;
1335 delete settings
.url
;
1336 dialog
= $('<div class="crm-confirm-dialog"></div>').html(msg
|| '').dialog(settings
);
1337 if ($.isFunction(options
)) {
1338 dialog
.on('crmConfirm:yes', options
);
1341 CRM
.loadPage(url
, {target
: dialog
});
1344 dialog
.trigger('crmLoad');
1349 /** provides a local copy of ts for a domain */
1350 CRM
.ts = function(domain
) {
1351 return function(message
, options
) {
1353 options
= $.extend(options
|| {}, {domain
: domain
});
1355 return ts(message
, options
);
1359 CRM
.addStrings = function(domain
, strings
) {
1360 var bucket
= (domain
== 'civicrm' ? 'strings' : 'strings::' + domain
);
1361 CRM
[bucket
] = CRM
[bucket
] || {};
1362 _
.extend(CRM
[bucket
], strings
);
1366 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1368 $.fn
.crmError = function (text
, title
, options
) {
1369 title
= title
|| '';
1371 options
= options
|| {};
1376 if ($(this).length
) {
1378 var label
= $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]').not('[generated=true]');
1380 label
.addClass('crm-error');
1381 var $label
= label
.clone();
1382 if (text
=== '' && $('.crm-marker', $label
).length
> 0) {
1383 text
= $('.crm-marker', $label
).attr('title');
1385 $('.crm-marker', $label
).remove();
1386 title
= $label
.text();
1389 $(this).addClass('crm-error');
1391 var msg
= CRM
.alert(text
, title
, 'error', $.extend(extra
, options
));
1392 if ($(this).length
) {
1394 setTimeout(function () {
1395 ele
.one('change', function () {
1396 if (msg
&& msg
.close
) msg
.close();
1397 ele
.removeClass('error');
1398 label
.removeClass('crm-error');
1405 // Display system alerts through js notifications
1406 function messagesFromMarkup() {
1407 $('div.messages:visible', this).not('.help').not('.no-popup').each(function () {
1408 var text
, title
= '';
1409 $(this).removeClass('status messages');
1410 var type
= $(this).attr('class').split(' ')[0] || 'alert';
1411 type
= type
.replace('crm-', '');
1412 $('.icon', this).remove();
1413 if ($('.msg-text', this).length
> 0) {
1414 text
= $('.msg-text', this).html();
1415 title
= $('.msg-title', this).html();
1418 text
= $(this).html();
1420 var options
= $(this).data('options') || {};
1422 // Duplicates were already removed server-side
1423 options
.unique
= false;
1424 CRM
.alert(text
, title
, type
, options
);
1426 // Handle qf form errors
1427 $('form :input.error', this).one('blur', function() {
1428 $('.ui-notify-message.error a.ui-notify-close').click();
1429 $(this).removeClass('error');
1430 $(this).next('span.crm-error').remove();
1431 $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]')
1432 .removeClass('crm-error')
1433 .find('.crm-error').removeClass('crm-error');
1438 * Improve blockUI when used with jQuery dialog
1440 var originalBlock
= $.fn
.block
,
1441 originalUnblock
= $.fn
.unblock
;
1443 $.fn
.block = function(opts
) {
1444 if ($(this).is('.ui-dialog-content')) {
1445 originalBlock
.call($(this).parents('.ui-dialog'), opts
);
1448 return originalBlock
.call(this, opts
);
1450 $.fn
.unblock = function(opts
) {
1451 if ($(this).is('.ui-dialog-content')) {
1452 originalUnblock
.call($(this).parents('.ui-dialog'), opts
);
1455 return originalUnblock
.call(this, opts
);
1458 // Preprocess all CRM ajax calls to display messages
1459 $(document
).ajaxSuccess(function(event
, xhr
, settings
) {
1461 if ((!settings
.dataType
|| settings
.dataType
== 'json') && xhr
.responseText
) {
1462 var response
= $.parseJSON(xhr
.responseText
);
1463 if (typeof(response
.crmMessages
) == 'object') {
1464 $.each(response
.crmMessages
, function(n
, msg
) {
1465 CRM
.alert(msg
.text
, msg
.title
, msg
.type
, msg
.options
);
1468 if (response
.backtrace
) {
1469 CRM
.console('log', response
.backtrace
);
1471 if (typeof response
.deprecated
=== 'string') {
1472 CRM
.console('warn', response
.deprecated
);
1476 // Ignore errors thrown by parseJSON
1481 $.blockUI
.defaults
.message
= null;
1482 $.blockUI
.defaults
.ignoreIfBlocked
= true;
1484 if ($('#crm-container').hasClass('crm-public')) {
1485 $.fn
.select2
.defaults
.dropdownCssClass
= $.ui
.dialog
.prototype.options
.dialogClass
= 'crm-container crm-public';
1488 // Trigger crmLoad on initial content for consistency. It will also be triggered for ajax-loaded content.
1489 $('.crm-container').trigger('crmLoad');
1491 if ($('#crm-notification-container').length
) {
1492 // Initialize notifications
1493 $('#crm-notification-container').notify();
1494 messagesFromMarkup
.call($('#crm-container'));
1498 // bind the event for image popup
1499 .on('click', 'a.crm-image-popup', function(e
) {
1501 title
: ts('Preview'),
1503 // Prevent overlap with the menubar
1504 maxHeight
: $(window
).height() - 30,
1505 position
: {my
: 'center', at
: 'center center+15', of: window
},
1506 message
: '<div class="crm-custom-image-popup"><img style="max-width: 100%" src="' + $(this).attr('href') + '"></div>',
1512 .on('click', function (event
) {
1513 $('.btn-slide-active').removeClass('btn-slide-active').find('.panel').hide();
1514 if ($(event
.target
).is('.btn-slide')) {
1515 $(event
.target
).addClass('btn-slide-active').find('.panel').show();
1519 // Handle clear button for form elements
1520 .on('click', 'a.crm-clear-link', function() {
1521 $(this).css({visibility
: 'hidden'}).siblings('.crm-form-radio:checked').prop('checked', false).trigger('change', ['crmClear']);
1522 $(this).siblings('input:text').val('').trigger('change', ['crmClear']);
1525 .on('change', 'input.crm-form-radio:checked, input[allowclear=1]', function(e
, context
) {
1526 if (context
!== 'crmClear' && ($(this).is(':checked') || ($(this).is('[allowclear=1]') && $(this).val()))) {
1527 $(this).siblings('.crm-clear-link').css({visibility
: ''});
1531 // Allow normal clicking of links within accordions
1532 .on('click.crmAccordions', 'div.crm-accordion-header a, .collapsible-title a', function (e
) {
1533 e
.stopPropagation();
1535 // Handle accordions
1536 .on('click.crmAccordions', '.crm-accordion-header, .crm-collapsible .collapsible-title', function (e
) {
1537 var action
= 'open';
1538 if ($(this).parent().hasClass('collapsed')) {
1539 $(this).next().css('display', 'none').slideDown(200);
1542 $(this).next().css('display', 'block').slideUp(200);
1545 $(this).parent().toggleClass('collapsed').trigger('crmAccordion:' + action
);
1553 * Collapse or expand an accordion
1556 $.fn
.crmAccordionToggle = function (speed
) {
1557 $(this).each(function () {
1558 var action
= 'open';
1559 if ($(this).hasClass('collapsed')) {
1560 $('.crm-accordion-body', this).first().css('display', 'none').slideDown(speed
);
1563 $('.crm-accordion-body', this).first().css('display', 'block').slideUp(speed
);
1566 $(this).toggleClass('collapsed').trigger('crmAccordion:' + action
);
1571 * Clientside currency formatting
1572 * @param number value
1573 * @param [optional] boolean onlyNumber - if true, we return formatted amount without currency sign
1574 * @param [optional] string format - currency representation of the number 1234.56
1577 var currencyTemplate
;
1578 CRM
.formatMoney = function(value
, onlyNumber
, format
) {
1579 var decimal, separator
, sign
, i
, j
, result
;
1580 if (value
=== 'init' && format
) {
1581 currencyTemplate
= format
;
1584 format
= format
|| currencyTemplate
;
1585 result
= /1(.?)234(.?)56/.exec(format
);
1586 if (result
=== null) {
1587 return 'Invalid format passed to CRM.formatMoney';
1589 separator
= result
[1];
1590 decimal = result
[2];
1591 sign
= (value
< 0) ? '-' : '';
1592 //extracting the absolute value of the integer part of the number and converting to string
1593 i
= parseInt(value
= Math
.abs(value
).toFixed(2)) + '';
1594 j
= ((j
= i
.length
) > 3) ? j
% 3 : 0;
1595 result
= sign
+ (j
? i
.substr(0, j
) + separator
: '') + i
.substr(j
).replace(/(\d{3})(?=\d)/g, "$1" + separator
) + (2 ? decimal + Math
.abs(value
- i
).toFixed(2).slice(2) : '');
1599 return format
.replace(/1.*234.*56/, result
);
1602 CRM
.console = function(method
, title
, msg
) {
1603 if (window
.console
) {
1604 method
= $.isFunction(console
[method
]) ? method
: 'log';
1605 if (msg
=== undefined) {
1606 return console
[method
](title
);
1608 return console
[method
](title
, msg
);
1613 // Sugar methods for window.localStorage, with a fallback for older browsers
1614 var cacheItems
= {};
1616 get: function (name
, defaultValue
) {
1618 if (localStorage
.getItem('CRM' + name
) !== null) {
1619 return JSON
.parse(localStorage
.getItem('CRM' + name
));
1622 return cacheItems
[name
] === undefined ? defaultValue
: cacheItems
[name
];
1624 set: function (name
, value
) {
1626 localStorage
.setItem('CRM' + name
, JSON
.stringify(value
));
1628 cacheItems
[name
] = value
;
1630 clear: function(name
) {
1632 localStorage
.removeItem('CRM' + name
);
1634 delete cacheItems
[name
];
1640 // Determine if a user has a given permission.
1641 // @see CRM_Core_Resources::addPermissions
1642 CRM
.checkPerm = function(perm
) {
1643 return CRM
.permissions
[perm
];
1646 // Round while preserving sigfigs
1647 CRM
.utils
.sigfig = function(n
, digits
) {
1648 var len
= ("" + n
).length
;
1649 var scale
= Math
.pow(10.0, len
-digits
);
1650 return Math
.round(n
/ scale
) * scale
;
1653 // Create a js Date object from a unix timestamp or a yyyy-mm-dd string
1654 CRM
.utils
.makeDate = function(input
) {
1655 switch (typeof input
) {
1657 // already a date object
1661 // convert iso format
1662 return $.datepicker
.parseDate('yy-mm-dd', input
.substr(0, 10));
1665 // convert unix timestamp
1666 return new Date(input
* 1000);
1668 throw 'Invalid input passed to CRM.utils.makeDate';
1671 // Format a date for output to the user
1672 // Input may be a js Date object, a unix timestamp or a yyyy-mm-dd string
1673 CRM
.utils
.formatDate = function(input
, outputFormat
) {
1674 return input
? $.datepicker
.formatDate(outputFormat
|| CRM
.config
.dateInputFormat
, CRM
.utils
.makeDate(input
)) : '';