Using Joomla Ajax Interface/ru: Difference between revisions

Latest revision as of 07:01, 4 November 2021

Joomla!

≥ 3.2

серия

Что такое AJAX интерфейс Joomla! (com_ajax)

Компактный, расширяемый компонент, действующий в качестве точки входа для HTTP запросов для автономных модулей и плагинов, тем самым предоставляя им потенциал функциональности AJAX. Com_ajax в основном используют в тех случаях, когда не являются разработчиками того компонента, с которым взаимодействует модуль или плагин.

ПРИМЕЧАНИЕ: Если Вы разработчик компонентов, то нет необходимости применять в нем com_ajax для реализации функционала AJAX. Вы можете это сделать напрямую в своем компоненте.

Примеры применения:

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

Анатомия AJAX запроса

Требуется

option=com_ajax
[module|plugin]=name
format=[json|debug|raw]

Опционально

method=[custom fragment] по умолчанию становится get, если не указано.

Обзор

Все запросы начинаются с ?option=com_ajax, который вызывает это расширение, должны содержать в себе тип расширения для вызова и формат возвращаемых данных.

Дополнительные переменные и значения, используемые вашим расширением также могут быть включены в URL.

Например запрос к ?option=com_ajax&module=session вызовет mod_session с результатами, возвращенными в формате по умолчанию. Код ?option=com_ajax&plugin=session&format=json вызовет метод onAjaxSession плагинов с выводом результата в JSON.

Поддержка модулей

Обобщение

Поддержка модулей реализована вызовом метода в файле helper.php модуля.

Детали

Запросы модуля должны включать в себя переменную module в URL, в паре с именем модуля (например: module=session для mod_session). Обратите внимание на то, что в названии модуля не должно быть символов подчеркивания - "_" без учёта префикса mod_. Например, обратиться по ajax к модулю с названием mod_virtuemart_products не получится. Название модуля должно быть mod_virtuemartproducts, а вызов по ajax module=virtuemartproducts. Однако, это ограничение не действительно для плагинов, где название плагина может содержать символы подчёркивания.

Это значение также используется для:

Имени директории для проверки файла помощника, например /modules/mod_session/helper.php

Наименование класса для вызова, например:

modSessionHelper

Опционально может быть включена переменная method для отмены префикса метода get по умолчанию.

"'Примечание"': все методы должны заканчиваться на Ajax. Например:

method=mySuperAwesomeMethodToTrigger вызовет mySuperAwesomeMethodToTriggerAjax

Ajax Session Module является примером модуля, демонстрирующего такую функциональность.

Ответ плагинов

Обобщение

Поддержка плагинов достигается путем запуска события. плагина onAjax[Name] .

Детали

Запросы плагинов должны включать в себя переменнуюplugin в URL в паре с событием плагина, например plugin=session для onAjaxSession.

Это значение также используется для:

Имени класса плагина, который следует соглашению plgAjax[Name]
Имени функции, которая следует соглашению onAjax[Name]/
Группа плагинов по умолчанию ajax. Вы можете сменить её, указав параметр запроса group (начиная с Joomla! 3.4).

Ajax Latest Articles plugin пример плагина, демонстрирующего такую функциональность.

Формат Ответа

format=[json|debug] необязательный аргумент для формата результатов.

json для формата JSON
debug для человекочитаемого вывода результатов./ru/ru/ru

@@ Line 2: / Line 2: @@
 <noinclude>{{Joomla version|version=3.2|time=and after|comment=серия}}</noinclude>
 {{-}}
-==What is The Joomla Ajax Interface (com_ajax)==
+==Что такое AJAX интерфейс Joomla! (com_ajax)==
-A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.
+Компактный, расширяемый компонент, действующий в качестве точки входа для HTTP запросов для автономных модулей и плагинов, тем самым предоставляя им потенциал функциональности AJAX. Com_ajax в основном используют в тех случаях, когда не являются разработчиками того компонента, с которым взаимодействует модуль или плагин.
-'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.
+'''ПРИМЕЧАНИЕ''': Если Вы разработчик компонентов, то нет необходимости применять в нем com_ajax для реализации  функционала AJAX. Вы можете это сделать напрямую в своем компоненте.
-Examples of use cases include, but are not limited to:
+Примеры применения:
-*A module that retrieves data from an external API
+*Модуль, получающий данные из внешнего API.
-*A module that interacts with a component that you did not develop
+*Модуль, взаимодействующий с компонентом, который разработан не вами.
-*A plugin that implement API like functionality to allow consumption of data from your site
+* Плагин, реализующий схожую с API функциональность для организации потребления данных с Вашего сайта.
-==Anatomy of an Ajax Request==
+==Анатомия AJAX запроса==
-===Required===
+===Требуется===
 *<code>option=com_ajax</code>
@@ Line 20: / Line 20: @@
 *<code>format=[json|debug|raw]</code>
-===Optional===
+===Опционально===
-*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.
+*<code>method=[custom fragment]</code> по умолчанию становится <code>get</code>, если не указано.
-===Overview===
+===Обзор===
-All requests begin with <code>?option=com_ajax</code>, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.
+Все запросы начинаются с <code>?option=com_ajax</code>, который вызывает это расширение, должны содержать в себе тип расширения для вызова и формат возвращаемых данных.
-Additional variables and values used by your extension may also be included in the URL.
+Дополнительные переменные и значения, используемые вашим расширением также могут быть включены в URL.
-For example, a request to <code>?option=com_ajax&amp;module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&amp;plugin=session&amp;format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.
+Например запрос к <code>?option=com_ajax&amp;module=session</code> вызовет <code>mod_session</code> с результатами, возвращенными в формате по умолчанию. Код <code>?option=com_ajax&amp;plugin=session&amp;format=json</code>
+вызовет метод <code>onAjaxSession</code> плагинов с выводом результата в JSON.
-==Module Support==
+==Поддержка модулей==
-===Summary===
+===Обобщение===
-Module support is accomplished by calling a method in the module's <code>helper.php</code> file.
+Поддержка модулей реализована вызовом метода в файле <code>helper.php</code> модуля.
-===Details===
+===Детали===
-Module requests must include the <code>module</code> variable in the URL, paired with the name of the module (i.e. <code>module=session</code> for <code>mod_session</code>).
+Запросы модуля должны включать в себя переменную <code>module</code> в URL, в паре с именем модуля (например: <code>module=session</code> для <code>mod_session</code>). Обратите внимание на то, что в названии модуля не должно быть символов подчеркивания - "_"  без учёта префикса <code>mod_</code>. Например, обратиться по ajax к модулю с названием <code>mod_virtuemart_products</code> не получится. Название модуля должно быть <code>mod_virtuemartproducts</code>, а вызов по ajax <code>module=virtuemartproducts</code>. Однако, это ограничение не действительно для плагинов, где название плагина может содержать символы подчёркивания.
-This value is also used for:
+Это значение также используется для:
-*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>
+* Имени директории для проверки файла помощника, например <code>/modules/mod_session/helper.php</code>
-*The class name to call, e.g. <code>modSessionHelper</code>
+*Наименование класса для вызова, например:
+<code>modSessionHelper</code>
-Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.
+Опционально может быть включена переменная <code>method</code> для отмены префикса метода <code>get</code> по умолчанию.
-:'''NOTE''': All methods must end in <code>Ajax</code>. For example:
+:"'Примечание"': все методы должны заканчиваться на <code>Ajax</code>. Например:
-:<code>method=mySuperAwesomeMethodToTrigger</code> will call <code>mySuperAwesomeMethodToTriggerAjax</code>
+:<code>method=mySuperAwesomeMethodToTrigger</code> вызовет <code>mySuperAwesomeMethodToTriggerAjax</code>
-The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.
+[https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] является примером модуля, демонстрирующего такую функциональность.
-==Plugin Response==
+==Ответ плагинов==
-===Summary===
+===Обобщение===
-Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.
+Поддержка плагинов достигается путем запуска события. плагина <code>onAjax[Name]</code> .
-===Details===
+===Детали===
-Plugin requests must include the <code>plugin</code> variable in the URL, paired with the name of the plugin event, e.g. <code>plugin=session</code> for <code>onAjaxSession</code>.
+Запросы плагинов должны включать в себя переменную<code>plugin</code> в URL в паре с событием плагина, например <code>plugin=session</code> для <code>onAjaxSession</code>.
-This value is also used for:
+Это значение также используется для:
-*The plugin class name following the <code>plgAjax[Name]</code> convention.
+*Имени класса плагина, который следует соглашению <code>plgAjax[Name]</code>
-*The plugin function name following the <code>onAjax[Name]</code> convention.
+*Имени функции, которая следует соглашению <code>onAjax[Name]</code>/
-*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla! 3.4)
+*Группа плагинов по умолчанию <code>ajax</code>. Вы можете сменить её, указав параметр запроса <code>group</code> (начиная с Joomla! 3.4).
-The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.
+[https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] пример плагина, демонстрирующего такую функциональность.
-==Response Format==
+==Формат Ответа==
-<code>format=[json|debug]</code> is an optional argument for the results format:
+<code>format=[json|debug]</code> необязательный аргумент для формата результатов.
-*<code>json</code> for JSON format
+*<code>json</code> для формата JSON
-*<code>debug</code> for human-readable output of the results.
+*<code>debug</code> для человекочитаемого вывода результатов.
-[[Category:AJAX]]
+[[Category:AJAX]]/ru
-[[Category:JavaScript]]
+[[Category:JavaScript]]/ru
-[[Category:Development]]
+[[Category:Development]]/ru

Using Joomla Ajax Interface/ru: Difference between revisions

From Joomla! Documentation

Latest revision as of 07:01, 4 November 2021

Contents

Что такое AJAX интерфейс Joomla! (com_ajax)

Анатомия AJAX запроса

Требуется

Опционально

Обзор

Поддержка модулей

Обобщение

Детали

Ответ плагинов

Обобщение

Детали

Формат Ответа