dev/core#964 Add start date and end date values on page contribution widget ajax response

[francescbassas]

Overview

Contribution page widgets calls civicrm/extern/widget.php to extract info of the campaign related to the widget. In some cases it maybe interesting to have the time to start or to finish the campaign to customize the widget with options such as "Starts in X days", "Ends in X days" or anything else.

in the line of https://issues.civicrm.org/jira/browse/CRM-21454

Before

After

Json response includes "start_date":YYYY-MM-DD hh:mm:ss,"time_to_end":YYYY-MM-DD hh:mm:ss if start date and end date are defined respectively.

Comments

An example of how to take advantage of these new fields:

var start_date = new Date(jsonvar.start_date.replace(/ /g,"T"));
var end_date = new Date(jsonvar.end_date.replace(/ /g,"T"));
var now = Date.now();

if ( start_date > now ) {
  var time_left = start_date - now;
  if ( time_left > 86400000 ) {
    document.getElementById('crm_cpid_'+cpid+'_status-item').innerHTML =
    "Starts in " + Math.ceil(time_left/86400000) + " days";
  }
  else {
    document.getElementById('crm_cpid_'+cpid+'_status-item').innerHTML =
    "Starts in " + Math.ceil(time_left3600000) + " hours";
  }
}
else if (end_date < now) {
  document.getElementById('crm_cpid_'+cpid+'_status-item').style.display = "none";
}
else {
  var time_left = end_date - now;
  if ( time_left > 86400000 ) {
    document.getElementById('crm_cpid_'+cpid+'_status-item').innerHTML =
    "Ends in " +Math.ceil(time_left/86400000) + " days";
  }
  else {
    document.getElementById('crm_cpid_'+cpid+'_status-item').innerHTML =
    "Ends in " +Math.ceil(time_left/3600000) + " hours";
  }
}

"start_date" and "end_date" values also allows customize predefined "campaign_start" messages ('Campaign starts on %1', 'Campaign ended on %1', etc.)

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[colemanw]

typo here in the word "stard"

[colemanw]

I think it would be more consistent with everything else in civi if you return the ISO format for start_date & end_date instead of a timestamp.

Also I'm not wild about the "time to start" and "time to end" since that's generally something that should be calculated & updated in real-time by javascript. As soon as you fetch this data it will be outdated, moreso if any kind of caching is used.

[francescbassas]

@colemanw, I agree with your comments, I have already applied the changes. If you do it for good, I will change the description of the PR according to the changes. Thanks!

[colemanw]

Ok this looks useful and harmless as it's just adding a couple other bits of data to an ajax response.

[francescbassas]

Thanks @colemanw