123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964 |
- /*! http://keith-wood.name/countdown.html
- Countdown for jQuery v2.1.0.
- Written by Keith Wood (wood.keith{at}optusnet.com.au) January 2008.
- Available under the MIT (http://keith-wood.name/licence.html) license.
- Please attribute the author if you use it. */
- (function($) { // Hide scope, no $ conflict
- 'use strict';
- var pluginName = 'countdown';
- var Y = 0; // Years
- var O = 1; // Months
- var W = 2; // Weeks
- var D = 3; // Days
- var H = 4; // Hours
- var M = 5; // Minutes
- var S = 6; // Seconds
- /** Create the countdown plugin.
- <p>Sets an element to show the time remaining until a given instant.</p>
- <p>Expects HTML like:</p>
- <pre><div></div></pre>
- <p>Provide inline configuration like:</p>
- <pre><div data-countdown="name: 'value', ..."></div></pre>
- @module Countdown
- @augments JQPlugin
- @example $(selector).countdown({until: +300}) */
- $.JQPlugin.createPlugin({
-
- /** The name of the plugin.
- @default 'countdown' */
- name: pluginName,
- /** Countdown expiry callback.
- Used with the {@linkcode module:Countdown~defaultOptions|onExpiry} option and
- triggered when the countdown expires.
- @global
- @callback CountdownExpiryCallback
- @this <code>Element</code>
- @example onExpiry: function() {
- alert('Done');
- } */
- /** Countdown server synchronisation callback.
- Used with the {@linkcode module:Countdown~defaultOptions|serverSync} option and
- triggered when the countdown is initialised.
- @global
- @callback CountdownServerSyncCallback
- @return {Date} The current date/time on the server as expressed in the local timezone.
- @this <code>$.countdown</code>
- @example serverSync: function() {
- var time = null;
- $.ajax({url: 'http://myserver.com/serverTime.php',
- async: false, dataType: 'text',
- success: function(text) {
- time = new Date(text);
- }, error: function(http, message, exc) {
- time = new Date();
- });
- return time;
- } */
-
- /** Countdown tick callback.
- Used with the {@linkcode module:Countdown~defaultOptions|onTick} option and
- triggered on every {@linkcode module:Countdown~defaultOptions|tickInterval} ticks of the countdown.
- @global
- @callback CountdownTickCallback
- @this <code>Element</code>
- @param {number[]} periods The breakdown by period (years, months, weeks, days,
- hours, minutes, seconds) of the time remaining/passed.
- @example onTick: function(periods) {
- $('#altTime').text(periods[4] + ':' + twoDigits(periods[5]) +
- ':' + twoDigits(periods[6]));
- } */
- /** Countdown which labels callback.
- Used with the {@linkcode module:Countdown~regionalOptions|whichLabels} option and
- triggered when the countdown is being display to determine which set of labels
- (<code>labels</code>, <code>labels1</code>, ...) are to be used for the current period value.
- @global
- @callback CountdownWhichLabelsCallback
- @param {number} num The current period value.
- @return {number} The suffix for the label set to use, or zero for the default labels.
- @example whichLabels: function(num) {
- return (num === 1 ? 1 : (num >= 2 && num <= 4 ? 2 : 0));
- } */
-
- /** Default settings for the plugin.
- @property {Date|number|string} [until] The date/time to count down to, or number of seconds
- offset from now, or string of amounts and units for offset(s) from now:
- 'Y' years, 'O' months, 'W' weeks, 'D' days, 'H' hours, 'M' minutes, 'S' seconds.
- One of <code>until</code> or <code>since</code> must be specified.
- If both are given <code>since</code> takes precedence.
- @example until: new Date(2013, 12-1, 25, 13, 30)
- until: +300
- until: '+1O -2D'
- @property {Date|number|string} [since] The date/time to count up from, or number of seconds
- offset from now, or string of amounts and units for offset(s) from now:
- 'Y' years, 'O' months, 'W' weeks, 'D' days, 'H' hours, 'M' minutes, 'S' seconds.
- One of <code>until</code> or <code>since</code> must be specified.
- If both are given <code>since</code> takes precedence.
- @example since: new Date(2013, 1-1, 1)
- since: -300
- since: '-1O +2D'
- @property {number} [timezone=null] The timezone (hours or minutes from GMT) for the target times,
- or <code>null</code> for client local timezone.
- @example timezone: +10
- timezone: -60
- @property {CountdownServerSyncCallback} [serverSync=null] A function to retrieve the current server time
- for synchronisation.
- @property {string} [format='dHMS'] The format for display - upper case to always show,
- lower case to show only if non-zero,
- 'Y' years, 'O' months, 'W' weeks, 'D' days, 'H' hours, 'M' minutes, 'S' seconds.
- @property {string} [layout=''] <p>Build your own layout for the countdown.</p>
- <p>Indicate substitution points with '{desc}' for the description, '{sep}' for the time separator,
- '{pv}' where p is 'y' for years, 'o' for months, 'w' for weeks, 'd' for days,
- 'h' for hours, 'm' for minutes, or 's' for seconds and v is 'n' for the period value,
- 'nn' for the period value with a minimum of two digits,
- 'nnn' for the period value with a minimum of three digits, or
- 'l' for the period label (long or short form depending on the compact setting), or
- '{pd}' where p is as above and d is '1' for the units digit, '10' for the tens digit,
- '100' for the hundreds digit, or '1000' for the thousands digit.</p>
- <p>If you need to exclude entire sections when the period value is zero and
- you have specified the period as optional, surround these sections with
- '{p<}' and '{p>}', where p is the same as above.</p>
- <p>Your layout can just be simple text, or can contain HTML markup as well.</p>
- @example layout: '{d<}{dn} {dl}{d>} {hnn}:{mnn}:{snn}'
- @property {boolean} [compact=false] <code>true</code> to display in a compact format,
- <code>false</code> for an expanded one.
- @property {boolean} [padZeroes=false] <code>true</code> to add leading zeroes.
- @property {number} [significant=0] The maximum number of periods with non-zero values to show, zero for all.
- @property {string} [description=''] The description displayed for the countdown.
- @property {string} [expiryUrl=''] A URL to load upon expiry, replacing the current page.
- @property {string} [expiryText=''] Text to display upon expiry, replacing the countdown. This may be HTML.
- @property {boolean} [alwaysExpire=false] <code>true</code> to trigger <code>onExpiry</code>
- even if the target time has passed.
- @property {CountdownExpiryCallback} [onExpiry=null] Callback when the countdown expires -
- receives no parameters and <code>this</code> is the containing element.
- @example onExpiry: function() {
- ...
- }
- @property {CountdownTickCallback} [onTick=null] Callback when the countdown is updated -
- receives <code>number[7]</code> being the breakdown by period
- (years, months, weeks, days, hours, minutes, seconds - based on
- <code>format</code>) and <code>this</code> is the containing element.
- @example onTick: function(periods) {
- var secs = $.countdown.periodsToSeconds(periods);
- if (secs < 300) { // Last five minutes
- ...
- }
- }
- @property {number} [tickInterval=1] The interval (seconds) between <code>onTick</code> callbacks. */
- defaultOptions: {
- until: null,
- since: null,
- timezone: null,
- serverSync: null,
- format: 'dHMS',
- layout: '',
- compact: false,
- padZeroes: false,
- significant: 0,
- description: '',
- expiryUrl: '',
- expiryText: '',
- alwaysExpire: false,
- onExpiry: null,
- onTick: null,
- tickInterval: 1
- },
- /** Localisations for the plugin.
- Entries are objects indexed by the language code ('' being the default US/English).
- Each object has the following attributes.
- @property {string[]} [labels=['Years','Months','Weeks','Days','Hours','Minutes','Seconds']]
- The display texts for the counter periods.
- @property {string[]} [labels1=['Year','Month','Week','Day','Hour','Minute','Second']]
- The display texts for the counter periods if they have a value of 1.
- Add other <code>labels<em>n</em></code> attributes as necessary to
- cater for other numeric idiosyncrasies of the localisation.
- @property {string[]}[compactLabels=['y','m','w','d']] The compact texts for the counter periods.
- @property {CountdownWhichLabelsCallback} [whichLabels=null] A function to determine which
- <code>labels<em>n</em></code> to use.
- @example whichLabels: function(num) {
- return (num > 1 ? 0 : 1);
- }
- @property {string[]} [digits=['0','1',...,'9']] The digits to display (0-9).
- @property {string} [timeSeparator=':'] Separator for time periods in the compact layout.
- @property {boolean} [isRTL=false] <code>true</code> for right-to-left languages,
- <code>false</code> for left-to-right. */
- regionalOptions: { // Available regional settings, indexed by language/country code
- '': { // Default regional settings - English/US
- labels: ['Years', 'Months', 'Weeks', 'Days', 'Hours', 'Minutes', 'Seconds'],
- labels1: ['Year', 'Month', 'Week', 'Day', 'Hour', 'Minute', 'Second'],
- compactLabels: ['y', 'm', 'w', 'd'],
- whichLabels: null,
- digits: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'],
- timeSeparator: ':',
- isRTL: false
- }
- },
- /* Class name for the right-to-left marker. */
- _rtlClass: pluginName + '-rtl',
- /* Class name for the countdown section marker. */
- _sectionClass: pluginName + '-section',
- /* Class name for the period amount marker. */
- _amountClass: pluginName + '-amount',
- /* Class name for the period name marker. */
- _periodClass: pluginName + '-period',
- /* Class name for the countdown row marker. */
- _rowClass: pluginName + '-row',
- /* Class name for the holding countdown marker. */
- _holdingClass: pluginName + '-holding',
- /* Class name for the showing countdown marker. */
- _showClass: pluginName + '-show',
- /* Class name for the description marker. */
- _descrClass: pluginName + '-descr',
- /* List of currently active countdown elements. */
- _timerElems: [],
- /** Additional setup for the countdown.
- Apply default localisations.
- Create the timer.
- @private */
- _init: function() {
- var self = this;
- this._super();
- this._serverSyncs = [];
- var now = (typeof Date.now === 'function' ? Date.now : function() { return new Date().getTime(); });
- var perfAvail = (window.performance && typeof window.performance.now === 'function');
- // Shared timer for all countdowns
- function timerCallBack(timestamp) {
- var drawStart = (timestamp < 1e12 ? // New HTML5 high resolution timer
- (perfAvail ? (window.performance.now() + window.performance.timing.navigationStart) : now()) :
- // Integer milliseconds since unix epoch
- timestamp || now());
- if (drawStart - animationStartTime >= 1000) {
- self._updateElems();
- animationStartTime = drawStart;
- }
- requestAnimationFrame(timerCallBack);
- }
- var requestAnimationFrame = window.requestAnimationFrame ||
- window.webkitRequestAnimationFrame || window.mozRequestAnimationFrame ||
- window.oRequestAnimationFrame || window.msRequestAnimationFrame || null;
- // This is when we expect a fall-back to setInterval as it's much more fluid
- var animationStartTime = 0;
- if (!requestAnimationFrame || $.noRequestAnimationFrame) {
- $.noRequestAnimationFrame = null;
- // Fall back to good old setInterval
- $.countdown._timer = setInterval(function() { self._updateElems(); }, 1000);
- }
- else {
- animationStartTime = window.animationStartTime ||
- window.webkitAnimationStartTime || window.mozAnimationStartTime ||
- window.oAnimationStartTime || window.msAnimationStartTime || now();
- requestAnimationFrame(timerCallBack);
- }
- },
- /** Convert a date/time to UTC.
- @param {number} tz The hour or minute offset from GMT, e.g. +9, -360.
- @param {Date|number} year the date/time in that timezone or the year in that timezone.
- @param {number} [month] The month (0 - 11) (omit if <code>year</code> is a <code>Date</code>).
- @param {number} [day] The day (omit if <code>year</code> is a <code>Date</code>).
- @param {number} [hours] The hour (omit if <code>year</code> is a <code>Date</code>).
- @param {number} [mins] The minute (omit if <code>year</code> is a <code>Date</code>).
- @param {number} [secs] The second (omit if <code>year</code> is a <code>Date</code>).
- @param {number} [ms] The millisecond (omit if <code>year</code> is a <code>Date</code>).
- @return {Date} The equivalent UTC date/time.
- @example $.countdown.UTCDate(+10, 2013, 12-1, 25, 12, 0)
- $.countdown.UTCDate(-7, new Date(2013, 12-1, 25, 12, 0)) */
- UTCDate: function(tz, year, month, day, hours, mins, secs, ms) {
- if (typeof year === 'object' && year instanceof Date) {
- ms = year.getMilliseconds();
- secs = year.getSeconds();
- mins = year.getMinutes();
- hours = year.getHours();
- day = year.getDate();
- month = year.getMonth();
- year = year.getFullYear();
- }
- var d = new Date();
- d.setUTCFullYear(year);
- d.setUTCDate(1);
- d.setUTCMonth(month || 0);
- d.setUTCDate(day || 1);
- d.setUTCHours(hours || 0);
- d.setUTCMinutes((mins || 0) - (Math.abs(tz) < 30 ? tz * 60 : tz));
- d.setUTCSeconds(secs || 0);
- d.setUTCMilliseconds(ms || 0);
- return d;
- },
- /** Convert a set of periods into seconds.
- Averaged for months and years.
- @param {number[]} periods The periods per year/month/week/day/hour/minute/second.
- @return {number} The corresponding number of seconds.
- @example var secs = $.countdown.periodsToSeconds(periods) */
- periodsToSeconds: function(periods) {
- return periods[0] * 31557600 + periods[1] * 2629800 + periods[2] * 604800 +
- periods[3] * 86400 + periods[4] * 3600 + periods[5] * 60 + periods[6];
- },
- /** Resynchronise the countdowns with the server.
- @example $.countdown.resync() */
- resync: function() {
- var self = this;
- $('.' + this._getMarker()).each(function() { // Each countdown
- var inst = $.data(this, self.name);
- if (inst.options.serverSync) { // If synced
- var serverSync = null;
- for (var i = 0; i < self._serverSyncs.length; i++) {
- if (self._serverSyncs[i][0] === inst.options.serverSync) { // Find sync details
- serverSync = self._serverSyncs[i];
- break;
- }
- }
- if (self._eqNull(serverSync[2])) { // Recalculate if missing
- var serverResult = ($.isFunction(inst.options.serverSync) ?
- inst.options.serverSync.apply(this, []) : null);
- serverSync[2] =
- (serverResult ? new Date().getTime() - serverResult.getTime() : 0) - serverSync[1];
- }
- if (inst._since) { // Apply difference
- inst._since.setMilliseconds(inst._since.getMilliseconds() + serverSync[2]);
- }
- inst._until.setMilliseconds(inst._until.getMilliseconds() + serverSync[2]);
- }
- });
- for (var i = 0; i < self._serverSyncs.length; i++) { // Update sync details
- if (!self._eqNull(self._serverSyncs[i][2])) {
- self._serverSyncs[i][1] += self._serverSyncs[i][2];
- delete self._serverSyncs[i][2];
- }
- }
- },
- _instSettings: function(elem, options) { // jshint unused:false
- return {_periods: [0, 0, 0, 0, 0, 0, 0]};
- },
- /** Add an element to the list of active ones.
- @private
- @param {Element} elem The countdown element. */
- _addElem: function(elem) {
- if (!this._hasElem(elem)) {
- this._timerElems.push(elem);
- }
- },
- /** See if an element is in the list of active ones.
- @private
- @param {Element} elem The countdown element.
- @return {boolean} <code>true</code> if present, <code>false</code> if not. */
- _hasElem: function(elem) {
- return ($.inArray(elem, this._timerElems) > -1);
- },
- /** Remove an element from the list of active ones.
- @private
- @param {Element} elem The countdown element. */
- _removeElem: function(elem) {
- this._timerElems = $.map(this._timerElems,
- function(value) { return (value === elem ? null : value); }); // delete entry
- },
- /** Update each active timer element.
- @private */
- _updateElems: function() {
- for (var i = this._timerElems.length - 1; i >= 0; i--) {
- this._updateCountdown(this._timerElems[i]);
- }
- },
- _optionsChanged: function(elem, inst, options) {
- if (options.layout) {
- options.layout = options.layout.replace(/</g, '<').replace(/>/g, '>');
- }
- this._resetExtraLabels(inst.options, options);
- var timezoneChanged = (inst.options.timezone !== options.timezone);
- $.extend(inst.options, options);
- this._adjustSettings(elem, inst,
- !this._eqNull(options.until) || !this._eqNull(options.since) || timezoneChanged);
- var now = new Date();
- if ((inst._since && inst._since < now) || (inst._until && inst._until > now)) {
- this._addElem(elem[0]);
- }
- this._updateCountdown(elem, inst);
- },
- /** Redisplay the countdown with an updated display.
- @private
- @param {Element|jQuery} elem The containing element.
- @param {object} inst The current settings for this instance. */
- _updateCountdown: function(elem, inst) {
- elem = elem.jquery ? elem : $(elem);
- inst = inst || this._getInst(elem);
- if (!inst) {
- return;
- }
- elem.html(this._generateHTML(inst)).toggleClass(this._rtlClass, inst.options.isRTL);
- if (inst._hold !== 'pause' && $.isFunction(inst.options.onTick)) {
- var periods = inst._hold !== 'lap' ? inst._periods :
- this._calculatePeriods(inst, inst._show, inst.options.significant, new Date());
- if (inst.options.tickInterval === 1 ||
- this.periodsToSeconds(periods) % inst.options.tickInterval === 0) {
- inst.options.onTick.apply(elem[0], [periods]);
- }
- }
- var expired = inst._hold !== 'pause' &&
- (inst._since ? inst._now.getTime() < inst._since.getTime() :
- inst._now.getTime() >= inst._until.getTime());
- if (expired && !inst._expiring) {
- inst._expiring = true;
- if (this._hasElem(elem[0]) || inst.options.alwaysExpire) {
- this._removeElem(elem[0]);
- if ($.isFunction(inst.options.onExpiry)) {
- inst.options.onExpiry.apply(elem[0], []);
- }
- if (inst.options.expiryText) {
- var layout = inst.options.layout;
- inst.options.layout = inst.options.expiryText;
- this._updateCountdown(elem[0], inst);
- inst.options.layout = layout;
- }
- if (inst.options.expiryUrl) {
- window.location = inst.options.expiryUrl;
- }
- }
- inst._expiring = false;
- }
- else if (inst._hold === 'pause') {
- this._removeElem(elem[0]);
- }
- },
- /** Reset any extra labelsn and compactLabelsn entries if changing labels.
- @private
- @param {object} base The options to be updated.
- @param {object} options The new option values. */
- _resetExtraLabels: function(base, options) {
- var n = null;
- for (n in options) {
- if (n.match(/[Ll]abels[02-9]|compactLabels1/)) {
- base[n] = options[n];
- }
- }
- for (n in base) { // Remove custom numbered labels
- if (n.match(/[Ll]abels[02-9]|compactLabels1/) && typeof options[n] === 'undefined') {
- base[n] = null;
- }
- }
- },
-
- /** Determine whether or not a value is equivalent to <code>null</code>.
- @private
- @param {object} value The value to test.
- @return {boolean} <code>true</code> if equivalent to <code>null</code>, <code>false</code> if not. */
- _eqNull: function(value) {
- return typeof value === 'undefined' || value === null;
- },
- /** Calculate internal settings for an instance.
- @private
- @param {jQuery} elem The containing element.
- @param {object} inst The current settings for this instance.
- @param {boolean} recalc <code>true</code> if until or since are set. */
- _adjustSettings: function(elem, inst, recalc) {
- var serverEntry = null;
- for (var i = 0; i < this._serverSyncs.length; i++) {
- if (this._serverSyncs[i][0] === inst.options.serverSync) {
- serverEntry = this._serverSyncs[i][1];
- break;
- }
- }
- var now = null;
- var serverOffset = null;
- if (!this._eqNull(serverEntry)) {
- now = new Date();
- serverOffset = (inst.options.serverSync ? serverEntry : 0);
- }
- else {
- var serverResult = ($.isFunction(inst.options.serverSync) ?
- inst.options.serverSync.apply(elem[0], []) : null);
- now = new Date();
- serverOffset = (serverResult ? now.getTime() - serverResult.getTime() : 0);
- this._serverSyncs.push([inst.options.serverSync, serverOffset]);
- }
- var timezone = inst.options.timezone;
- timezone = (this._eqNull(timezone) ? -now.getTimezoneOffset() : timezone);
- if (recalc || (!recalc && this._eqNull(inst._until) && this._eqNull(inst._since))) {
- inst._since = inst.options.since;
- if (!this._eqNull(inst._since)) {
- inst._since = this.UTCDate(timezone, this._determineTime(inst._since, null));
- if (inst._since && serverOffset) {
- inst._since.setMilliseconds(inst._since.getMilliseconds() + serverOffset);
- }
- }
- inst._until = this.UTCDate(timezone, this._determineTime(inst.options.until, now));
- if (serverOffset) {
- inst._until.setMilliseconds(inst._until.getMilliseconds() + serverOffset);
- }
- }
- inst._show = this._determineShow(inst);
- },
- /** Remove the countdown widget from an element.
- @private
- @param {jQuery} elem The containing element.
- @param {object} inst The current instance object. */
- _preDestroy: function(elem, inst) { // jshint unused:false
- this._removeElem(elem[0]);
- elem.empty();
- },
- /** Pause a countdown widget at the current time.
- Stop it running but remember and display the current time.
- @param {Element} elem The containing element.
- @example $(selector).countdown('pause') */
- pause: function(elem) {
- this._hold(elem, 'pause');
- },
- /** Pause a countdown widget at the current time.
- Stop the display but keep the countdown running.
- @param {Element} elem The containing element.
- @example $(selector).countdown('lap') */
- lap: function(elem) {
- this._hold(elem, 'lap');
- },
- /** Resume a paused countdown widget.
- @param {Element} elem The containing element.
- @example $(selector).countdown('resume') */
- resume: function(elem) {
- this._hold(elem, null);
- },
- /** Toggle a paused countdown widget.
- @param {Element} elem The containing element.
- @example $(selector).countdown('toggle') */
- toggle: function(elem) {
- var inst = $.data(elem, this.name) || {};
- this[!inst._hold ? 'pause' : 'resume'](elem);
- },
- /** Toggle a lapped countdown widget.
- @param {Element} elem The containing element.
- @example $(selector).countdown('toggleLap') */
- toggleLap: function(elem) {
- var inst = $.data(elem, this.name) || {};
- this[!inst._hold ? 'lap' : 'resume'](elem);
- },
- /** Pause or resume a countdown widget.
- @private
- @param {Element} elem The containing element.
- @param {string} hold The new hold setting. */
- _hold: function(elem, hold) {
- var inst = $.data(elem, this.name);
- if (inst) {
- if (inst._hold === 'pause' && !hold) {
- inst._periods = inst._savePeriods;
- var sign = (inst._since ? '-' : '+');
- inst[inst._since ? '_since' : '_until'] =
- this._determineTime(sign + inst._periods[0] + 'y' +
- sign + inst._periods[1] + 'o' + sign + inst._periods[2] + 'w' +
- sign + inst._periods[3] + 'd' + sign + inst._periods[4] + 'h' +
- sign + inst._periods[5] + 'm' + sign + inst._periods[6] + 's');
- this._addElem(elem);
- }
- inst._hold = hold;
- inst._savePeriods = (hold === 'pause' ? inst._periods : null);
- $.data(elem, this.name, inst);
- this._updateCountdown(elem, inst);
- }
- },
- /** Return the current time periods, broken down by years, months, weeks, days, hours, minutes, and seconds.
- @param {Element} elem The containing element.
- @return {number[]} The current periods for the countdown.
- @example var periods = $(selector).countdown('getTimes') */
- getTimes: function(elem) {
- var inst = $.data(elem, this.name);
- return (!inst ? null : (inst._hold === 'pause' ? inst._savePeriods : (!inst._hold ? inst._periods :
- this._calculatePeriods(inst, inst._show, inst.options.significant, new Date()))));
- },
- /** A time may be specified as an exact value or a relative one.
- @private
- @param {string|number|Date} setting The date/time value as a relative or absolute value.
- @param {Date} defaultTime The date/time to use if no other is supplied.
- @return {Date} The corresponding date/time. */
- _determineTime: function(setting, defaultTime) {
- var self = this;
- var offsetNumeric = function(offset) { // e.g. +300, -2
- var time = new Date();
- time.setTime(time.getTime() + offset * 1000);
- return time;
- };
- var offsetString = function(offset) { // e.g. '+2d', '-4w', '+3h +30m'
- offset = offset.toLowerCase();
- var time = new Date();
- var year = time.getFullYear();
- var month = time.getMonth();
- var day = time.getDate();
- var hour = time.getHours();
- var minute = time.getMinutes();
- var second = time.getSeconds();
- var pattern = /([+-]?[0-9]+)\s*(s|m|h|d|w|o|y)?/g;
- var matches = pattern.exec(offset);
- while (matches) {
- switch (matches[2] || 's') {
- case 's':
- second += parseInt(matches[1], 10);
- break;
- case 'm':
- minute += parseInt(matches[1], 10);
- break;
- case 'h':
- hour += parseInt(matches[1], 10);
- break;
- case 'd':
- day += parseInt(matches[1], 10);
- break;
- case 'w':
- day += parseInt(matches[1], 10) * 7;
- break;
- case 'o':
- month += parseInt(matches[1], 10);
- day = Math.min(day, self._getDaysInMonth(year, month));
- break;
- case 'y':
- year += parseInt(matches[1], 10);
- day = Math.min(day, self._getDaysInMonth(year, month));
- break;
- }
- matches = pattern.exec(offset);
- }
- return new Date(year, month, day, hour, minute, second, 0);
- };
- var time = (this._eqNull(setting) ? defaultTime :
- (typeof setting === 'string' ? offsetString(setting) :
- (typeof setting === 'number' ? offsetNumeric(setting) : setting)));
- if (time) {
- time.setMilliseconds(0);
- }
- return time;
- },
- /** Determine the number of days in a month.
- @private
- @param {number} year The year.
- @param {number} month The month.
- @return {number} The days in that month. */
- _getDaysInMonth: function(year, month) {
- return 32 - new Date(year, month, 32).getDate();
- },
- /** Default implementation to determine which set of labels should be used for an amount.
- Use the <code>labels</code> attribute with the same numeric suffix (if it exists).
- @private
- @param {number} num The amount to be displayed.
- @return {number} The set of labels to be used for this amount. */
- _normalLabels: function(num) {
- return num;
- },
- /** Generate the HTML to display the countdown widget.
- @private
- @param {object} inst The current settings for this instance.
- @return {string} The new HTML for the countdown display. */
- _generateHTML: function(inst) {
- var self = this;
- // Determine what to show
- inst._periods = (inst._hold ? inst._periods :
- this._calculatePeriods(inst, inst._show, inst.options.significant, new Date()));
- // Show all 'asNeeded' after first non-zero value
- var shownNonZero = false;
- var showCount = 0;
- var sigCount = inst.options.significant;
- var show = $.extend({}, inst._show);
- var period = null;
- for (period = Y; period <= S; period++) {
- shownNonZero = shownNonZero || (inst._show[period] === '?' && inst._periods[period] > 0);
- show[period] = (inst._show[period] === '?' && !shownNonZero ? null : inst._show[period]);
- showCount += (show[period] ? 1 : 0);
- sigCount -= (inst._periods[period] > 0 ? 1 : 0);
- }
- var showSignificant = [false, false, false, false, false, false, false];
- for (period = S; period >= Y; period--) { // Determine significant periods
- if (inst._show[period]) {
- if (inst._periods[period]) {
- showSignificant[period] = true;
- }
- else {
- showSignificant[period] = sigCount > 0;
- sigCount--;
- }
- }
- }
- var labels = (inst.options.compact ? inst.options.compactLabels : inst.options.labels);
- var whichLabels = inst.options.whichLabels || this._normalLabels;
- var showCompact = function(period) {
- var labelsNum = inst.options['compactLabels' + whichLabels(inst._periods[period])];
- return (show[period] ? self._translateDigits(inst, inst._periods[period]) +
- (labelsNum ? labelsNum[period] : labels[period]) + ' ' : '');
- };
- var minDigits = (inst.options.padZeroes ? 2 : 1);
- var showFull = function(period) {
- var labelsNum = inst.options['labels' + whichLabels(inst._periods[period])];
- return ((!inst.options.significant && show[period]) ||
- (inst.options.significant && showSignificant[period]) ?
- '<span class="' + self._sectionClass + '">' +
- '<span class="' + self._amountClass + '">' +
- self._minDigits(inst, inst._periods[period], minDigits) + '</span>' +
- '<span class="' + self._periodClass + '">' +
- (labelsNum ? labelsNum[period] : labels[period]) + '</span></span>' : '');
- };
- return (inst.options.layout ? this._buildLayout(inst, show, inst.options.layout,
- inst.options.compact, inst.options.significant, showSignificant) :
- ((inst.options.compact ? // Compact version
- '<span class="' + this._rowClass + ' ' + this._amountClass +
- (inst._hold ? ' ' + this._holdingClass : '') + '">' +
- showCompact(Y) + showCompact(O) + showCompact(W) + showCompact(D) +
- (show[H] ? this._minDigits(inst, inst._periods[H], 2) : '') +
- (show[M] ? (show[H] ? inst.options.timeSeparator : '') +
- this._minDigits(inst, inst._periods[M], 2) : '') +
- (show[S] ? (show[H] || show[M] ? inst.options.timeSeparator : '') +
- this._minDigits(inst, inst._periods[S], 2) : '') :
- // Full version
- '<span class="' + this._rowClass + ' ' + this._showClass + (inst.options.significant || showCount) +
- (inst._hold ? ' ' + this._holdingClass : '') + '">' +
- showFull(Y) + showFull(O) + showFull(W) + showFull(D) +
- showFull(H) + showFull(M) + showFull(S)) + '</span>' +
- (inst.options.description ? '<span class="' + this._rowClass + ' ' + this._descrClass + '">' +
- inst.options.description + '</span>' : '')));
- },
- /** Construct a custom layout.
- @private
- @param {object} inst The current settings for this instance.
- @param {boolean[]} show Flags indicating which periods are requested.
- @param {string} layout The customised layout.
- @param {boolean} compact <code>true</code> if using compact labels.
- @param {number} significant The number of periods with values to show, zero for all.
- @param {boolean[]} showSignificant Other periods to show for significance.
- @return {string} The custom HTML. */
- _buildLayout: function(inst, show, layout, compact, significant, showSignificant) {
- var labels = inst.options[compact ? 'compactLabels' : 'labels'];
- var whichLabels = inst.options.whichLabels || this._normalLabels;
- var labelFor = function(index) {
- return (inst.options[(compact ? 'compactLabels' : 'labels') +
- whichLabels(inst._periods[index])] || labels)[index];
- };
- var digit = function(value, position) {
- return inst.options.digits[Math.floor(value / position) % 10];
- };
- var subs = {desc: inst.options.description, sep: inst.options.timeSeparator,
- yl: labelFor(Y), yn: this._minDigits(inst, inst._periods[Y], 1),
- ynn: this._minDigits(inst, inst._periods[Y], 2),
- ynnn: this._minDigits(inst, inst._periods[Y], 3), y1: digit(inst._periods[Y], 1),
- y10: digit(inst._periods[Y], 10), y100: digit(inst._periods[Y], 100),
- y1000: digit(inst._periods[Y], 1000),
- ol: labelFor(O), on: this._minDigits(inst, inst._periods[O], 1),
- onn: this._minDigits(inst, inst._periods[O], 2),
- onnn: this._minDigits(inst, inst._periods[O], 3), o1: digit(inst._periods[O], 1),
- o10: digit(inst._periods[O], 10), o100: digit(inst._periods[O], 100),
- o1000: digit(inst._periods[O], 1000),
- wl: labelFor(W), wn: this._minDigits(inst, inst._periods[W], 1),
- wnn: this._minDigits(inst, inst._periods[W], 2),
- wnnn: this._minDigits(inst, inst._periods[W], 3), w1: digit(inst._periods[W], 1),
- w10: digit(inst._periods[W], 10), w100: digit(inst._periods[W], 100),
- w1000: digit(inst._periods[W], 1000),
- dl: labelFor(D), dn: this._minDigits(inst, inst._periods[D], 1),
- dnn: this._minDigits(inst, inst._periods[D], 2),
- dnnn: this._minDigits(inst, inst._periods[D], 3), d1: digit(inst._periods[D], 1),
- d10: digit(inst._periods[D], 10), d100: digit(inst._periods[D], 100),
- d1000: digit(inst._periods[D], 1000),
- hl: labelFor(H), hn: this._minDigits(inst, inst._periods[H], 1),
- hnn: this._minDigits(inst, inst._periods[H], 2),
- hnnn: this._minDigits(inst, inst._periods[H], 3), h1: digit(inst._periods[H], 1),
- h10: digit(inst._periods[H], 10), h100: digit(inst._periods[H], 100),
- h1000: digit(inst._periods[H], 1000),
- ml: labelFor(M), mn: this._minDigits(inst, inst._periods[M], 1),
- mnn: this._minDigits(inst, inst._periods[M], 2),
- mnnn: this._minDigits(inst, inst._periods[M], 3), m1: digit(inst._periods[M], 1),
- m10: digit(inst._periods[M], 10), m100: digit(inst._periods[M], 100),
- m1000: digit(inst._periods[M], 1000),
- sl: labelFor(S), sn: this._minDigits(inst, inst._periods[S], 1),
- snn: this._minDigits(inst, inst._periods[S], 2),
- snnn: this._minDigits(inst, inst._periods[S], 3), s1: digit(inst._periods[S], 1),
- s10: digit(inst._periods[S], 10), s100: digit(inst._periods[S], 100),
- s1000: digit(inst._periods[S], 1000)};
- var html = layout;
- // Replace period containers: {p<}...{p>}
- for (var i = Y; i <= S; i++) {
- var period = 'yowdhms'.charAt(i);
- var re = new RegExp('\\{' + period + '<\\}([\\s\\S]*)\\{' + period + '>\\}', 'g');
- html = html.replace(re, ((!significant && show[i]) ||
- (significant && showSignificant[i]) ? '$1' : ''));
- }
- // Replace period values: {pn}
- $.each(subs, function(n, v) {
- var re = new RegExp('\\{' + n + '\\}', 'g');
- html = html.replace(re, v);
- });
- return html;
- },
- /** Ensure a numeric value has at least n digits for display.
- @private
- @param {object} inst The current settings for this instance.
- @param {number} value The value to display.
- @param {number} len The minimum length.
- @return {string} The display text. */
- _minDigits: function(inst, value, len) {
- value = '' + value;
- if (value.length >= len) {
- return this._translateDigits(inst, value);
- }
- value = '0000000000' + value;
- return this._translateDigits(inst, value.substr(value.length - len));
- },
- /** Translate digits into other representations.
- @private
- @param {object} inst The current settings for this instance.
- @param {string} value The text to translate.
- @return {string} The translated text. */
- _translateDigits: function(inst, value) {
- return ('' + value).replace(/[0-9]/g, function(digit) {
- return inst.options.digits[digit];
- });
- },
- /** Translate the format into flags for each period.
- @private
- @param {object} inst The current settings for this instance.
- @return {string[]} Flags indicating which periods are requested (?) or
- required (!) by year, month, week, day, hour, minute, second. */
- _determineShow: function(inst) {
- var format = inst.options.format;
- var show = [];
- show[Y] = (format.match('y') ? '?' : (format.match('Y') ? '!' : null));
- show[O] = (format.match('o') ? '?' : (format.match('O') ? '!' : null));
- show[W] = (format.match('w') ? '?' : (format.match('W') ? '!' : null));
- show[D] = (format.match('d') ? '?' : (format.match('D') ? '!' : null));
- show[H] = (format.match('h') ? '?' : (format.match('H') ? '!' : null));
- show[M] = (format.match('m') ? '?' : (format.match('M') ? '!' : null));
- show[S] = (format.match('s') ? '?' : (format.match('S') ? '!' : null));
- return show;
- },
- /** Calculate the requested periods between now and the target time.
- @private
- @param {object} inst The current settings for this instance.
- @param {string[]} show Flags indicating which periods are requested/required.
- @param {number} significant The number of periods with values to show, zero for all.
- @param {Date} now The current date and time.
- @return {number[]} The current time periods (always positive)
- by year, month, week, day, hour, minute, second. */
- _calculatePeriods: function(inst, show, significant, now) {
- // Find endpoints
- inst._now = now;
- inst._now.setMilliseconds(0);
- var until = new Date(inst._now.getTime());
- if (inst._since) {
- if (now.getTime() < inst._since.getTime()) {
- inst._now = now = until;
- }
- else {
- now = inst._since;
- }
- }
- else {
- until.setTime(inst._until.getTime());
- if (now.getTime() > inst._until.getTime()) {
- inst._now = now = until;
- }
- }
- // Calculate differences by period
- var periods = [0, 0, 0, 0, 0, 0, 0];
- if (show[Y] || show[O]) {
- // Treat end of months as the same
- var lastNow = this._getDaysInMonth(now.getFullYear(), now.getMonth());
- var lastUntil = this._getDaysInMonth(until.getFullYear(), until.getMonth());
- var sameDay = (until.getDate() === now.getDate() ||
- (until.getDate() >= Math.min(lastNow, lastUntil) &&
- now.getDate() >= Math.min(lastNow, lastUntil)));
- var getSecs = function(date) {
- return (date.getHours() * 60 + date.getMinutes()) * 60 + date.getSeconds();
- };
- var months = Math.max(0,
- (until.getFullYear() - now.getFullYear()) * 12 + until.getMonth() - now.getMonth() +
- ((until.getDate() < now.getDate() && !sameDay) ||
- (sameDay && getSecs(until) < getSecs(now)) ? -1 : 0));
- periods[Y] = (show[Y] ? Math.floor(months / 12) : 0);
- periods[O] = (show[O] ? months - periods[Y] * 12 : 0);
- // Adjust for months difference and end of month if necessary
- now = new Date(now.getTime());
- var wasLastDay = (now.getDate() === lastNow);
- var lastDay = this._getDaysInMonth(now.getFullYear() + periods[Y],
- now.getMonth() + periods[O]);
- if (now.getDate() > lastDay) {
- now.setDate(lastDay);
- }
- now.setFullYear(now.getFullYear() + periods[Y]);
- now.setMonth(now.getMonth() + periods[O]);
- if (wasLastDay) {
- now.setDate(lastDay);
- }
- }
- var diff = Math.floor((until.getTime() - now.getTime()) / 1000);
- var period = null;
- var extractPeriod = function(period, numSecs) {
- periods[period] = (show[period] ? Math.floor(diff / numSecs) : 0);
- diff -= periods[period] * numSecs;
- };
- extractPeriod(W, 604800);
- extractPeriod(D, 86400);
- extractPeriod(H, 3600);
- extractPeriod(M, 60);
- extractPeriod(S, 1);
- if (diff > 0 && !inst._since) { // Round up if left overs
- var multiplier = [1, 12, 4.3482, 7, 24, 60, 60];
- var lastShown = S;
- var max = 1;
- for (period = S; period >= Y; period--) {
- if (show[period]) {
- if (periods[lastShown] >= max) {
- periods[lastShown] = 0;
- diff = 1;
- }
- if (diff > 0) {
- periods[period]++;
- diff = 0;
- lastShown = period;
- max = 1;
- }
- }
- max *= multiplier[period];
- }
- }
- if (significant) { // Zero out insignificant periods
- for (period = Y; period <= S; period++) {
- if (significant && periods[period]) {
- significant--;
- }
- else if (!significant) {
- periods[period] = 0;
- }
- }
- }
- return periods;
- }
- });
- })(jQuery);
|