API функции Joomla

Материал из База знаний Joomla.

Это статья из раздела Программирование для Joomla. Вернитесь в него для более полной информации.

---

Содержание 1 Основные и часто употребляемые API функции (глобальные) 2 Основные конфигурационные переменные 3 Методы объекта $mainframe 4 Кнопки в админке для класса mosMenuBar

Основные и часто употребляемые API функции (глобальные)

В квадратных скобках, если возможно, указано название функции в Joomla 1.5.

• initEditor() [JEditor::init] - если в коде будет использоваться WYSIWYG-редактор, то наличие этой функции обязательно.

• mosCountModules('позиция') - возвращает число модулей на заданной позиции. Часто употребляется в шаблонах, для правильного формирования таблиц.

• mosLoadModules('позиция',$стиль) - выводит модули настроенные на заданную позицию. Часто употребялется в шаблонах.

• mosGetParam($массив, $имя_переменной, $значение_по_умолчанию, $флаги) - возвращает значение переменной, уже подготовленное для вставки в базу данных.

• mosMail($email_отправителя, $имя_отправителя, $email_получателя, $тема_письма, $тело_письма) - предназначена для отправки электронной почты с сайта.

• mosNotAuth() - если у пользователя не хватает прав что-то смотреть, то эта функция выводит стандартную заглушку о невозможности показа страницы.

• mosRedirect($url) - редирект пользователя на какой-то адрес

• sefRelToAbs($url) - если SEF включен, то данная функция заменит стандартный адрес вида "index.php?option=com_xxx&task=yyy" на красивый. Понятно что если ваш компонент не известен разборщику адресов в joomla, то шибко красивым он не станет. Но это стандарт. Все сторонние SEF-компоненты перехватывают именно эту функцию.

Основные конфигурационные переменные

• $mosConfig_absolute_path - абсолютный путь до папки с установленной Joomla. Без слэша на конце.

• $mosConfig_live_site - адрес для браузера, до установленной Joomla.

Методы объекта $mainframe

• addMetaTag ($имя,$содержимое) - добавляет какой-то особенный meta-тэг в страницу

• appendMetaTag ($имя,$содержимое) - добавляет ваше содержимое к уже существующему meta-тэгу, например 'description'

• setPageTitle ($заголовок) - устанавливает заголовок страницы

Кнопки в админке для класса mosMenuBar

Эти кнопки вывыдятся в тулбаре админки, при помощи вызовов типа

mosMenuBar::addNew('create_thing');

Любой из этих методов в принципе делает одно и тоже, просто картинка для кнопки в каждом методе своя.

• startTable() + endTable() - начало и конец списка кнопок.

• addNew($task,$alt) - кнопка Новый, с заданным $task.

• back($alt,$href) - кнопка Назад

• cancel($task,$alt) - кнопка Отмена

• deleteList($msg,$task,$alt) - кнопка Удалить. Для удаления элементов списка.

• editList($task,$alt) - кнопка Редактировать. Для редактирования элементов списка.

• publish($task,$alt) - кнопка Опубликовать.

• save($task,$alt) - кнопка Сохранить.

• Trash($task,$alt) - кнопка Удалить.

• unpublish($task,$alt) - кнопка для отмены публикации.