Как сделать компонент для joomla
Разработка сайтов на Joomla, WordPress, Opencart и php. Разработка компонентов joomla, плагинов WordPress, Модулей Opencart
Практический урок по разработке компонента на joomla 3. Теорию затрагивать я не буду. Только практика.
Создадим структуру компонента с выводом панели управления в админке.
1. Стуктура компонента:
Создадим две папки site и admin и файл com_katalog.xml
Папка admin имеет содержимое:
2. Содержимое файла com_katalog.xml
авторство
Copyright (C) 2009 Open Source Matters. All rights reserved.
2011
файлы папки site
language
controllers
helpers
js
css
models
views
images
controller.php
katalog.php
router.php
файлы папки admin
assets
controllers
models
elements
language
tables
helpers
images
views
katalog.php
access.xml
config.xml
controller.php
uninstall.sql
install.sql
ru-RU/ru-RU.com_katalog.ini
Создадим файл sql
Эти файлы у нас расположены в папке admin install.sql и uninstall.sql
Таблица товаров или записей нашего каталога файл install.sql
CREATE TABLE IF NOT EXISTS `#__katalog_items` (
`id` int(11) NOT NULL AUTO_INCREMENT,
) ENGINE=MyISAM DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;
Эта таблица для привязки категория нашим товарам. 1 товар можно будет привязывать к нескольким категориям
CREATE TABLE IF NOT EXISTS `#__katalog_xref` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`catid` int(11) NOT NULL,
`vid` int(11) NOT NULL,
`order` int(11) NOT NULL,
) ENGINE=MyISAM DEFAULT CHARSET=utf8 AUTO_INCREMENT=1;
И файл для удаления этих таблицы uninstall.sql
Далее нужно файлы точек вход в компонент
в папке admin и в папке site создадим файл katalog.php
эти файлы называются также как мы назвали свой компонент на английском языке.
Содержимое файла katalog.php в папке admin
Следующий обязательный файл controller.php
в предыдущем файле мы сразу указываем контроллер по умолчанию
$controller = JControllerLegacy::getInstance(‘katalog’); //контроллер
Создадим панель управления нашего компонента в админке
Как создать свой компонент на joomla 1.6-2.5
Создать компонент для Joomla считается высоким уровнем программирования. Этот элемент может пригодиться если вам нужно создать уникальный интерфейс для обычного пользователя. Или просто оттачивать навыки программирования. Разберемся в процессе создания компонентов для известного движка.
Скачать исходник firstpro
1. ДЛЯ УСТАНОВЩИКА КОМПОНЕНТА НЕОБХОДИМО СОЗДАТЬ 2 ПАПКИ И XML ФАЙЛ УСТАНОВКИ:
2. АДМИН ПАНЕЛЬ
Содержимое index.html
Содержимое data/admin.css
.adminfirstpro1
3. ВЫВОД КОМПОНЕНТА НА САЙТЕ
Содержимое index.html
Содержимое data/style.css
.sitefirstpro2
4. ОСТАЛОСЬ ТОЛЬКО СОЗДАТЬ INSTAL.XML (КОДИРОВКА UTF 8)
Описание моего первого компонента firstpro
index.html
firstpro.php
data/style.css
data/jquery-1.9.1.min.js
index.html
firstpro.php
data/admin.css
data/images/menu.png
data/jquery-1.9.1.min.js
5. ЗААРХИВИРУЕМ НАШ КОМПОНЕНТ В ZIP АРХИВ С ЛЮБЫМ ИМЕНЕМ (ПАПКИ ADMIN, SITE И ФАЙЛ INSTAL.XML), НАПРИМЕР FIRSTPRO.ZIP
Скачать исходник firstpro
Решил не создавать новый материал, а прописать все в текущем, итак:
не забудьте подключить иконки spisok.png и plus.png
2. Подключаем язык к компоненту для перевода меню
data/language/ru-RU/ru-RU.com_firstpro.sys.ini
Теперь создайте файл (UTF 8 без BOM) ru-RU.com_firstpro.sys.ini в папке admin/data/language/ru-RU
и запишите в нем свой перевод:
COM_FIRSTPRO_MENU=»Мой компонент»
COM_FIRSTPRO_MENU_SPISOK=»Список»
COM_FIRSTPRO_MENU_ADD=»Добавить»
Для нашего простейшего компонента потребуется создать всего пять файлов:
Joomla всегда обрабатывает ссылку в корневом файле index.php для страниц Front End (сайт) или administrator/index.php для страниц Back End (панель администратора). Функция обработки загрузит требуемый компонент, основанный на значении «option» в URL (метод GET) или переданных данных методом POST.
Для нашего компонента, URL выглядит так:
Эта ссылка запустит выполнение файла, являющего точкой входа в наш компонент: components/com_hello/hello.php.
Код для этого файла довольно типичен для всех компонентов.
Стоит заметить, что
После загрузки основного контроллера проверяется наличие определенного контроллера с последующей загрузкой. В данном случае у нас только основной контроллер. JRequest::getVar() загружает значение переменной из URL или переданной методом POST. Допустим мы имеем адрес следующего вида:
Тогда можно определить название нашего контроллера следующим образом:
Мы имеем основной контроллер НelloController в com_hello/controller.php, так же загружаются дополнительные названия контроллера, к примеру: для HelloControllerController1 класс будет объявлен в файле com_hello/controllers/controller1.php
После того, как контроллер создан, мы инструктируем его выполнить задачу, которая определяется переданными параметрами в URL (либо через POST):
На этом шаге контроллер переадресовывает страницу. Обычно используется для таких задач как save.
Главная точка входа (hello.php) по существу пропускает управление на контроллер, который обрабатывает выполнение задачи, которая была определена в запросе.
создание контроллера
Код основного контроллера:
Конструктор класса JController всегда будет регистрировать задачу display(). Этот метод сам определит необходимый шаблон и данные которые необходимо загрузить в него. Более того один шаблон может разделяться на уровни(layout), каждый из которых отобразиться при запуске определенной задачи. В нашем случае мы явно не прописываем имя задачи, поэтому (как уже указывалось выше) используется default.
Когда вы создаете пункт меню для вашего компонента, менеджер меню позволит администратору выбирать задачу с которой начинать выполнение компонента. К примеру, для стандартного компонента «Пользователь» (com_user), выбор задач при создании пункта меню будет следующим:
Извлекаем необходимые данные и передаем их в шаблон. В этом нам поможет расширенный класс JView и его метод assignRef, с помощью которого мы передаем переменные в шаблон.
создание шаблона
Наш шаблон очень прост, мы только отображаем приветствие, которое передавали в view:
создание файла hello.xml
Можно установить компонент вручную, копирую файлы по протоколу создавая необходимые папки и таблицы в базе данных, но лучшим вариантом является использования установочного файла для пакетной загрузки файлов и установки компонента
Модули Joomla: Самое подробное руководство
Модули являются неотъемлемой и очень важной частью CMS Joomla. Эта статья представляет максимально подробное руководство по модулям Joomla. Я постарался собрать и структурировать в ней всю информацию о модулях, а также мои знания и опыт.
Данная статья будет полезна как новичкам, так и профессионалам в Joomla. Новички смогут найти в ней ответы на любые вопросы, связанные с модулями, а профессионалы проверят свои знания.
Добро пожаловать в мега-статью, посвященную модулям Joomla.
Содержание
Что такое модули Joomla
Модули Joomla – один из основных видов расширений этой CMS. Наряду с модулями, существуют также компоненты, плагины и шаблоны. Модули – это, определенно, одна из причин использовать Joomla для создания сайта.
Модули представляют собой блоки с какой-либо информацией, встраиваемые в шаблон, контент и другие места на сайте. Давайте посмотрим примеры модулей на сайте wedal.ru:
Все зеленые блоки – модули Joomla. Синий блок – компонент Joomla.
Модули могут встраиваться практически в любую часть сайта, а потому новичкам, да и иногда даже профессионалам, бывает сложно сходу понять, модуль перед ним или нет.
Ровно по этой же причине я не буду давать четкое определение модулей. Скажу лишь, что модули используются, когда нужно показать какую-то общую информацию на каких-то отдельных страницах сайта.
Чтобы чуть лучше понять предложение выше, предлагаю вернуться в школьные годы, и немного вспомнить алгебру. Предположим, у нас есть, прости господи, многочлен вида:
a*x1 + a*x2 + b*x3 + b*x4
Давайте представим, что x1, x2, x3, x4 – разные страницы сайта с разным контентом, например, статьи. А a и b – это какой-то повторяющийся контент, который должен быть на этих страницах. Пусть a – это набор картинок, а b – большая таблица с данными.
С одной стороны, мы можем создать 4 страницы с контентом и вставить в редакторе на двух из них одинаковые наборы картинок и на двух других – одинаковые таблицы. Это будет работать. И это как раз будет иллюстрировать формулу, которую я написал выше. Но есть одна проблема.
Что если нам понадобится изменить одну из картинок или информацию в таблице? Придется открывать каждую статью, где они встречаются, и вручную изменять ее содержимое. Хорошо, если таких статей всего 4, как в примере. А если их 40? 400? Становится не очень весело.
Какое есть решение? А давайте запишем нашу формулу в виде:
a*(x1+x2) + b*(x3+x4)
Мы выносим повторяющийся контент страницы в отдельный блок, который страница при создании будет подгружать. В данном случае a и b как раз и будут модулями Joomla. Теперь, если нам понадобится изменить картинку или данные таблицы, мы можем один раз открыть соответствующий модуль и внести правку. После этого изменения автоматически появятся на всех страницах, где этот модуль выводится.
В этом и заключается основной смысл модулей.
Стандартные модули Joomla
Чтобы еще лучше разобраться с тем, что такое модули, давайте посмотрим на те из них, которые будут доступны сразу после установки Joomla. Посмотрите картинку:
Стандартный набор охватывает практически весь типовой функционал. Здесь есть:
Если вы видите что-то из вышеперечисленного на сайте, то с вероятностью 99% перед вами модуль Джумла.
Самую большую часть набора представляют модули вывода материалов. Не все из них идеальны, но большинство вполне годные.
Конечно, вы совсем не обязательно должны использовать стандартные модули Joomla. Никто не запрещает найти что-то более интересное или подходящее под текущую задачу в каталоге расширений Joomla.
Как установить модуль
Когда вы скачали такой архив, в админке нужно перейти в Расширения –> Менеджер расширений –> Установка, убедится, что активна вкладка Загрузить файл пакета, и, собственно, выбрать файл модуля у себя на компьютере. Что может быть проще?
Также есть два альтернативных варианта установки модуля.
И хотя этот вариант установки из JED кажется наиболее простым и логичным, я не рекомендую вам его использовать. Случается, что при прямой установке из JED вы получаете далеко не самую свежую версию модуля. Лучше все-таки лично посетить JED (каталог расширений Joomla), подобрать там модуль, а затем перейти на сайт разработчика и скачать его уже там.
В целом же установка модулей Joomla очень проста. С ней легко справится даже новичок.
Сколько модулей может быть на странице
Последнее, о чем хочется поговорить во вводной части – допустимое количество модулей на сайте.
Освоить модули легко. Установить еще легче. Если вы только недавно познакомились с Joomla, то можете словить эйфорию от работы с ними. Не поддавайтесь ей.
Другой вариант – веб-мастер делает на модулях весь сайт, вообще забывая про компоненты. За время работы мне доводилось видеть несколько проектов, на которых использовались сотни модулей (нет, не уникальных, но экземпляров какого-нибудь одного, например html-кода). Бывают редкие случаи, когда такое количество модулей оправдано, но это должен быть очень большой проект с очень сложным дизайном.
В основном 50 модулей на сайте – это максимум, после которого вы должны задуматься, о том, что что-то делаете не так. Если у вас большой и сложный сайт (сильно больше и сложнее, чем wedal.ru), то умножьте эту цифру на два.
Для обычных информационных сайтов или интернет-магазинов норма 10-30 модулей (включая экземпляры одного модуля).
Управление модулями Joomla
Управление модулями Joomla с одной стороны очевидное, но с другой стороны содержит очень много тонкостей, о которых важно помнить. Далее мы рассмотрим их.
Прежде всего, нужно понимать, чем отличается уникальный модуль от экземпляра модуля.
Уникальный модуль – такой, который устанавливается, как отдельное расширение и занимает отдельную папку в Joomla.
Экземпляр модуля – отдельно хранящаяся (в базе данных) конфигурация уникального модуля.
Чтобы было проще понять, давайте рассмотрим такой пример. Предположим, у нас на сайте есть слайдеры на двух разных страницах. Сами (функционально) они одинаковые, но должны иметь разный контент. Например, в одном слайдере две картинки, а в другом три другие. Также первый прокручивается автоматически, а второй нет.
В случае с Joomla оба слайдера можно реализовать через один и тот же уникальный модуль, но при этом в админке будет создано два его экземпляра, в которых будут загружены разные изображения и заданы разные настройки, в том числе и привязка к разным страницам.
У одного уникального модуля может быть неограниченное количество экземпляров. Еще раз повторю. Экземпляр – это совокупность настроек модуля, хранящаяся в базе данных и всё. Хотя есть, конечно, и более сложные случаи. О них поговорим позднее.
Просмотр модулей Joomla
Для начала давайте разберемся с тем, как посмотреть уникальные модули, которые установлены (или предустановлены) на сайте. Это можно сделать двумя способами:
Первый способ. В админке перейти в Расширения –> Менеджер расширений –> Управление. На открывшейся странице нажать кнопку Инструменты поиска, и в появившемся фильтре выбрать тип расширения Модуль. Посмотрите пример:
Здесь же, кстати, можно удалить ненужные модули.
Вы можете спросить: почему на картинке некоторые модули повторяются? Дело в том, что все модули разделены на две области:
Для каждой области есть свой уникальный модуль.
Второй способ. В файлах сайта нужно перейти в одну из папок:
Эти же каталоги указывают нам расположение модулей в файловой структуре Joomla.
Просмотреть экземпляры модулей Joomla тоже очень просто. Достаточно перейти в админке в Расширения –> Менеджер модулей. Здесь вы увидите список всех созданных экземпляров модулей:
Заметьте, в менеджере модулей показаны экземпляры модулей только одной из областей. По умолчанию это «Сайт». Если вы хотите посмотреть экземпляры модулей админки, то нужно выбрать соответствующую опцию в фильтре, показанном на рисунке выше.
Теперь, когда мы разобрались с тем, что такое уникальный модуль и экземпляр модуля, пора поговорить о настройке.
Настройка модулей Joomla
Прежде всего. Модули, которые вы настраиваете в админке и видите на сайте – это экземпляры. Уникальный модуль – это каркас, файловая система, но не настройки (разве что только те, которые заданы по умолчанию).
У каждого модуля есть как общие настройки, так и свои собственные. Собственные настройки модуля создает разработчик, и они обычно отличаются для каждого модуля. Общие же настройки одинаковы во всех модулях. О них мы сейчас и поговорим.
Позиции модулей
Одна из самых важных настроек, которая есть у каждого модуля Joomla, это Позиция.
Позиция модуля – это место в шаблоне, где модуль может быть выведен.
В каждом шаблоне позиции разные. Их создают разработчики шаблонов.
В современных шаблонах построенные на фреймворках, вы можете добавлять позиции самостоятельно, прямо в настройках шаблона в админке.
Выбор позиции модуля представляет собой выпадающий список:
Разумеется, для того чтобы выбрать позицию, нужно понимать, где она расположена в шаблоне Joomla. Для обычных шаблонов позиции можно посмотреть так:
Это позволит вам увидеть расположение позиций модулей шаблона.
Порядок модулей
Порядок вывода модулей определяется индивидуально для каждой позиции.
Изменять порядок в настройках каждого отдельного модуля я не советую. Это неудобно. Гораздо проще зайти в менеджер модулей, отфильтровать модули по отдельной позиции, нажать на сортировку по самой первой колонке, а затем перетащить модули мышкой так, как нужно:
Связь модулей и пунктов меню. Вывод модулей на отдельных страницах
Второй по важности общей настройкой я считаю привязку модулей к страницам сайта.
По умолчанию в Joomla модули привязываются к пунктам меню. Это может вызывать некоторые затруднения у новичков в Joomla.
Чтобы вывести модуль на отдельной странице, нужно сделать следующее:
Вывод модулей Joomla в разных частях сайта
Выше мы рассмотрели, что такое позиции модулей и как вывести модуль Joomla в одной из них. В этом разделе я расскажу о других способах вывода модулей на сайте. Зачем они нужны и когда используются, вы узнаете далее.
Как добавить позицию модуля в шаблон
Иногда стандартных позиций шаблона бывает недостаточно. Что делать, есть нам нужно вывести модуль в таком месте шаблона, позиции в котором не существует? Нужно создать новую позицию в шаблоне. На самом деле, это проще, чем кажется.
Если вы используете стандартный шаблон и хотите добавить в нем новую позицию, то вам нужно открыть файл:
/templates/ваш_шаблон/index.php
В нем должна содержаться разметка данного шаблона. Вставить новую позицию можно с помощью следующего кода:
Обычно этот код еще оборачивают в условие проверки количества модулей, опубликованных в данной позиции (чтобы иметь возможность скрывать позицию, если в ней нет ни одного опубликованного модуля), но здесь я специально его опускаю для упрощения.
В такой вставке важно указать название новой позиции в атрибуте name и ее стиль в атрибуте style. По умолчанию можно указывать стиль xhtml или none. Он определяет структуру вывода модуля (заголовок, контент, общая верстка). Подробнее про стили позиций рассказывается ниже, в разделе про оформление модулей.
Если вы используйте шаблон, основанный на фреймворке, то, скорее всего, сможете посмотреть текущие позиции и добавить новые в его настройках, в админке.
Как вставить модуль в материал Joomla
Бывает так, что модуль необходимо вставить не просто в шаблон, а прямо в статью на сайте. Примером может служить вставка таблицы в разных статьях, про которую я рассказывал выше.
Для вставки модуля в материал в Joomla есть несколько специальных плагинов. Это работает так. Вы вставляете в статью специальную конструкцию, а при загрузке страницы плагин проверяет, встречается ли она, и если да – заменяет ее модулем.
Вы можете использовать один из двух вариантов:
Для вставки позиции модуля используется конструкция:
Название позиции может быть любым. Можете выдумать его на ходу. Главное, чтобы в настройках модуля была указана эта же позиция.
Для вставки отдельного модуля в материал используется конструкция:
Эта конструкция появилась относительно недавно и, если вы используете не самую свежую версию Joomla, она может у вас не работать.
ID модуля можно узнать в менеджере модулей. Там, напротив каждого из них, указан ID.
Другой вариант использования описанных выше конструкций – это специальная кнопка в редакторе TinyMCE (он используется в Joomla по умолчанию). Данная кнопка позволяет вставлять модули гораздо более удобным способом. Посмотрите:
Вставка модуля в компонент Joomla
Этот вариант нужен тем, кто уже хоть немного разбирается в PHP.
Иногда возникает необходимость вставить модуль в страницу, генерируемую каким-либо компонентом Joomla. Самый простой пример – необходимо в интернет-магазине (к примеру, Virtuemart) на странице товара вставить модуль обратной связи. Место этой вставки расположено в макете карточки товара. Как быть?
Для вставки модуля Joomla в компонент можно использовать следующий код:
Это вариант вывода позиции модулей в компоненте.
Есть и другой вариант – вывести модуль по ID:
Этот вариант работает только в последних версиях Joomla 3.
И еще есть третий вариант, о котором я узнал совсем недавно. Он самый простой:
В примере выше нужно убрать восклицательный знак. Я добавил его, чтобы Joomla не пыталась обработать этот вызов здесь, в статье.
Вывести модуль в модуле Joomla
Запомните важный момент! Если перед вами появилась задача вставить модуль в модуль Joomla, то с вероятностью 99% вы что-то делаете неправильно.
Модуль Joomla не предназначен для того, чтобы в него вставляли другой модуль. Это что-то вроде бесконечной песенки «У попа была собака…». Модуль – конечная единица контента в Joomla. Если вам чего-то в нем не хватает, значит, вы неправильно спроектировали структуру сайта или шаблон. Разработчики Joomla учли это и отключили возможность использовать конструкций loadposition и loadmoduleid в модуле html-кода.
Тем не менее, есть способ, позволяющий вставить один модуль Joomla в другой. Для этого вы должны:
И это будет работать. Модуль будет вставлен в модуль. Но еще раз повторю: это неправильно! Если вам не хватает какого-то контента в модуле, разумнее будет вставить его в переопределенный макет этого модуля, но никак не добавлять в модуль другой модуль.
Advanced Module Manager – вывод модуля на страницах, не привязанных к пунктам меню
Очень часто встречается ситуация, когда нужно вывести модуль только на некоторых страницах, которые не привязаны к пунктам меню. Например, вы хотите вывести модуль с баннером только на отдельных страницах каталога товаров, а к пункту меню привязан только верхний уровень каталога (обычная ситуация в Virtuemart). Это слабая сторона Joomla, т.к. стандартный функционал CMS не позволит вам сделать это.
Да, если вы разработчик, и хорошо разбираетесь в шаблонах Joomla и PHP, то без труда сможете добавить нужную привязку в шаблоне Joomla. Но что делать всем остальным?
На помощь придет стороннее расширение Advanced Module Manager. Оно улучшает менеджер модулей Joomla, добавляя новые различные варианты привязки модулей, а том числе и по URL страницы.
Advanced Module Manager имеет две версии: бесплатную и коммерческую. Различие между ними в количестве разнообразных привязок. Подробнее прочитать про это расширение и сравнить его версии можно здесь.
Что касается моего опыта – я крайне редко использую Advanced Module Manager, поскольку в нем есть и минусы. Такая широта функционала дает, в свою очередь, и гораздо бОльшую нагрузку. Поэтому не устанавливайте данное расширение бездумно. Используйте его только в том случае, на это действительно есть необходимость. И, однозначно, если вам нужно сделать всего 1-3 нестандартных привязки модулей, не стоит устанавливать такого монстра.
Ограничение на просмотр модулей
Еще одной важной возможностью модулей Joomla является разграничение доступа.
Предположим, у нас есть задача в определенной позиции шаблона:
Именно так сделано сейчас на wedal.ru.
Вид для авторизованных пользователей:
Как этого добиться? Доступ к модулям на сайте регулируется опцией Доступ, которая есть в любом модуле Joomla:
В выпадающем списке можно выбрать уровень доступа, которым должны обладать пользователи, чтобы видеть данный модуль.
Таким образом, для решения задачи, описанной выше, достаточно:
В результате все пользователи, которые зашли на сайт, но не авторизовались, будут видеть только форму входа, а авторизованные пользователи будут видеть меню.
Отдельно стоит сказать про уровни доступа. Их набор не является фиксированным. Вы можете создавать любое количество собственных уровней доступа, привязывать к ним группы пользователей и очень гибко управлять видимостью модулей Joomla. Это довольно сложный функционал. Подробнее про систему контроля доступа (Joomla ACL) вы можете почитать в отдельной статье.
Кэширование модулей
Модули Joomla могут быть очень разными. Иногда актуальность информации в них очень важна (например, последние комментарии, статьи или темы форума), но иногда информация в модуле может быть более чем постоянной. Пример – меню.
Давайте представим ситуацию. У вас на сайте размещено сквозное многоуровневое меню, в котором десятки пунктов. Так бывает очень часто, если не сказать почти всегда.
Для генерации такого меню при запросе каждой страницы Joomla должна обратиться к базе данных, взять из нее все пункты, проанализировать их параметры, создать ссылки в зависимости от этих параметров, построить структуру. Вся эта работа потребляет вычислительные ресурсы сервера.
А теперь представьте, что у вас запрашивается в среднем 1 страница в секунду. При этом работа по генерации меню проводится каждый раз, хотя само меню может не меняться годами. Это совсем не оптимально.
Для оптимизации таких ситуаций и увеличения производительности в Joomla заложен функционал кэширования модулей. В каждом нормальном модуле есть опции, позволяющие включить или выключить кэширование, а также задать время жизни кэша.
Как работает кэширование модулей в Joomla? Вернемся к примеру с меню. При включенном кэшировании, при первой генерации меню Joomla записывает его html-код в файл и хранит этот файл на сервере в папке кэша. Во второй и последующий разы, когда нужно сгенерировать меню, Joomla не делает это повторно, а просто берет html-код из файла и подставляет его в шаблон. Это существенно экономит ресурсы сервера и снижает нагрузку.
У кэша есть время жизни. Оно задается отдельно в каждом модуле. Это важно.
Время жизни кэша – это прошедшее время, от первого создания кэша, до того, как он будет пересоздан повторно.
Почему это важно? Представим себе 2 модуля: модуль меню, изменения в который вносятся 2 раза в год и модуль последних статей на сайте, которые появляются 2 раза в неделю. Разумно предположить, что кэш первого модуля можно обновлять гораздо реже. Для этого и нужна данная опция.
В каждом отдельном модуле вы можете совсем отключить его кэширование, если актуальность информации, которую он выводит, очень важна. В противном случае настраивайте время кэширования, а опцию включения кэша оставляйте По умолчанию.
При таком подходе вы сможете один раз включить кэширование в общих настройках Joomla и оно сразу заработает для всех модулей, в которых прямо не отключено. Это очень удобно.
Кэширование нужно включать уже после завершения разработки сайта. Включение кэша на этапе разработки будет сильно мешать, т.к. вы не сможете видеть актуальные данные каждый раз при обновлении страницы.
Оформление модулей
Модули Joomla очень хорошо поддаются кастомизации. Обладая соответствующими навыками, вы можете легко и быстро переделать любой из них под свои задачи. В этом разделе я расскажу про всё, что связано с оформлением модулей.
Суффикс класса модуля
Суффикс класса модуля является довольно полезной опцией, когда вам нужно оформить по-разному два экземпляра одного модуля.
Представьте, есть один модуль вывода последних новостей, и вы используете его дважды в разных местах страницы и с разными опциями. Также вам нужно по-разному оформить его в каждом месте. Joomla имеет опцию, позволяющую задать уникальный CSS-класс для модуля.
Подробно про суффикс класса модуля вы можете прочитать в отдельной статье, целиком посвящённой этой теме. Всем, кто постоянно использует Joomla, настоятельно рекомендую к ознакомлению.
Стиль позиции модуля
Далее поговорим про html-структуру модулей на сайте. Она формируется из двух частей:
Каждая из этих частей формирует итоговую html-разметку модуля на сайте. Фактически то, что будет вставлено в шаблон вместо:
Здесь мы рассмотрим первую часть – стиль позиции модуля.
Стилей может быть несколько. Какой именно стиль будет применен, указывается во вставке позиции модуля. Посмотрите пример вставки чуть выше. Здесь применен стиль xhtml.
Вы можете переопределять стили позиций, а также создавать свои собственные стили. Посмотрим как.
Стандартный набор стилей позиции модуля расположен в файле:
/templates/system/html/modules.php
Посмотрите его и вы увидите все доступные по умолчанию стили. Если вам хочется изменить какой-нибудь из стилей, или добавить свой собственный, то первым делом нужно переопределить данный файл в ваш шаблон. Если говорить простым языком, скопируйте этот файл и вставьте в:
/templates/ВАШ_ШАБЛОН/html/
Кстати, очень велика вероятность, что в вашем шаблоне такой файл уже существует. Тогда ничего копировать не нужно – редактируйте файл из вашего шаблона.
Содержимое файла стилей позиции модуля на первый взгляд может показаться сложным, но в реальности оно довольно простое. В файле содержится набор функций. Одна функция определяет один стиль. Шаблон имен функций такой:
modChrome_название_стиля
т.е., к примеру, функция стиля xhtml будет называться:
modChrome_xhtml
Содержимое функции определяет html-разметку стиля позиции. Здесь есть всего две основные переменные, которые нужно вывести:
Всё остальное – различные параметры и дополнительная логика. Ориентируйтесь на примеры функций в файле, и вы сможете создать свой уникальный стиль для позиции.
Всё это прекрасная теория. На практике же лично я использую в основном только два стандартных стиля:
Ну и в целом – изменение стилей позиций модулей – достаточно редкая задача. Чаще всего хватает стандартного их набора. Но зная про стили позиций, вы не будете теряться, когда увидите дополнительную html-разметку вокруг выведенного в шаблон модуля.
Макет модуля
Второй, гораздо более важной составляющей html-разметки модуля, является его макет.
Макет – это файл, который выводит на сайт содержимое модуля. У каждого модуля есть как минимум один макет. Часто модули имеют несколько макетов.
Макеты модуля всегда расположены в каталоге:
/modules/название_модуля/tmpl/
Рассмотрим пример макетов на стандартном модуле авторизации Joomla.
Найти макеты можно в каталоге:
/modules/mod_login/tmpl/
Здесь вы увидите два файла-макета:
Почему два? Т.к. это модуль авторизации, то он может быть показан в одном из двух состояний:
Логично, что в первом случае модуль должен показывать форму ввода логина и пароля, а во втором приветствие пользователя. Поэтому макетов два. Какой из них будет показан, определяется логикой модуля.
Предположим, вы хотите изменить html-разметку макета модуля или добавить в него дополнительный функционал. Как это правильно сделать? Следуем по шагам:
Переопределить макет модуля очень просто. Его нужно скопировать по адресу:
/templates/ваш_шаблон/html/название_директории_модуля/
В нашем примере это будет:
/templates/ваш_шаблон/html/mod_login/
Все недостающие каталоги создаем сами.
Альтернативный макет модуля
Иногда бывают ситуации, когда один и тот же модуль нужно выводить в разной разметке. Например, в одном месте сайта последние статьи нужно показывать списком и только заголовки, а в другом – заголовок, описание, вводное изображение.
Хорошо, когда опций модуля хватает чтобы сделать такое разделение. Но часто бывает, что нет. В этом случае нам на помощь приходят альтернативные макеты модулей Joomla.
Альтернативный макет – это файл стандартного макета модуля, имеющий другое название и измененное содержимое.
Чтобы создать и использовать альтернативный макет для модуля необходимо:
В примере с модулем авторизации (см. раздел выше) я переопределил его стандартные макеты в шаблон Joomla, а затем переименовал их в header.php и header_logout.php соответственно. После этого в настройках модуля авторизации выбрал переименованный макет:
Всё. Теперь данный экземпляр модуля авторизации будет брать разметку из альтернативного макета.
Альтернативных макетов у модуля может быть неограниченно много. Они позволят вам получить огромную гибкость разметки в Joomla. Еще больше информации об альтернативных макетах модулей и не только вы можете найти в статье Макеты Joomla. Как сделать ваш сайт максимально уникальным.
Разработка модуля Joomla
Joomla имеет огромное количество готовых модулей. Но бывает так, что требуемый функционал совершенно уникален. Что делать в этом случае? Создать собственный модуль!
Разработка простого модуля – задача не очень сложная. Тем не менее, она требует базовых знаний HTML, CSS, PHP, XML. Если они у вас есть, то данный раздел будет вам полезен. Если же нет, то создать собственный модуль вам будет довольно сложно. Лучше отдайте эту задачу на аутсорс или обратитесь за созданием модуля ко мне.
Для начала давайте рассмотрим стандартную структуру модуля Joomla. Конечно в зависимости от задач она может меняться, но в целом достаточно постоянна.
Минимальный модуль будет состоять всего из двух файлов: первых двух, указанных в этом списке. Но делать так – очень плохая практика.
Хороший модуль обязательно должен:
Чтобы написать свой модуль Joomla, я советую взять один из стандартных модулей, установленных по умолчанию, выбрав такой, который в наибольшей степени будет подходить под ваши нужды, а затем переименовать и переделать его. Это поможет сэкономить некоторое время.
Также вы можете найти в Интернете сервисы генерации модулей-заготовок. Конечно, функционал, который вам необходим, они не создадут, но позволят быстро создать каркас модуля со всеми необходимыми для заполнения полями.
Модули Joomla и com_axaj
Есть еще одна важная вещь, которую нужно знать о модулях, прежде чем браться за разработку.
Модуль не может содержать несколько страниц (в стандартном понимании). Т.е., по сути, модуль только выводит информацию, но не обрабатывает ее, как компонент. Это означает, что вы не можете вызвать модуль по прямому URL.
Т.е., к примеру, модуль не предназначен для реализации формы обратной связи, которая сначала показывает форму, а потом страницу «Спасибо».
Для того чтобы иметь возможность вызова модуля по прямой ссылке, применяется специальный компонент Joomla, который называется com_ajax.
Com_ajax работает с модулями следующим образом:
Вот и всё. Сам этот метод должен генерировать то, что будет ответом на такой URL. Это может быть, в том числе, макет модуля. Таким образом, используя com_ajax, вы сможете вывести модуль по прямому URL.
Более подробную информацию по com_ajax и варианты его использования вы можете найти здесь.
Когда не стоит использовать модули
Не всегда использование модулей на сайте Joomla оправдано. Бывали случаи, когда я сталкивался с сайтами, на которых использовалось 500-800 экземпляров модулей. Стоит ли говорить, что поддержка такого сайта превращалась в настоящий кошмар.
В этом разделе я собрал случаи, в которых не следует использовать модули, а лучше применить другие техники.
Модуль с уникальной информацией для страницы каталога или интернет-магазина
Бывает, что случается такое: на каждой странице каталога товаров (или чего-то еще) появляется необходимость поместить блок с уникальной информацией. Скажем, заказчик просит добавить на странице каждого товара слайдер с дополнительными фотографиями.
Модуль, конечно, кажется самым простым решением. Но это пока товары исчисляются единицами или десятками. А что, если в перспективе их будут сотни или тысячи? Вы создадите сотни экземпляров модуля слайдера? Никогда так не делайте.
Правильный подход: использовать дополнительные поля для товара в каталоге. В них загружать слайды и формировать слайдер в макете карточки товара.
Модули html-кода в материалах Joomla
Некоторые разработчики так увлекаются использованием модулей, что часто вставляют их в материалы через редактор, даже когда этого не требуется.
Простой пример: у вас есть таблица, которую нужно вставить в статью. Статья, содержащая эту таблицу, на сайте только одна. Другие статьи содержат другие таблицы.
Правильный подход: Помните про правило вынесения за скобки (смотрите начало статьи). Если содержимое модуля html-кода будет выводиться только в одной статье или точно не будет обновляться, то не городите модуль, а просто включайте этот html-код в статью.
Модули для текста (или меню) в несколько колонок
Часто бывает, что необходимо сделать что-то такое:
Не нужно создавать для этого три разных модуля. Почему? Да, это кажется проще на первый взгляд, но когда вы сделаете аналогичным образом еще несколько блоков, то их поиск и редактирование превратится в кошмар.
Правильный подход: Выводите HTML-код в одном модуле и используйте CSS для создания нескольких колонок.
Если вы сомневаетесь, использовать модуль или нет, то всегда вспоминайте, что основное предназначение модулей Joomla – показывать одинаковую информацию на разных страницах сайта. Вспоминайте пример с многочленом. Если вы видите, что страниц с блоком повторяющейся информации много, то смело размещайте ее в модуле.
Где скачать модули Joomla
Если вы ищете, где можно скачать разнообразные модули Joomla для своего сайта, то запомните одно простое правило:
Скачивать модуль можно только с сайта его разработчика или с extensions.joomla.org.
Все остальные варианты с высокой долей вероятности приведут вас к проблемам. Модули, скачанные из неофициальных источников, могут содержать в коде что угодно. Проблем от них вы получите гораздо больше, чем пользы.
В каталоге расширений Joomla (или сокращенно JED), ссылку на который я дал выше, все расширения проверяются. Загружать модули оттуда или же с сайтов разработчиков, на которые там есть ссылки, относительно безопасно.
В JED есть как платные модули, так и те, которые можно скачать и использовать бесплатно. Фильтр позволит вам отделить одни от других.
Бесплатные модули Joomla от Wedal.ru
Я хочу предложить вам несколько собственных бесплатных модулей Joomla. Их нет в JED (пока). В них нет никакого подвоха. Я делал их для себя (точнее для решения частых задач при разработке сайтов), и решил поделиться с сообществом.
Все три модуля имеют открытый код и распространяются бесплатно. Буду рад, если они пригодятся вам при создании сайтов на Joomla.