Создание кнопки для визуального редактора

Иногда появляется необходимость сделать кнопку для вставки тегов, которые используются тем или иным мамботом, например в стандартной поставке Joomla внизу редактора уже есть две кнопки, вставляющие тег разрыва страницы «mospagebreak» и тег вставки изображения «mosimage». В этой статье я расскажу, как создать свою кнопку для вставки произвольного тега в поле визуального редактора.

Из каких файлов состоит мамбот-кнопка для визуального редактора?

Для создания такого мамбота требуется всего на всего три файла:

• название_кнопки.php
• название_кнопки.xml
• название_кнопки.gif (или другой файл картинки)

Так уж повелось, что перед расширением каждого из этих файлов ставят еще три буквы btn(от button), что показывает, что этот мамбот является кнопкой. Но это не принципиально, просто таков этикет.

Типовой код для мамбота-кнопки hello_world

Приведем самый простой код для мамбота-кнопки. Все что он делает, это позволяет вставлять тег {hello_world} в поле визуального редактора. При этом, тег вставляется только при редактировании материалов (при редактировании разделов, категорий и модулей кнопка будет бездействовать).

<?php 
defined( '_VALID_MOS' ) or die( 'Доступ ограничен' );
$_MAMBOTS->registerFunction( 'onCustomEditorButton', 'botHelloWorldButton' );
 
function botHelloWorldButton() {
  global $option;
 
  switch ( $option ) {
    case 'com_sections':
    case 'com_categories':
    case 'com_modules':
      $button = array( '', '' );
      break;
    default:
      $button = array( 'hello_world.gif', '{hello_world}' );
      break;
  }
  return $button;
}
?>

Вы можете заменить hello_world.gif на имя файла с картинкой кнопки, а {hello_world} на текст вашего тега.

Типовой xml-файл для мамбота-кнопки hello_world

<?xml version="1.0" encoding="windows-1251"?>
<mosinstall version="1.0" type="mambot" group="editors-xtd">
  <name>HelloWorldButton</name>
  <author>Автор</author>
  <creationDate>Февраль 2007</creationDate>
  <copyright>GNU/GPL</copyright>
  <authorEmail>Автор@Почтовый_Сервер.ru</authorEmail>
  <authorUrl>www.Автор.ru</authorUrl>
  <version>1.0</version>
  <description>Позволяет кнопкой вставлять тег {hello_world} в окне редактирования содержимого.</description>
  <files>
    <filename mambot="hello_world.btn">hello_world.btn.php</filename>
    <filename>hello_world.gif</filename>
  </files>
</mosinstall>

Между тегами name, author, creationDate, copyright, authorEmail, authorUrl, version необходимо прописать информацию об имени автора, дате создания, авторских правах и т.д.

Ну, вот и все! Теперь, запускайте свой архиватор, сжимайте все три файла в один, чтобы на выходе получился архив с подобным названием bot_hello_world_btn.zip, и устанавливайте как настоящий мамбот.