Создание Model-View-Controller компонента часть 3 - Использование базы данных

Введение

В первых двух частях мы показали, как можно сделать простой компонент на основе схемы MVC. У нас был простое представление, которое получало данные из модели (она была создана во второй части). В этой части мы будем работать только с моделью. Вместо данных жестко прописанных в модели, мы будем получать их из таблицы базы данных с помощью класса JDatabase.

Получение данных

Сейчас у нашей модели есть только один метод: getGreeting(). Это очень простой пример – все что он делает это возвращает жестко прописанный код.
Чтобы сделать наш пример более интересным, мы будем загружать приветствие из базы данных. Позже мы покажем, как создать SQL файл и добавить код в xml файл, чтобы при установке компонента была создана и заполнена нужная таблица. Пока мы просто изменим функцию, возвращающую приветствие так чтобы она получала его из базы данных.

Сначала надо получить ссылку на базe. Начиная с Joomla, использование базы данных является обычной процедурой. Соединение с базой уже существует, поэтому нет необходимости создавать свое. Ссылка на существующую базу может быть получена следующим образом:

Jfactory – это статический класс, который используется для получения ссылок на многие объект системы. Более подробную информацию об этом классе можно получить здесь. Название метода (getDBO) происходит от get DataBase Object чтобы его было легко запомнить. Чтобы получить запись из базы данных нам надо сделать два шага:
1. сохранить наш запрос в объекте базы данных;
2. загрузить результат

Наша новая функция getGreeting() будет выглядеть так:

function getGreeting()
{
$db =& JFactory::getDBO();

$query = 'SELECT greeting FROM #__hello';
$db->setQuery( $query );
$greeting = $db->loadResult();

return $greeting;
}

hello это имя таблицы, которую мы создадим позже. greeting это название поля, хранящего наши приветствия. Если вы не знакомы с SQL, то будет полезно почитать какие-нибудь руководства или уроки по этой теме.
Метод $db->loadResult() сохранит запрос и вернет из базы данных первую колонку и первую строку в ней. Для получения дополнительной информации по объекту JDatabase обратитесь к этой статье.

Создание инсталляционного SQL файла

Joomla имеет встроенную поддержку выполнения запросов во время установки компонента. Эти запросы хранятся в обычном текстовом файле.
В наше инсталляционном файле будет три запроса: сначала мы уничтожим таблицу, если она существует, затем создадим новую таблица, а потом вставим в нее данные.

Вот наши запросы:

DROP TABLE IF EXISTS `#__hello`;

CREATE TABLE `#__hello` (
`id` int(11) NOT NULL auto_increment,
`greeting` varchar(25) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;

INSERT INTO `#__hello` (`greeting`) VALUES ('Hello, World!'),
('Bonjour, Monde!'),
('Ciao, Mondo!');

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

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

Тексты наших запросов будут храниться в файле install.sql

Создание файла uninstall.sql

Хотя мы и надеемся на то что люди никогда не удалят наш компонент, но все же если они сделают это, мы не должны ничего оставлять после себя. Joomla контролирует удаление всех созданных папок и файлов, но нам надо вручную включить запросы, которые буду удалять, созданные нами таблицы из базы данных. На данный момент мы создали всего одну таблицу. И нам нужен только один запрос:

DROP TABLE IF EXISTS `#__hello`;

Обновление инсталляционного файла

Нам нужно внести некоторые изменения в инсталляционный файл. Во-первых, надо добавить два новых файла в список. Файл install.sql должен перейти в папку admin. Во-вторых, мы должны указать инсталлеру выполнить запросы в наших файлах при инсталляции и деинсталляции.
Обновленный код выглядит следующим образом:

Как вы могли заметить, у тега <file>, который находиться в секциях <install><uninstall> есть два атрибута: charset и driver. Charset это кодировка файла. Обычно используется utf-8. Но если вы хотите создать инсталляционные файлы в другой кодировке (например для старых версий MySQl) вы должны пропустить этот атрибут.
Атрибут driver указывает для какой базы данных написаны запросы. В настоящее время в качестве базы данных может быть использована только MySql, но в будущем предполагается создать драйвера и для других баз данных.

Заключение

Теперь наш компонент, может работать не только с классами MVC framework, но и с классами JDatabase. Теперь вы можете создавать компоненты , которые взаимодействуют с базой данных и можете использовать Joomla инсталлер для создания и заполнения таблиц базы данных.

Статья здесь и здесь