Данный материал предназначен для новичков в мире Livestreet, желающих разобраться с базовыми особенностями работы с системой плагинов.

Создадим простой плагин, который будет создавать объект «Book» из введенных пользователем данных и сохранять в базу данных. А на отдельной страничке — выводить все созданные объекты Book списком.

Начальные условия:
Название плагина — test
Страница для ввода данных книги: ваш_сайт_ls.tld/test
Страница для вывода списка книг: ваш_сайт_ls.tld/test/books
Поля объекта Book:
— id
— name — название книги;
– author — автор книги;
— description — описание книги.

1. Создаем каркас плагина
Переходим в папку

livestreet/engine/console/

cd livestreet/engine/console/

Запускаем скрипт для создания каркаса плагина:

php ls plugin new test

В результате выполнения создастся каркас нового плагина test и разместится в папке

livestreet/plugins

2. Конфигурируем плагин
Переходим в папку

livestreet/plugins/test

и редактируем файл

plugin.xml

в соответствии со своими потребностями (там все понятно).

3. Конфигурируем конфиг плагина
Переходим в папку

livestreet/plugins/test/config

, редактируем конфиг плагина

config.php

a)Конфигурируем роутер
После

$config = array();

добавляем следующий код(или раскоментируйте соотв. строку в комментарии):

Config::Set('router.page.test', 'PluginTest_ActionTest');

Таким образом, все запросы на domain.com/test будут попадать в обработчик PluginTest_ActionTest

b)Конфигурируем переменную таблицы
Перед

return $config;

добавляем:

// Таблицы плагина
$config['table']['test_table'] = '___db.table.prefix___test_table';

Таким образом мы сохранили в конфиге полное имя таблицы нашего плагина с учетом префикса. Можно обратиться к нему из любого места плагина через

Config::Get('plugin.test.table.test_table')

4. Создаем нашу таблицу test_table
Открываем из корня плагина скрипт

install.sql

После комментария вставляем следующий код:

CREATE TABLE IF NOT EXISTS `prefix_test_table` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(500) NOT NULL,
  `author` varchar(100) NOT NULL,
  `description` varchar(1000) NOT NULL DEFAULT '',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Файл install.sql выполнится при активации вашего плагина из админки. Создастся ваша таблица test_table с префиксом, соотв. инсталляции LS.

5. Конфигурируем главный класс плагина
Данный класс отвечает за переопределения и наследования методов, прикрепление различных скриптов и стилей к плагину, а также, за функции активации и деактивации плагина из админки плагинов. Нас интересует последнее.

Открываем

livestreet/plugins/test/PluginTest.class.php

Переходим к части, ответственной за активацию плагина, метод Activate
Раскомментируем находящийся в нем код, или заменим своми. После редактирования метод должен выглядеть следующим образом:

// Активация плагина
    public function Activate() {
        if (!$this->isTableExists('prefix_tablename')) {
            $this->ExportSQL(dirname(__FILE__).'/install.sql');
        }
        return true;
    }

Таким образом, при активации админом плагина в админке плагинов выполнится наш sql-патч по созданию нашей таблицы (если она еще не существует).

6. Конфигурируем Экшн
Экшин — это то, что будет выполнено при переходе по соотв. ссылке. За зависимость экшина от переданной ссылки отвечает роутер.
Упрощенно — роутер получает данные о запросе (строку запроса), разбивает ее на составляющие, и вызывает соответствующий экшин (функцию/метод).
Экшин принимает переданные данные, проверяет их, и, при корректности данных, выполняет какое-то действие, например, с помощью маппера делает запись в БД.
После выполненного действия, экшин должен вернуть результат выполненного действия. Это может быть ошибка, сообщение об успешном выполнении, и сам шаблон экшина. Результат выполнения Экшина передается клиенту в браузер.

Открываем файл экшинов плагина

livestreet/plugins/test/classes/actions/ActionTest.class.php

a) Регистрируем события(ивенты)экшина
Переходим в метод регистрации ивентов (событий экшина) RegisterEvent
Если вы ничего не изменяли, то там должен быть следующий код:

protected function RegisterEvent() {
        $this->AddEvent('index','EventIndex');
}

Этот код означает, что при переходе по ссылке livestreet.tld/test будет выполнен метод(функция) EventIndex

Если вы хотите добавить обработку иных uri, то просто зарегистрируйте свой экшин. Например, вы хотите обрабатывать uri вида

livestreet.tld/test/books

то просто дополните код:

protected function RegisterEvent() {
        $this->AddEvent('index','EventIndex');
        $this->AddEvent('books','EventBooks');
}

и создайте обработчик (метод/функцию) соответствующего ивента.

b) Создаем обработчик события(ивента)экшина
Обработчик — это то, что будет выполнено при наступлении(вызове) соответствующего события(ивента)экшина.
Представим, что нам необходимо обработать какой-то POST — запрос, например, с данными о книге.
Находим метод/функцию EventIndex класса ActionTest.class.php
Если вы ничего не изменяли, то там будет просто пустая функция. Дополним ее. И создадим обработчик для события EventBooks.

Содержание файла

livestreet/plugins/test/classes/actions/ActionTest.class.php

<?php


class PluginTest_ActionTest extends ActionPlugin {


    /**
     * Инициализация экшена
     */

    public function Init() {

        $this->SetDefaultEvent('index');

    }


    /**
     * Регистрируем евенты
     */

    protected function RegisterEvent() {

        $this->AddEvent('index','EventIndex');

        $this->AddEvent('books','EventBooks');

    }


    protected function EventIndex() {

        // Если форма с данными была отправлена:

        if (isPost('submit_book_save')) {
<br /><br />
            //Проверяем наличие и валидность секретного ключа
            $this->Security_ValidateSendForm();
            // Принимаем данные POST-запроса

            $post = $GLOBALS['_POST'];

            // Проверяем данные POST-запроса на корректность

            if(
                        !isset($post['book_name'],$post['book_author'],$post['book_description']) ||
                empty($post['book_name'])||empty($post['book_author'])||empty($post['book_description'])

            ) {

                //Добавляем сообщение об ошибке

                $this->Message_AddError('Ошибка!','Не все данные формы заполнены!');

                return;
            
              }

            // Передем данные методу модуля, где

            //создаем объект книги и сохраняем его в БД

            // PluginTest — наш плагин

            // Test - модуль Test плагина Test

            // createBook - метод (функция) модуля Test плагина Test

            $result = $this->PluginTest_ModuleTest_createBook($post);

            //Если при сохранении возникли какие-то ошибки и т.п., создаем сообщение об ошибке.

            if(!$result){

                //Добавляем сообщение об ошибке

                $this->Message_AddError('Ошибка!','Возникли проблемы при сохранении данных!');

                return;

            }

            // Добавляем сообщение об успешном сохранении книги

            $this->Message_AddNotice('Данные книги успешно сохранены!');

        }

        //Получаем данные о всех сохраненных книгах

        $aBooks=$this->PluginTest_Test_getBooks();

        //Передаем эти данные в шаблон. В шаблоне они будут доступны как объект 'books'

        $this->Viewer_Assign('aBooks',$aBooks);

    }



    protected function EventBooks() {

        //Получаем данные о всех сохраненных книгах

        $aBooks=$this->PluginTest_Test_getBooks();

        //Передаем эти данные в шаблон. В шаблоне они будут доступны как объект 'books'

        $this->Viewer_Assign('aBooks',$aBooks);

    }


    /**
     * Завершение работы экшена
     */

    public function EventShutdown() {


    }
}

?>


Задача Экшина — получить данные, проверить все ли необходимые данные получены, и передать управление Модулю. Потом вернуть результат клиенту в виде скомпилированного шаблона (странички) с вставленными данными результата выполнения.

UPD1:
В ивент экшина EventIndex добавлена проверка секретного ключа при получении данных формы. Спасибо PSNet

Часть 2