defr/drupal/core: misc/drupal.js comparison

comparison misc/drupal.js @ 1:c1f4ac30525a 6.0

Drupal 6.0

author	Franck Deroche <webmaster@defr.org>
date	Tue, 23 Dec 2008 14:28:28 +0100
parents
children	165d43f946a8

comparison

equal deleted inserted replaced

-:5a113a1c4740
+:c1f4ac30525a
+// $Id: drupal.js,v 1.41.2.1 2008/02/06 12:18:04 goba Exp $
+var Drupal = Drupal || { 'settings': {}, 'behaviors': {}, 'themes': {}, 'locale': {} };
+/**
+* Set the variable that indicates if JavaScript behaviors should be applied
+*/
+Drupal.jsEnabled = document.getElementsByTagName && document.createElement && document.createTextNode && document.documentElement && document.getElementById;
+/**
+* Attach all registered behaviors to a page element.
+*
+* Behaviors are event-triggered actions that attach to page elements, enhancing
+* default non-Javascript UIs. Behaviors are registered in the Drupal.behaviors
+* object as follows:
+* @code
+*    Drupal.behaviors.behaviorName = function () {
+*      ...
+*    };
+* @endcode
+*
+* Drupal.attachBehaviors is added below to the jQuery ready event and so
+* runs on initial page load. Developers implementing AHAH/AJAX in their
+* solutions should also call this function after new page content has been
+* loaded, feeding in an element to be processed, in order to attach all
+* behaviors to the new content.
+*
+* Behaviors should use a class in the form behaviorName-processed to ensure
+* the behavior is attached only once to a given element. (Doing so enables
+* the reprocessing of given elements, which may be needed on occasion despite
+* the ability to limit behavior attachment to a particular element.)
+*
+* @param context
+*   An element to attach behaviors to. If none is given, the document element
+*   is used.
+*/
+Drupal.attachBehaviors = function(context) {
+context = context || document;
+if (Drupal.jsEnabled) {
+// Execute all of them.
+jQuery.each(Drupal.behaviors, function() {
+this(context);
+});
+}
+};
+/**
+* Encode special characters in a plain-text string for display as HTML.
+*/
+Drupal.checkPlain = function(str) {
+str = String(str);
+var replace = { '&': '&amp;', '"': '&quot;', '<': '&lt;', '>': '&gt;' };
+for (var character in replace) {
+str = str.replace(character, replace[character]);
+}
+return str;
+};
+/**
+* Translate strings to the page language or a given language.
+*
+* See the documentation of the server-side t() function for further details.
+*
+* @param str
+*   A string containing the English string to translate.
+* @param args
+*   An object of replacements pairs to make after translation. Incidences
+*   of any key in this array are replaced with the corresponding value.
+*   Based on the first character of the key, the value is escaped and/or themed:
+*    - !variable: inserted as is
+*    - @variable: escape plain text to HTML (Drupal.checkPlain)
+*    - %variable: escape text and theme as a placeholder for user-submitted
+*      content (checkPlain + Drupal.theme('placeholder'))
+* @return
+*   The translated string.
+*/
+Drupal.t = function(str, args) {
+// Fetch the localized version of the string.
+if (Drupal.locale.strings && Drupal.locale.strings[str]) {
+str = Drupal.locale.strings[str];
+}
+if (args) {
+// Transform arguments before inserting them
+for (var key in args) {
+switch (key.charAt(0)) {
+// Escaped only
+case '@':
+args[key] = Drupal.checkPlain(args[key]);
+break;
+// Pass-through
+case '!':
+break;
+// Escaped and placeholder
+case '%':
+default:
+args[key] = Drupal.theme('placeholder', args[key]);
+break;
+}
+str = str.replace(key, args[key]);
+}
+}
+return str;
+};
+/**
+* Format a string containing a count of items.
+*
+* This function ensures that the string is pluralized correctly. Since Drupal.t() is
+* called by this function, make sure not to pass already-localized strings to it.
+*
+* See the documentation of the server-side format_plural() function for further details.
+*
+* @param count
+*   The item count to display.
+* @param singular
+*   The string for the singular case. Please make sure it is clear this is
+*   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
+*   Do not use @count in the singular string.
+* @param plural
+*   The string for the plural case. Please make sure it is clear this is plural,
+*   to ease translation. Use @count in place of the item count, as in "@count
+*   new comments".
+* @param args
+*   An object of replacements pairs to make after translation. Incidences
+*   of any key in this array are replaced with the corresponding value.
+*   Based on the first character of the key, the value is escaped and/or themed:
+*    - !variable: inserted as is
+*    - @variable: escape plain text to HTML (Drupal.checkPlain)
+*    - %variable: escape text and theme as a placeholder for user-submitted
+*      content (checkPlain + Drupal.theme('placeholder'))
+*   Note that you do not need to include @count in this array.
+*   This replacement is done automatically for the plural case.
+* @return
+*   A translated string.
+*/
+Drupal.formatPlural = function(count, singular, plural, args) {
+var args = args || {};
+args['@count'] = count;
+// Determine the index of the plural form.
+var index = Drupal.locale.pluralFormula ? Drupal.locale.pluralFormula(args['@count']) : ((args['@count'] == 1) ? 0 : 1);
+if (index == 0) {
+return Drupal.t(singular, args);
+}
+else if (index == 1) {
+return Drupal.t(plural, args);
+}
+else {
+args['@count['+ index +']'] = args['@count'];
+delete args['@count'];
+return Drupal.t(plural.replace('@count', '@count['+ index +']'));
+}
+};
+/**
+* Generate the themed representation of a Drupal object.
+*
+* All requests for themed output must go through this function. It examines
+* the request and routes it to the appropriate theme function. If the current
+* theme does not provide an override function, the generic theme function is
+* called.
+*
+* For example, to retrieve the HTML that is output by theme_placeholder(text),
+* call Drupal.theme('placeholder', text).
+*
+* @param func
+*   The name of the theme function to call.
+* @param ...
+*   Additional arguments to pass along to the theme function.
+* @return
+*   Any data the theme function returns. This could be a plain HTML string,
+*   but also a complex object.
+*/
+Drupal.theme = function(func) {
+for (var i = 1, args = []; i < arguments.length; i++) {
+args.push(arguments[i]);
+}
+return (Drupal.theme[func] || Drupal.theme.prototype[func]).apply(this, args);
+};
+/**
+* Parse a JSON response.
+*
+* The result is either the JSON object, or an object with 'status' 0 and 'data' an error message.
+*/
+Drupal.parseJson = function (data) {
+if ((data.substring(0, 1) != '{') && (data.substring(0, 1) != '[')) {
+return { status: 0, data: data.length ? data : Drupal.t('Unspecified error') };
+}
+return eval('(' + data + ');');
+};
+/**
+* Freeze the current body height (as minimum height). Used to prevent
+* unnecessary upwards scrolling when doing DOM manipulations.
+*/
+Drupal.freezeHeight = function () {
+Drupal.unfreezeHeight();
+var div = document.createElement('div');
+$(div).css({
+position: 'absolute',
+top: '0px',
+left: '0px',
+width: '1px',
+height: $('body').css('height')
+}).attr('id', 'freeze-height');
+$('body').append(div);
+};
+/**
+* Unfreeze the body height
+*/
+Drupal.unfreezeHeight = function () {
+$('#freeze-height').remove();
+};
+/**
+* Wrapper to address the mod_rewrite url encoding bug
+* (equivalent of drupal_urlencode() in PHP).
+*/
+Drupal.encodeURIComponent = function (item, uri) {
+uri = uri || location.href;
+item = encodeURIComponent(item).replace(/%2F/g, '/');
+return (uri.indexOf('?q=') != -1) ? item : item.replace(/%26/g, '%2526').replace(/%23/g, '%2523').replace(/\/\//g, '/%252F');
+};
+/**
+* Get the text selection in a textarea.
+*/
+Drupal.getSelection = function (element) {
+if (typeof(element.selectionStart) != 'number' && document.selection) {
+// The current selection
+var range1 = document.selection.createRange();
+var range2 = range1.duplicate();
+// Select all text.
+range2.moveToElementText(element);
+// Now move 'dummy' end point to end point of original range.
+range2.setEndPoint('EndToEnd', range1);
+// Now we can calculate start and end points.
+var start = range2.text.length - range1.text.length;
+var end = start + range1.text.length;
+return { 'start': start, 'end': end };
+}
+return { 'start': element.selectionStart, 'end': element.selectionEnd };
+};
+/**
+* Build an error message from ahah response.
+*/
+Drupal.ahahError = function(xmlhttp, uri) {
+if (xmlhttp.status == 200) {
+if (jQuery.trim($(xmlhttp.responseText).text())) {
+var message = Drupal.t("An error occurred. \n@uri\n@text", {'@uri': uri, '@text': xmlhttp.responseText });
+}
+else {
+var message = Drupal.t("An error occurred. \n@uri\n(no information available).", {'@uri': uri, '@text': xmlhttp.responseText });
+}
+}
+else {
+var message = Drupal.t("An HTTP error @status occurred. \n@uri", {'@uri': uri, '@status': xmlhttp.status });
+}
+return message;
+}
+// Global Killswitch on the <html> element
+if (Drupal.jsEnabled) {
+// Global Killswitch on the <html> element
+document.documentElement.className = 'js';
+// 'js enabled' cookie
+document.cookie = 'has_js=1; path=/';
+// Attach all behaviors.
+$(document).ready(function() {
+Drupal.attachBehaviors(this);
+});
+}
+/**
+* The default themes.
+*/
+Drupal.theme.prototype = {
+/**
+* Formats text for emphasized display in a placeholder inside a sentence.
+*
+* @param str
+*   The text to format (plain-text).
+* @return
+*   The formatted text (html).
+*/
+placeholder: function(str) {
+return '<em>' + Drupal.checkPlain(str) + '</em>';
+}
+};