JavaScript. Подробное руководство, 6-е издание, стр. 329

jQuery.fn.println = function() {

<b>  // Объединить все аргументы в одну строку, разделив их пробелами </b>

 var msg = Array.prototype.join.call(arguments, " ");

 // Обойти в цикле все элементы в объекте jQuery

 this.each(function() {

<b>    // В конец каждого из них добавить строку с простым текстом и &lt;br/&gt;. </b>

 jQuery(this).append(document.createTextNode(msg)).append(" ");

 });

<b>  // Вернуть объект jQuery, чтобы обеспечить возможность составления цепочек </b>

 return this;

};

Определив эту функцию

jQuery.fn.println

, мы получаем возможность вызывать метод

println()

относительно любого объекта jQuery, как показано ниже:

$( "#debug").println("x = ”, х, у = ", у);

jQuery.fn

постоянно добавляются новые методы. Если обнаружится, что приходится «вручную» выполнять обход элементов в объекте

jQuery

с помощью метода

each()

и выполнять над ними некоторые операции, - это повод задуматься о необходимости реструктуризации программного кода, чтобы переместить вызов метода

each()

в дополнительный метод. Если при создании такого метода следовать приемам модульного программирования и соблюдать некоторые соглашения, принятые в библиотеке jQuery, этот дополнительный метод можно назвать расширением и поделиться им с другими. Ниже приводится перечень соглашений, которым необходимо следовать при создании расширений для библиотеки jQuery:

• Не полагайтесь на идентификатор

$

: подключающая страница может вызывать функцию

jQuery.noConflict()

, после чего

$()

уже не будет синонимом функции

jQuery()

. В коротких расширениях, как в примере выше, можно просто использовать имя

jQuery

вместо

$

. Если вы создаете большое расширение, то вы наверняка обернете его единственной анонимной функцией, чтобы избежать создания глобальных переменных. В этом случае можно использовать распространенный прием передачи ссылки на функцию

jQuery

в виде аргумента и принимать это значение в параметре с именем $:

(function($) { // Анонимная функция с одним параметром $

 // Здесь находится реализация расширения 

}(jQuery)); // Вызвать функцию с объектом jQuery в виде аргумента 

• Если метод расширения не должен возвращать какое-то свое значение, он должен возвращать объект

jQuery

, чтобы этот метод можно было использовать в цепочках вызовов. Обычно этот объект передается методам в виде ссылки

this

, которую можно просто вернуть вызывающей программе. Метод в примере выше завершается строкой

return this;

. Некоторые методы можно немного сократить (и сделать их сложнее для понимания), используя еще один распространенный прием: возвращая результат метода

each().

Например, метод
println()
мог бы содержать программный код

return this.each(function() {...});

• Если метод расширения принимает более двух параметров или параметров настройки, дайте пользователю метода передавать параметры в форме объекта (как мы видели на примере метода

animate()

в разделе 19.5.2 и функции

jQuery.ajax()

в разделе 19.6.3).

• Не засоряйте пространство имен jQuery лишними методами. Правильно оформленные расширения для библиотеки jQuery определяют минимальное количество методов, образуя непротиворечивый и удобный прикладной интерфейс. Обычно расширения jQuery определяют в объекте

jQuery.fn

единственный метод. Этот метод принимает в первом аргументе строку и интерпретирует ее как имя функции, которой следует передать остальные аргументы. Если расширение определяет единственный метод, его имя должно совпадать с именем расширения. Если необходимо определить более одного метода, в именах методов следует использовать имя расширения в качестве префикса.

• Если расширение привязывает обработчики событий, их следует поместить в пространство имен событий (раздел 19.4.4). В качестве имени пространства имен следует использовать имя расширения.

• Если расширение использует метод

data()

для связывания данных с элементами, все данные следует помещать в единственный объект и хранить его как единственное значение, дав ему имя, совпадающее с именем расширения.

• Файл с программным кодом расширения должен иметь имя в формате «jquery.plugin.js», где подстроку «plugin» следует заменить на имя расширения.

Расширения могут определять новые вспомогательные функции, добавляя их в сам объект

jQuery

. Например:

<b>// Этот метод выводит свои аргументы (с помощью метода расширения println())</b>

<b>// в элемент с атрибутом id= &quot;debug&quot;. Если такой элемент отсутствует, он будет </b>

// создан и добавлен в документ. 

jQuery.debug = function() {

 var elt = jQuery("#debug"); // Отыскать элемент #debug

 if (elt.length == 0) { // Создать, если он отсутствует

 elt = jQuery("<div id='debug'><h1>Debugging Output</h1></div>");

 jQuery(document.body). append(elt);