Руководства по API

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

Каждое руководство по API включает пример кода, который вы можете скопировать и установить в своей среде разработки. Как правило, эти примеры кода пишутся для включения и установки в качестве модуля Joomla, поэтому, если вы не знакомы с разработкой модулей Joomla, вам может быть полезно пройти короткую серию статей «Создание простого модуля».

Примерно в версии Joomla 3.8 команда разработчиков Joomla начала изменять соглашение об именах классов Joomla для использования пространств имен, так что, например, JFactory изменился на Factory в пространстве имен Joomla\CMS. Когда вы читаете существующий код и документацию Joomla, вы можете найти классы, соответствующие либо новому, либо старому стандарту именования. Вы можете найти сопоставление между двумя соглашениями об именах в файле library/classmap.php в вашем экземпляре Joomla.

Базовые классы приложений, их иерархия и назначение описаны в разделе Общие сведения о классах приложений.
Обработка Ajax в компонентах Joomla описана в JSON-ответах с JResponseJson. Ajax также можно использовать в модулях и плагинах Joomla, как описано в разделе «Использование интерфейса Joomla Ajax».
Cache — как использовать кэш обратного вызова в вашем коде.
Категории Использование классов Categories и CategoryNode для доступа к данным, относящимся к категориям Joomla
CSS можно добавить, как описано в разделе «Добавление JavaScript и CSS на страницу»
База данных/JDatabase. Существует два руководства по API, посвященные выбору данных с использованием JDatabase и вставке, обновлению и удалению данных с использованием JDatabase.
Date/JDate — это класс даты Joomla.
Файлы и папки. См. Как использовать пакет файловой системы..
Form / JForm. Существует базовое руководство по использованию API форм Joomla и включению форм в компонент Joomla, а также более расширенное руководство по формам, охватывающее более сложные аспекты API.
FormField / JFormField. Этот класс и связанные с ним классы, такие как JFormFieldList, которые унаследованы от него, в первую очередь полезны для определения настраиваемых полей формы, как описано в разделе Создание настраиваемого типа поля формы.
Input / JInput Использование класса Input для получения значений параметров в HTTP-запросах GET и POST
JavaScript можно добавить, как описано в разделе «Добавление JavaScript и CSS на страницу»
Использование макетов Joomla описано в разделе Совместное использование макетов в представлениях или расширениях с помощью JLayout. Гибкость была увеличена в Joomla 3.2, как описано в разделе Улучшения JLayout для Joomla!.
Log / JLog Записывает сообщения журнала (например, сообщения об ошибках, отладочные сообщения) в файл журнала и при необходимости на отладочную консоль.
Menu and Menuitems
Вложенные наборы, которые позволяют реализовать иерархию дерева в таблице базы данных, используются в меню Joomla, статьях, категориях и т. д.
Registry/JRegistry - это служебный класс, который очень полезен для обработки массивов PHP, преобразования в JSON и т.д.
JResponseJson поддерживает ответы в формате JSON на запросы Ajax.
Route / JRoute см. URL-адреса в Joomla
Table / JTable предоставляет функциональные возможности для выполнения операций CRUD (и не только) над таблицами базы данных. Руководство разделено на базовое руководство по API и расширенное руководство по API
Контроллеры (BaseController, AdminController, FormController, ApiController) отвечают за анализ запроса пользователя, проверку того, что пользователю разрешено выполнять это действие, и определение того, как удовлетворить запрос.
Модели (BaseModel, BaseDatabaseModel, ItemModel, ListModel, FormModel, AdminModel) инкапсулирующем данные, используемые компонентом. Они также несут ответственность за обновление базы данных, где это необходимо.
Представления (AbstractView, CategoriesView, CategoryFeedView, CategoryView, FormView, HtmlView, JsonApiView, JsonView, ListView) определяют, что должно отображаться на веб-странице, и сопоставляют все данные, необходимые для вывода HTTP-ответа.
Теги.
Uri / JUri см. URL-адреса в Joomla
User / JUser API, связанный с пользователем Joomla.