Источники информации

• Официальный сайт phpUnit – http://www.phpunit.de/
• Примеры использования – http://habrahabr.ru/blogs/php/56289/ и http://habrahabr.ru/blogs/php/89175
• PhpUnit + NetBeans http://habrahabr.ru/blogs/php/70046/
• PhpUnit + Magento – http://www.magentocommerce.com/wiki/development/phpunit_integration_with_magento

Предварительные условия

Для создания юнит-тестов Вам необходимо произвести установку PhpUnit и xDebug. Использование xDebug позволяет производить генерацию отчетов по тестированию, с отображением информации об покрытие исходного кода тестами. Я не буду подробно останаливаться на процессе установки. В интернете достаточно много примеров установки и настройки. Например вот этот краткий мануал

Настройка phpUnit для Magento

Мы подошли к основной части статьи. Для тестирования приложений мы будем использовать комбинацию phpunit.xml (конфигурационный файл), bootstrap.php (стартовый файл для инициализации) и ControllerTestCase.php (базовый класс для всех юнит тестов).
Для тестирования будем использовать слейдующую структуру каталогов.

Папка с тестами находится в корне установленной Magento, на одном уровне с папками app, skin, media и т.д.
Каталог unit – содержит файлы юнит-тестов, каталог report – сгенерированный отчет выполнения тестирования.

Переходим к содержимому файлов.

phpunit.xml – файл конфигурации

<phpunit bootstrap="bootstrap.php"
		colors="true"
		convertErrorsToExceptions="true"
		convertNoticesToExceptions="true"
		convertWarningsToExceptions="true"
		stopOnFailure="true"
                syntaxCheck="true">
    <testsuite name="nameofsuite">
        <directory>./</directory>
    </testsuite>
    <filter>
        <blacklist>
            <directory suffix=".php">../tests</directory>
            <directory suffix=".php">../lib</directory>
            <directory suffix=".php">../app/code/core</directory>
            <directory suffix=".php">../app/code/community</directory>
        </blacklist>
    </filter>    
    <logging>
        <log type="coverage-html" target="./report" charset="UTF-8" yui="true" highlight="true" lowUpperBound="35" highLowerBound="70"/>
    </logging>    
</phpunit>

В данном файле мы указываем какие дирректори не надо включать в тестирование. К ним я отнес файлы тестов, файлы community библиотек, и исходные файлы magento. Так же мы добавляем возможность автоматической генерации отчета по выполнению тестирования.

bootstrap.php – стартовый файл

require_once 'PHPUnit/Framework.php';
require_once './../app/Mage.php';
Mage::app('default');

Достаточно небольшой файл производящий подключение классов для юнит-тестирования и инициализирующий magento приложение (подобный подход для иницализации так же используется в magento cron.php)

ControllerTestCase.php – базовый класс наследник для всех юнит тестов

abstract class ControllerTestCase extends PHPUnit_Framework_TestCase {
 
    public $connection;
 
    public function setUp() {
 
        parent::setUp();
 
        $class  = $this->_colorize(get_class($this), 'blue');
        $method = $this->_colorize($this->getName());
 
        echo "\n" . $class . ' -> ' . $method;
 
        $this->_time = microtime(1);
 
        $this->connection = Mage::getModel('Core/Mysql4_Config')->getReadConnection();
        $this->connection->beginTransaction();
 
    }
 
    public function tearDown() {
        $time = sprintf('%0.3f sec', microtime(1) - $this->_time);
 
        echo "\t" . $this->getCount() . '(Assertions)';
 
        echo $this->_colorize("\t" . $time, 'green');
 
        $this->connection->rollBack();
 
        parent::tearDown();
 
 
    }
 
 
 
    private function _colorize($text, $color = 'yellow')
    {
        switch ($color) {
            case 'red':
                $color = "1;31m";
                break;
            case 'green':
                $color = "1;32m";
                break;
            case 'blue':
                $color = "1;34m";
                break;
            default:
                $color = "1;33m";
                break;
        }
        return "\033[" . $color . $text . "\033[m";
    }
}

Содержимое файла частично было взято из юнит тестов CMF разработанной на базе Zend Framework – ZFCore.
Функция setUp выполняется перед каждым юнит-тестом. Она получает ссылку на коннект к базе данных и стартует транзацию (нет смысла каждый раз производить чистку magento приложения от тестовых данных). Производит запись времени начала теста и вывод дополнительной полезной информации.
Функция tearDown выполняется после каждого юнит-теста. Производит откат транзации и выводит тестовую информацию о времени выполнения теста и количестве выполненных утверждений.

unit/SimpleFileOfTest.php – базовый каркас для каждого созданного юнит теста

class SimpleFileOfTest extends ControllerTestCase {
 
    public function setUp() {
        parent::setUp();
    }
 
    public function testMagentoModel() {
      // Some test case
    }
 
    public function tearDown() {
        parent::tearDown();
    }
}

В данном файле мы производим вызов методов перед началом теста и после окончания, не забывая вызвать методы родительского класса. Метод testMagentoModel будет выполняться как тестовый кейс.

Такой структуру приложения будет достаточно для выполнения тестирования Ваших magento модулей.

Пример юнит-тестирования

Ранее я описывал возможность создания order в Magento программными средствами. Давайте создим юнит тест для этого функционала.

Создаем файл CreateOrderTest.php с слейдующим содержанием.

class CreateOrdersTest extends ControllerTestCase {
 
    protected $createOrderModel;
 
    public function setUp() {
        parent::setUp();
 
        $this->createOrderModel = new Spiri7_Test_Model_CreateOrders;
 
    }
 
    /**
     * Test order creation for some predeffined Values
     *
     * @dataProvider orderProvider
     */
    public function testCreateOrder($productInfo, $billingInfo, $shippingInfo) {
 
        $result = $this->createOrderModel->createOrder($productInfo, $billingInfo, $shippingInfo);
        $orderId = $result['orderId'];
 
        // Test for right Create Order. Order Id Must me not zero
        if ($orderId == 0) {
            $this->fail($result['message']);
        }
 
        // Checking create order for right product
        $order = Mage::getModel('sales/order')->load($orderId);
        $items = $order->getAllItems();
        $itemcount = count($items);
        // We adding only single product
        $this->assertTrue($itemcount == 1);
 
        $name=array();
        $unitPrice=array();
        $sku=array();
        $ids=array();
        $qty=array();
        foreach ($items as $itemId => $item)
        {
                $unitPrice[]=$item->getPrice();
                $ids[]=$item->getProductId();
                $qtyOrdered[]=$item->getQtyOrdered();//ToInvoice();
        }
 
 
        // Order created for right product
        $this->assertEquals($ids[0], $productInfo[0]['id']);
 
        // Price for product same as we set
        $this->assertEquals($unitPrice[0], $productInfo[0]['price']);
 
        // Qty of ordered product same as we adding
        $this->assertEquals($qtyOrdered[0], $productInfo[0]['qty']);
    }
 
    public function orderProvider() {
        // Billing address used for order
        $orderBilling = array();
        $orderBilling['firstname'] = "Alex";
        $orderBilling['lastname'] = "Filin";
        $orderBilling['company'] = '';
        $orderBilling['email'] = 'alexandr.otchenashev@gmail.com';
        $orderBilling['street'] = array();
        $orderBilling['street'][0] = "Address part Line1";
        $orderBilling['street'][1] = "Address part Line2";
        $orderBilling['city'] = "Dnepropetrovsk";
        $orderBilling['region_id'] = 1;
        $orderBilling['region'] = "";
        $orderBilling['postcode'] = "49100";
        $orderBilling['country_id'] = "US";
        $orderBilling['telephone'] = "0238559322";
        $orderBilling['fax'] = "0838559111";
 
        // Order Shipping information
        $orderShipping = array();
        $orderShipping['title'] = "UPS";
        $orderShipping['price'] = 100.00;
 
        $dataArray = array(
            "Simple Product" => array(
                array(          // Product Info
                      0 =>  array(
                        'id' => 47, // Simple Product ID without custom options
                        'qty'=> 3,
                        'price' => 123
                     )
                ),
                $orderBilling,
                $orderShipping,
            ),
            "Simple Product With Custom Options" => array(
                array(          // Product Info
                      0 =>  array(
                        'id' => 48, // Simple product ID with custom options
                        'qty'=> 3,
                        'price' => 123
                     )
                ),
                $orderBilling,
                $orderShipping,
            )
        );
 
 
        return $dataArray;
    }
 
    public function tearDown() {
        parent::tearDown();
    }

В setUp производим загрузку модели для создания ордеров. Метод orderProvider возвращает набор данных используемых для тестирования (я произвожу тестирования для simpleproduct с произвольными опциями и без). Метод testCreateOrder производит тестирование создания ордера для наших наборов данных. Обртите внимание что после вызова метода создания, мы проверяем на наличие в возврате id созданного заказа. Если id = 0, тест завершается неудачей и выводом ошибки. При успешном создании производится сверка на правильность добавленного продукта, правильной установки цены и количества товара.

Производим запуск тестов. Для этого в дирректории /tests/ выполняем команду phpunit, результат выполнения будет слейдующий:

Как видно из результата, второй тест завершился неудачей. Возвратилась ошибка.

В результате выполнения тестов был сгенерирован report с информацией о покрытии кода.

Выводы

Unit-тестирование выполяемое для magento не сильно отличается от тестирования любого другого приложение. Единственным недостатком следует признать сложность начальной конфигурации, и проблемотичность отладки итоговых тестов. Так же для меня остается не раскрытым вопрос о тестировании контроллеров.
Спасибо за внимание. Буду раз вашим комментариям и уточнением. А как производите тестирование magento модулей, Вы?Похожие посты:

• Magento: программное создание ордера
• Magento: программное создание ордера. Версия 2
• Magento: создание Shipping method
• Magento: создание пользователя
• Magento: конвертация валют

Платформа Magento eCommerce уверенно завоевывает популярность. На habrahabr уже было несколько упоминаний о ней. В этой статье я хочу описать некоторые моменты когда Вам стоит выбрать платформу Magento.

Хостинг

Magento Commerce не будет работать на простом shared хостинге. Разработчики рекомендуют устанавливать 256Мб оперативной памяти доступной скрипту. Минимально желательным размером является 64Мб, но будьте готовы что без включенного кеша большая часть страниц грузиться не будет.

Так же обратите внимание на cpu лимит хостинга. В моей практике были случаи когда сайт отключили из-за нагрузки на процессор более 3%. При этом за день на сайт заходило не более 15-25 человек.

Хостинг который сможет вытянуть простой магазин на Magento, с посещаемостью 20-50 человек в сутки, стоит около 70$/год. Специализированные хостинг планы для Magento стоят в районе 20$/месяц. Магазин на таком тарифе работает достаточно шустро, без проблем вытягивает посещаемость порядка 300 человек/день.

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

hostmonster.com стоимость порядка 70$/год (25 пользователей, 30минут)

nic.ru тариф 201 – ~110$/год (50 пользователей, 30минут)

1gb.ru, тариф VZ-1 ~130$/год (50 пользователей, 30минут)

ngx.nl ~ 300$/год (25 пользователей, 30минут)

Рынок продаж

Magento разрабатывается украинской командой разработчиков, но методы оплаты и доставок рассчитываются на западный рынок (Европа, США и т.д.). Коробочная версия включает слейдующие методы оплаты: оплата через Credit Card, PayPal, Authorize.net, Payflow Pro, оплата чеком, банковский перевод. Кроме тогда интеграция с большинством западных платежных систем доступна в виде бесплатных расширений.

Если Вам необходима поддержка WebMoney придется покупать платное расширение (бесплатных аналогов нет). Для “Яндекс денег” расширения я не нашел.

Для русских магазинов реальная возможность использовать только методы оплаты: “Наличными при получении”, “Банковский перевод”. Но для этого придется дополнительно объяснять каждому клиенту как произвести оплату и периодически проверять поступление денег на счет.

По умолчанию доступны следующие методы доставки: Table rates, Flat Rate, Free shipping, UPS, USPS, FedEx, DHL. С данным вопросом ситуация чуть лучше, дополнительно можно установить бесплатные расширения – “Local Pickup”, “Multiple tables rate” – которые в большинстве случаев покрывают требования магазина. Например используя “Multiple tables rate” можно дать пользователю возможность выбора требуемого способа доставки и региона. В зависимости от выбора формировать стоимость. Например сформировать такую таблицу:

Так же следует отметить отсутствие интеграции с 1C, что для некоторых клиентов является достаточно необходимым фактором. В защиту можно сказать, что Magento не поддерживает(в коробочной версии), не одной подобной интеграции – имеется импорт/экспорт csv файлов с списком категорий и продуктов.

Локализация

Как и в предыдущем пункте, перевод на русский язык оставляет желать лучшего. Пакет локализации необходимо будет скачать с официального сайта, этот пакет находится в бете, процесс завершенности порядка 90%. Правда в недрах форума можно найти пользовательскую локализацию, тут ситуация немного лучше. Но в любом случае придется дополнительно производить замену ряда сообщений. Так же пользователю придется поменять все html шаблоны стандартных писем. Таких писем порядка 35.

Встроенный функционал

Одна из сильнейших сторон Magento это обширный встроенный функционал – то что Вы получаете после установки магазина. Установив магазин вы получите следующие возможности:

• Множество валют
• Многоязычность
• Множество сайтов на одной системы
• Скидки/купоны
• Отчеты
• Отмеченные товары
• Ограничение доступа
• И другое

Полных список возможностей можно посмотреть на wikipedia

В тоже время, это и недостаток. Если часть функционала на frontend не нужна, разработчику придется постараться что бы его отключить (об этом подробнее ниже)

Разработка

Magento является достаточно сложной системой основанной на базе Zend Framework. Для работы с динамическим содержимым используется фреймворк Prototype, а не знакомый большинству jQuery (для подключения которого придется неплохо постараться). Так же, Magento не используется классический патерн MVC. Для генерации страниц используется набор следующих элементов: Controller, Model, Block, View. Таким образом, загрузить напрямую страницу шаблона из контроллера у Вас не получится. Для генерации страниц помимо стандартных phtml файлов с шаблонами, используются xml файлы, определяющие какие блоки включаются в текущую страницу.

Исходя и вышесказанного – если Вам необходимо сделать уникальный шаблон для магазина, на базе разработанного дизайнером psd файла, необходимо будет привлекать помимо верстальщика еще и программиста. Будьте готовы заплатить серьезную сумму разработчику для привязки дизайна.

Для примера, когда я только начал знакомиться с Magento, передо мной стояла задача произвести привязку достаточно непростого дизайна. В общей сложности на создание темы (без дополнительных расширений) у меня ушло порядка трех недель. Сейчас сложную тему можно привязать за 1-2 недели. Простую тему в районе трех дней. Правда, были прецеденты что сверстанный дизайн простой темы привязался за один день. Конечно есть более простой вариант купить готовую тему на http://www.templatemonster.com/.

Рассмотрим простой пример. Нам необходимо отключить отображение блока “Compare Products”. Что бы убрать этот блок придется произвести изменение в приблизительно 5 различных xml файлах. В тоже время magento позволяет включить отладочную информацию – отображение пути к шаблонам для каждого блока, но увы не показывает в каком xml файле можно его отключить.

Но, в тоже время, используя лишь модификацию шаблонов можно реализовать магазин с уникальным требуемым функционалом.

Magento отличается очень высокой степенью расширяемости. Фактически любую возможность магазина можно переопределить, подменить файлами разработчика. И внимание, для этого не надо переписывать исходных код движка! Для любой модели, блока можно создать “rewrite” и заменить его собственным. Для контроллеров можно активировать перенаправление путей запроса. Кроме того используя event observer для большинства ключевых действий можно добавить произвольный функционал. Использование стороннего кода, не затрагивающего core файлы, позволяет осуществлять безболезненное обновление к новым версиям magento.

Суммируя пункт разработка – при создании дополнительных расширений для Magento, для привязки дизайна, будьте готовы выделить серьезную сумму. Разработчиков знакомых с этой системой, еще не очень много. А те кто работают с ней имеют много заказов и серьезную стоимость часа работы.

Юзабилити

По отзывам некоторых клиентов, magento имеет очень удобный интерфейс администраторской части. Я соглашусь с их мнением. Действительно backend у magento выполнен отлично. Потратив немного времени пользователь сможет произвести основные действия, не заглядывая в помощь. В тоже время некоторые моменты могут быть достаточно непрозрачными. Например управление налогам, создание рассылок, управление локализацией, несколькими валютами, различными видами магазина. Функционал Magento позволяет реализовать управление магазинами с различными доменными имен используя общий backend. При этом, пользователи даже могут не знать что эти магазины связаны.

С frontend частью стандартного магазина не все хорошо. Согласно большинству отзывов часть оформления заказа сложна для пользователя (придется пройти через 5 шагов).

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

None Found

                 $this->widget('application.extensions.mbmenu.MbMenu',array(
			  'items'=>array(
			      array('label'=>'Home', 'url'=>array('/site/index')),
			      array('label'=>'About', 'url'=>array('/site/page', 'view'=>'about'),
				'items'=>array(
				    array('label'=>'Contact', 'url'=>array('/site/contact')),
				    array('label'=>'sub 2 contact', 'url'=>array('/admin/invoice/')),
				)
			      ),
			      array('label'=>'Login',
				'items'=>array(
				    array('label'=>'Login', 'url'=>array('/site/login'), 'visible'=>Yii::app()->user->isGuest),
				    array('label'=>'Logout ('.Yii::app()->user->name.')', 'url'=>array('/site/logout'), 'visible'=>!Yii::app()->user->isGuest)
				  ),
				),
			      array('label'=>'Content',
				'items'=>array(
				    array('label'=>'Categories', 'url'=>array('/content/category')),
				    array('label'=>'Articles', 'url'=>array('/content/articles'))
				  ),
				),
			   ),
			  'htmlOptions' => array('class' => 'my-class')
		  ));

Добавим в каждый xml конфигурационный файл модуля раздел содержащий пункты меню для административной части

<?xml version="1.0"?>
<config>
    <name>content</name>
    <version>1.0.0</version>
    <active>true</active>
    <creationDate>2009-03-27</creationDate>
    <author>SpiRi7</author>
    <authorEmail>alex@spiri7.net</authorEmail>
    <authorUrl>http://spiri7.net</authorUrl>
    <copyright></copyright>
    <license></license>
    <description>Content module</description>
    <adminhtml>
        <menu>
            <content>
                <label>Content</label>
                <sort_order>5</sort_order>
                <items>
                    <categories>
                        <label>Categories Manager</label>
                        <sort_order>1</sort_order>
                        <url>/admin/content/category</url>
                    </categories>
                    <articles>
                        <label>Articles Manager</label>
                        <sort_order>2</sort_order>
                        <url>/admin/content/articles</url>
                    </articles>
                </items>
            </content>
        </menu>
    </adminhtml>
</config>

Разберем структуру xml файла.
Содержимое меню находится в ноде adminhtml->menu. Каждый узел представляет собой один пункт меню. “content” — уникальный идентификатор пункта меню, является верхним уровнем дерева меню. “label” — текст пункта, “sort_order” — сквозной порядок сортировки, “items” — дочерние элементы меню, “categories” и “articles” дочернии идентификаторы меню, “url” — действие выполняемое по щелчку мышки (если не указано, действие не выполняется).

Для построения меню добавим layout административной части ( у меня он называется backend.php) следующий код

$backendMenu = $this->getBackendMenu();
$this->widget('application.extensions.mbmenu.MbMenu',$backendMenu);

Метод getBackendMenu находится в базовом контроллере для всех контроллеров административной части приложения. Он возвращает массив элементов меню. Этот метод мы рассмотрим чуть позже.

Перейдем к части анализа xml файла конфигурации и генерация кеша элементов меню. Для этого добавим следующий код в метод actionIndex контроллера InstallController модуля core.

        $model = new Resource();
 
        // Refresh backend menu manager
        $model->refreshBackendMenu();

метод производит обновление кеша меню установленных модулей. Рассмотрим его содержимое. Файл модели Resource.php

    /**
     * Force refresh backend menu elements.
     * Read all xml configuration file, analize and create cache
     */
    public function refreshBackendMenu() {
        $totalBackendMenuArray = array();
 
        // Get all modules configuration files (configuration stored as xml file)
        // For each file recive backend menu and merge to total backend menu
        // @todo get config file only for installed modules (not for all config into dirrectory)
        $configFileList = glob(YiiBase::getPathOfAlias('application.config.modules')."/*.xml");
        foreach ($configFileList as $singleConfigFile) {
            $config = new SimpleXMLElement($singleConfigFile, NULL, true);
            $nodes = $config->xpath('/config/adminhtml/menu/*');
 
            $menuItemsForModule = $this->parsingXmlMenu($nodes);
            $totalBackendMenuArray = CMap::mergeArray($totalBackendMenuArray, $menuItemsForModule);
 
        }
        // Sorting total menu items array by key "sort_order"
        $this->sortingMenuItems($totalBackendMenuArray);
        $outputMenu['items'] = $this->convertXmlMenuFormatToOutputFormat($totalBackendMenuArray);
 
 
        $fh = fopen(YiiBase::getPathOfAlias('application.cache')."/backendmenu.ser", "w");
        fwrite($fh, serialize($outputMenu));
        fclose($fh);
    }
 
    protected function convertXmlMenuFormatToOutputFormat($xmlMenuFormat) {
        $outputMenu = array();
        foreach ($xmlMenuFormat as $single) {
            $menuItem = array();
            $menuItem['label'] = $single['label'];
            if (isset($single['url'])) {
                $menuItem['url'] = array($single['url']);
            }
 
            if (isset($single['items'])) {
                $menuItem['items'] = $this->convertXmlMenuFormatToOutputFormat($single['items']);
            }
            $outputMenu[] = $menuItem;
        }
        return $outputMenu;
    }
    /**
     * Recursive function for parsing XML Object with menu information
     *
     * @param SimpleXMLElement $nodeElements xml element of current level
     */
    protected function parsingXmlMenu($nodeElements) {
        $returnArray = array();
        foreach ($nodeElements as $element) {
 
            $nodeName = $element->getName();
            $returnArray[$nodeName] = array();
            if ($element->label) {
                $returnArray[$nodeName]['label'] = $element->label."";
            }
            if ($element->sort_order) {
                $returnArray[$nodeName]['sort_order'] = $element->sort_order."";
            }
            if ($element->url) {
                $returnArray[$nodeName]['url'] = $element->url."";
            }
 
            if ($element->items) {
                $returnArray[$nodeName]['items'] = $this->parsingXmlMenu($element->xpath("items/*"));
            }
        }
        return $returnArray;
    }
 
    /**
     * Recursive function for sorting all menu for backend
     * including children items. Return nothing. Result in input param
     * $menuItems
     *
     * @param array $menuItems
     */
    protected function sortingMenuItems(&$menuItems) {
        uasort($menuItems, "Resource::sortingByKeySortOrder");
        foreach ($menuItems as $key => $item) {
            if (isset($item['items'])) {
                $this->sortingMenuItems($menuItems[$key]['items']);
            }
        }
    }
 
    /**
     * User definated array sorting function
     * @param array $a item of array
     * @param array $b item of array
     * @return result of compare 0, 1, -1
     */
    public static function sortingByKeySortOrder ($a, $b) {
        if ($a['sort_order'] == $b['sort_order']) return 0;
        return ($a['sort_order'] > $b['sort_order']) ? 1 : -1;
    }

Рассмотрим созданные методы
refreshBackendMenu производит считывание всех конфигурационных файлов модулей, парсит xml (метод parsingXmlMenu) содержимое и формирует общий массив меню админки ($totalBackendMenuArray). Обратите внимание что для объединения массивов используется функция CMap::mergeArray которая производит слияние элементов дополняя и заменяя дублирующие. После этого производится сортировка элементов согласно ключу sort_order (метод sortingMenuItems). Далее производится отсечение не нужных элементов массива(метод convertXmlMenuFormatToOutputFormat). И запись новых элементов меню в кеш файл (как serialize данные).

Рассмотрим метод который производит считывание кеша и возвращает массив элементов меню.
Данный код помещает в AdminController

    public function getBackendMenu() {
        // File with serialize menu data
        $fname = YiiBase::getPathOfAlias('application.cache')."/backendmenu.ser";
 
        if (!file_exists($fname)) {
            // When file not exits
            // Create it by calling method to refresh menu
            $model = new Resource();
            // Refresh backend menu manager
            $model->refreshBackendMenu();
            // Show notification to user
            Yii::app()->user->setFlash('success',"Create backend menu success.");
        }
        // Read file content and return array of menu
        $fh = fopen($fname, "r");
        $outputMenu = fread($fh, filesize($fname));
        $outputMenu = unserialize($outputMenu);
        fclose($fh);
        return $outputMenu;
    }

Обратите внимание, если файла с кешем не существует проивозится вызов метода который создает файл с данными о меню.

Немного подробнее остановится на формировании xml файлов.

<adminhtml>
        <menu>
            <system>
                <items>
                    <invoice>
                        <label>Manage Invoice</label>
                        <sort_order>1</sort_order>
                        <url>/admin/invoice/index</url>
                    </invoice>
                </items>
            </system>
        </menu>
    </adminhtml>

Такая структура позволит нам добавить еще один дочерний элемент в меню с идентификатором system, который будет размещен первым (sort_order = 1)

Результатом работы структуры созданной в рамках статьи будет

Спасибо за внимание. Буду рад услышать Ваши комментарии и отзывы. Похожие посты:

• Yii: Краткий обзор
• Yii: инсталяция модулей
• Yii: организация backend для приложения

При создании веб приложения на Yii используя консольную утилиту, все контроллеры наследуются от Controller, в котором определяется используемый layout, меню и т.п. Естественно для административной части нам необходимо использовать другой layout, и другие основные действия. Поэтому создадим новый экземпляр CController — AdminController.

class AdminController extends CController {
 
    public $breadcrumbs=array();
 
    public function init() {
        Yii::app()->layout = "backend";
    }
 
}

Как видно из кода мы используем layout — “backend”. Который мы размещаем в папку с темой для приложения /themes/classic/view/layout/backend.php
Все отображения административного функционала находятся в директории модуля, например так – /modules/modulename/views/admin/action/view.php
Таким образом мы можем произвести перегрузку любого отображения в папке с темой. Для указанного выше примера файла отображения, в папке темы должен быть выдержанна следующая структура.
/themes/classic/views/modulename/admin/action/view.php

Доступ к административной части модуля будет осуществляться по адресу
/module/admin/action/. Используя urlManager произведем переопределение используемых адресов.
Файл конфигурации, по умолчанию /protected/config/main.php

                'urlManager'=>array(
                    'urlFormat'=>'path',
                    'showScriptName'=>false,
                    'rules'=>array(
                            'admin/<_m:\w+>/<_c:\w+>/<_a:\w+>/*'=>'<_m>/admin/<_c>/<_a>',
                            'admin/<_m:\w+>/<_c:\w+>'=>'<_m>/admin/<_c>/index',
                            'admin/<_m:\w+>'=>'<_m>/admin/default/index',
                        )
                ),

Таким образом доступ к административному функционалу возможен по такому адресу
/admin/modulename/action — что является более наглядным.

Надеюсь эта заметка поможет Вас в организации ваших backend контроллеров. Буду рад любым предложениям и замечаниям. Похожие посты:

• Yii: Краткий обзор
• Yii: инсталяция модулей
• Yii: динамическое меню для backend приложения

'modules' => array('content','core','forum')

Рассмотрим систему как можно автоматизировать процесс нахождения модуля yii фреймворком.

Начнем с небольшого лирического отступления.

Последнее время я достаточно плотно работаю с движком создания интернет магазинов Magento. Эта система построена полностью на модульной архитектуре. Разработчики помещают собственный модули в каталог /app/code/local/CompanyName/ModuleName. Каждый модуль содержит файл /etc/config.xml – содержащий конфигурационные настройки модуля, папку /sql/modulename_setup/ – содержащую sql скрипты инсталяции и обновления базы. Дополнительно в директорию /app/etc/modules помещается xml файл с краткой информацией о модуле. Magento при обновлении кеша (или при любом действии в админке, если кеш отключен) производит проверку на наличие новых модулей или наличия обновления, и производит автоматическое выполнение sql скриптов. Я хочу показать реализацию подобной системы для Yii фреймворка

Сформулируем задачи которые необходимо выполнить:

1. Необходимо производить изменение конфигурационного файла приложения при установке/удаления модуля
2. Обеспечить хранение текущих версий установленных модулей в базе данных
3. Дать возможность выполнять sql скрипты при установке, обновлении и удалении модуля
4. Предоставить интерфейс для управления модулями

Структура файлов проекта

Каталог /protected/config содержит 3 конфигурационных файла:

• config.php – основной конфигурационный файл приложения. Настройки базы данных, названия приложения, используемых язык и т.п.
• modules.php – список установленных модулей
• main.php – файл производящий объединение данных в config.php и modules.php

Дополнительный каталог /protected/config/modules/ содержит xml файлы конфигурации каждого модуля установленного в веб-приложении. Например: content.xml, forum.xml, core.xml

Пример структуры конфигурационного файла модуля (на примере content.xml)

<?xml version="1.0"?>
<config>
    <name>content</name>
    <version>1.0.0</version>
    <creationDate>2009-03-27</creationDate>
    <author>SpiRi7</author>
    <authorEmail>alex@spiri7.net</authorEmail>
    <authorUrl>http://spiri7.net</authorUrl>
    <copyright></copyright>
    <license></license>
    <description>Content module</description>
</config>

Из данного файла мы будем использовать только ноды – name и version

Каждый модуль содержит директорию setup, в которой находятся файлы инсталляции, обновления, удаления модуля: install-1.0.0.sql, uninstall-1.0.0.sql, upgrade-0.9.0-1.0.0.sql. Каждый из этих файлов содержит набор sql инструкций для базы данных.

Конфигурационные файлы

Как я писал выше мы используем 3 конфигурационных файла: main.php, config.php, modules.php
Рассмотрим их содержимое:
config.php – обычный конфигурационный файл приложения

return array(
	'basePath'=>dirname(__FILE__).DIRECTORY_SEPARATOR.'..',
	'name'=>'Yii-Web',
	'preload'=>array('log'),
	'import'=>array(
		'application.models.*',
		'application.components.*',
	),
 
	// application components
	'components'=>array(
		'user'=>array(
			// enable cookie-based authentication
			'allowAutoLogin'=>true,
                        'loginUrl'=>array('admin/core/dashboard/login'),
		),
		'db'=>array(
                    'class'=>'system.db.CDbConnection',
                    'connectionString'=>'mysql:host=localhost;dbname=yii_test',
                    'username'=>'root',
                    'password'=>'',
                    'charset'=>'utf8',
                    'tablePrefix' => ''
		),
		'errorHandler'=>array(
                        'errorAction'=>'site/error',
                ),
		'log'=>array(
			'class'=>'CLogRouter',
			'routes'=>array(
				array(
					'class'=>'CFileLogRoute',
					'levels'=>'error, warning',
				),
			),
		),
	),
        'theme' => 'classic',
        'language' => 'ru',
	'params'=>array(
		// this is used in contact page
		'adminEmail'=>'webmaster@example.com',
	),
);

modules.php – список установленных модулей, этот файл мы будем генерировать.

 return array(
 'modules' => array('content','core','invoice',)
);

main.php – связка двух конфигурационных файлов в один

return CMap::mergeArray(
    require(dirname(__FILE__).'/config.php'), 
    require(dirname(__FILE__).'/modules.php')
);

Обратите внимание, что нет необходимости менять стартовый index.php. После создания нового приложения, он по умолчанию ссылается на конфигурационный файл main.php

Управление модулями

Перейдем непосредственно к коду. Для управления модулями я создал модуль core, в котором создал контроллер InstallController.php, модель Resource (ActiveRecord связана с таблицей core_resource).
Структура таблицы из БД

CREATE TABLE  `yii_test`.`core_resource` (
  `resource` varchar(50) NOT NULL,
  `version_installed` varchar(50) DEFAULT NULL,
  `version_available` varchar(50) DEFAULT NULL,
  `need_install` tinyint(2) NOT NULL DEFAULT '0',
  `need_upgrade` tinyint(2) NOT NULL DEFAULT '0',
  `need_uninstall` tinyint(2) NOT NULL DEFAULT '0',
  PRIMARY KEY  (`resource`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC

resource – название ресурса (модуля)
version_installed – установленная версия (пустое значение если необходима установка)
version_available – доступная версия модуля
need_install/need_upgrade/need_uninstall флаги о необходимости установки, обновления, удаления

Контроллер

class InstallController extends AdminController {
    /**
     * @var CActiveRecord the currently loaded data model instance.
     */
    private $_model;
 
    /**
     * @return array action filters
     */
    public function filters() {
        return array(
                'accessControl', // perform access control for CRUD operations
        );
    }
 
    /**
     * Specifies the access control rules.
     * This method is used by the 'accessControl' filter.
     * @return array access control rules
     */
    public function accessRules() {
        return array(
                array('allow', // allow authenticated user to perform all actions
                        'users'=>array('admin'),
                ),
                array('deny',  // deny all users
                        'users'=>array('*'),
                ),
        );
    }
 
    /**
     * Lists of all installed modules.
     */
    public function actionIndex() {
 
        $model = new Resource();
 
        // Refresh backend menu manager
        // Refreshing installing modules
        $model->refreshModuleList();
 
        $dataProvider=new CActiveDataProvider('Resource', array());
 
        $this->render('resources',array(
                'dataProvider'=>$dataProvider
        ));
    }
 
    /**
     * Process install/upgrade/uninstall action
     */
    public function actionProcess() {
        $resourceName = $_GET['resource'];
        $actionName = $_GET['action'];
        $model = new Resource();
        $newVersion = $model->updateResource($resourceName, $actionName);
 
        Yii::app()->user->setFlash('success',"Module <b>".$resourceName."</b> success ".$actionName.". SQL script version: ".$newVersion);
        $this->redirect(Yii::app()->createUrl("admin/core/install/index"));
    }
}

Разберем код подробнее.
actionIndex – производит обновление установленных модулей, и передачу данных в отображение списка записей в таблице
actionProcess – производит установку, удаление, обновления модуля (выполнение sql файлов) и передает управление в index (т.е. вывод списка на экран)

Отображение

<?php $this->widget('zii.widgets.grid.CGridView', array(
	'id'=>'articles-grid',
	'dataProvider'=>$dataProvider,
	'columns'=>array(
		'resource',
		'version_installed',
                'version_available',
		array(
			'class'=>'CButtonColumn',
                        'buttons'=>array(
                                'install'=>array(
                                    'label'=>'Install',
                                    'visible'=>'($data->need_install == 1)?true:false',
                                    'url'=> 'Yii::app()->createUrl("admin/core/install/process", array("resource"=>$data->resource,"action"=>"install"))',
                                ),
                                'upgrade'=>array(
                                    'label'=>'Upgrade',
                                    'visible'=>'($data->need_upgrade == 1)?true:false',
                                    'url'=> 'Yii::app()->createUrl("admin/core/install/process", array("resource"=>$data->resource,"action"=>"upgrade"))',
                                ),
                                'uninstall'=>array(
                                    'label'=>'Uninstall',
                                    'visible'=>'($data->need_install == 0)?true:false',
                                    'url'=> 'Yii::app()->createUrl("admin/core/install/process", array("resource"=>$data->resource,"action"=>"uninstall"))',
                                ),
                         ),
                         'template'=>'{install}{upgrade}{uninstall}',
 
		),
 
	),
)); ?>

Отображение достаточно простое – просто производит вывод грида с кнопками для управления.

Модель

<?php
class Resource extends CActiveRecord {
 
    const VERSION_COMPARE_EQUAL   = 0;
    const VERSION_COMPARE_LOWER   = -1;
    const VERSION_COMPARE_GREATER = 1;
 
 
    protected $isUpdated = false;
    /**
     * Returns the static model of the specified AR class.
     * @return CActiveRecord the static model class
     */
    public static function model($className=__CLASS__) {
        return parent::model($className);
    }
 
    /**
     * @return string the associated database table name
     */
    public function tableName() {
        return 'core_resource';
    }
 
    /**
     * @return array customized attribute labels (name=>label)
     */
    public function attributeLabels() {
        return array(
                'resource' => 'Module',
                'version_installed' => 'Installed',
                'version_available' => 'Available',
                'need_install' => 'Need install',
                'need_upgrade' => 'Need upgrade',
                'need_uninstall' => 'Need delete',
        );
    }
 
    /**
     * Refreshing all installed modules list
     */
    public function  refreshModuleList() {
        $connection = Yii::app()->db;
 
        // Clear field that need to install (flag need_install=1)
        $command =  $connection->createCommand("DELETE FROM {{core_resource}} WHERE need_install = 1");
        $command->execute();
 
        // Get all modules configuration files (configuration stored as xml file)
        $configFileList = glob(YiiBase::getPathOfAlias('application.config.modules')."/*.xml");
        // Create config files array of items module=>version
        $installedFileModules = array();
        foreach ($configFileList as $singleConfigFile) {
 
            $config = new SimpleXMLElement($singleConfigFile, NULL, true);
            $installedFileModules[(String)$config->name] = (String)$config->version;
        }
 
        // Get module config array from DB module=>version
        $installedDbModules = array();
        $records = $this->findAll();
        foreach ($records as $recordItem) {
            $installedDbModules[$recordItem->resource] = $recordItem['version_installed'];
        }
 
        // Determinate what modules need to be installed or upgraded
        $updateToDatabase = array();
        foreach ($installedFileModules as $configModuleName => $configVersion) {
            $singleDbUpdate = array(
                    'resource' => $configModuleName,
                    'version_installed' => '',
                    'version_available' => $configVersion,
                    'need_install' => 0,
                    'need_upgrade' => 0,
                    'need_uninstall' => 0,
            );
            if (isset($installedDbModules[$configModuleName])) {
                // Have such module installed into DB
                $status =  version_compare($configVersion, $installedDbModules[$configModuleName] );
                switch ($status) {
                    case self::VERSION_COMPARE_LOWER:
                    //$this->_rollbackResourceDb($configVer, $dbVer);
                        break;
                    case self::VERSION_COMPARE_GREATER:
                    // Need update this module
                        $singleDbUpdate['need_upgrade'] = 1 ;
                        break;
                }
                $singleDbUpdate['version_installed'] = $installedDbModules[$configModuleName];
            } else {
                $singleDbUpdate['need_install'] = 1 ;
            }
            $updateToDatabase[] = $singleDbUpdate;
        }
 
        // Determinate what modules need to be unistalled (no config file found)
        foreach ($installedDbModules as $dbModuleName => $dbVersion) {
            if (!isset($installedFileModules[$dbModuleName])) {
                $singleDbUpdate = array(
                        'resource' => $dbModuleName,
                        'version_installed' => $dbVersion,
                        'version_available' => '',
                        'need_install' => 0,
                        'need_upgrade' => 0,
                        'need_uninstall' => 1,
                );
                $updateToDatabase[] = $singleDbUpdate;
            }
        }
 
        // Process update to DB
        // Clear all records
        $command =  $connection->createCommand("DELETE FROM {{core_resource}}");
        $command->execute();
 
        $sql = "INSERT INTO {{core_resource}} (`resource`, `version_installed`, `version_available`, `need_install`, `need_upgrade`, `need_uninstall`) VALUES ";
        foreach ($updateToDatabase as $singleUpdate) {
            $sql.="('".$singleUpdate['resource']."','".$singleUpdate['version_installed']."','".$singleUpdate['version_available']."', ".$singleUpdate['need_install'].", ".$singleUpdate['need_upgrade'].", ".$singleUpdate['need_uninstall']."),";
 
        }
        $sql = substr($sql,0, -1).';';
        // Insert new list of modules
        $command =  $connection->createCommand($sql)->execute();
 
        // Update module list that installed to system
        // Create string with php code
        $installedModulesAsPhpArray = "<?php\n return array(\n 'modules' => array(";
        foreach ($updateToDatabase as $singleUpdate) {
            if ($singleUpdate['need_install'] == 0 && $singleUpdate['need_uninstall'] == 0) {
                // Write only modules that installed to system
                $installedModulesAsPhpArray.="'".$singleUpdate['resource']."',";
            }
        }
        $installedModulesAsPhpArray.=")\n);";
        // Need to have write permission to file config/modules.php
        $fh = fopen(YiiBase::getPathOfAlias('application.config')."/modules.php", "w");
        fwrite($fh, $installedModulesAsPhpArray);
        fclose($fh);
 
    }
 
    /**
     * Make modifaction for module. Possible to install/upgrade/uninstall module.
     *
     * @param String $resourceName module name that need to perform $action
     * @param String $action action to perform install/upgrade/uninstall
     * @return real version that proccessed after update
     */
    public function updateResource($resourceName, $action) {
        $resource = $this->findByPk($resourceName);
        $version = $this->_modifyResourceDb($resourceName, $action, $resource['version_installed'], $resource['version_available']);
 
        if ($action!="uninstall") {
            // After execute all sql file, update resource information for install/upgrade
            $sql = "UPDATE {{core_resource}} SET version_installed='".$resource['version_available']."'  WHERE resource='".$resourceName."'";
            Yii::app()->db->createCommand($sql)->execute();
        } else {
            // for uninstall delete from table this resource
            Yii::app()->db->createCommand("DELETE FROM {{core_resource}} WHERE resource='".$resourceName."'")->execute();
        }
 
        // Return real updated version
        return $version;
    }
 
    /**
     * Run module modification files. Return version of last applied upgrade (false if no upgrades applied)
     *
     * @param     string $actionType install|upgrade|uninstall
     * @param     string $fromVersion
     * @param     string $toVersion
     * @return    string | false
     */
    protected function _modifyResourceDb($resourceName, $actionType, $fromVersion, $toVersion) {
        $sqlFilesDir = YiiBase::getPathOfAlias('application.modules.'.$resourceName.'.setup'); 
        if (!is_dir($sqlFilesDir) || !is_readable($sqlFilesDir)) {
            return false;
        }
 
        // Read resource files
        $arrAvailableFiles = array();
        $fileToDir = glob($sqlFilesDir."/".$actionType."-*.sql");
        foreach($fileToDir as $sqlFile) {
            $matches = array();
            if (preg_match('#.*'.$actionType.'-(.*)\.sql$#i', $sqlFile, $matches)) {
                $arrAvailableFiles[$matches[1]] = $sqlFile;
            }
        }
 
        if (empty($arrAvailableFiles)) {
            return false;
        }
 
        // Get SQL files name
        $arrModifyFiles = $this->_getModifySqlFiles($actionType, $fromVersion, $toVersion, $arrAvailableFiles);
        if (empty($arrModifyFiles)) {
            return false;
        }
 
        $modifyVersion = false;
        $connection = Yii::app()->db;
        // $connection->pdoInstance->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, true);
 
        foreach ($arrModifyFiles as $resourceFile) {
            try {
                ob_start();
                include_once($resourceFile['fileName']);
                $sql = ob_get_contents();
                @ob_end_clean();
 
                if ($sql!='') {
                    $command1 =  $connection->createCommand($sql);
                    $command1->execute();
                    // For some pdo adapter on next sql query show error
                    $command1->getPdoStatement()->closeCursor();
                }
                // Update Database module version
                $sql = "UPDATE {{core_resource}} SET version_installed='".$resourceFile['toVersion']."'  WHERE resource='".$resourceName."'";
                $connection->createCommand($sql)->execute();
            } catch (Exception $e) {
                $message = 'Error in file: "'.$resourceFile['fileName'].'" - '.$e->getMessage();
                throw new Exception($message);
            }
            $modifyVersion = $resourceFile['toVersion'];
        }
        // On final marked resource as not need install
        $sql = "UPDATE {{core_resource}} SET need_install = 0 WHERE resource='".$resourceName."'";
        $connection->createCommand($sql)->execute();
        return $modifyVersion;
    }
 
 
    /**
     * Get sql files for modifications
     *
     * @param     $actionType
     * @return    array
     */
    protected function _getModifySqlFiles($actionType, $fromVersion, $toVersion, $arrFiles) {
        $arrRes = array();
 
        switch ($actionType) {
            case 'install':
                uksort($arrFiles, 'version_compare');
                foreach ($arrFiles as $version => $file) {
                    if (version_compare($version, $toVersion) !== self::VERSION_COMPARE_GREATER) {
                        $arrRes[0] = array('toVersion'=>$version, 'fileName'=>$file);
                    }
                }
                break;
 
            case 'upgrade':
                uksort($arrFiles, 'version_compare');
                foreach ($arrFiles as $version => $file) {
                    $version_info = explode('-', $version);
 
                    // In array must be 2 elements: 0 => version from, 1 => version to
                    if (count($version_info)!=2) {
                        break;
                    }
                    $infoFrom = $version_info[0];
                    $infoTo   = $version_info[1];
                    if (version_compare($infoFrom, $fromVersion)!==self::VERSION_COMPARE_LOWER
                            && version_compare($infoTo, $toVersion)!==self::VERSION_COMPARE_GREATER) {
                        $arrRes[] = array('toVersion'=>$infoTo, 'fileName'=>$file);
                    }
                }
                break;
            case 'uninstall':
                uksort($arrFiles, 'version_compare');
                foreach ($arrFiles as $version => $file) {
                    if (version_compare($version, $fromVersion) !== self::VERSION_COMPARE_GREATER) {
                        $arrRes[0] = array('toVersion'=>$version, 'fileName'=>$file);
                    }
                }
                break;
 
            case 'rollback':
            // @todo support rollback
                break;
        }
        return $arrRes;
    }
}

Разбираем подробнее.

Метод refreshModuleList – основной метод запускаемый из контроллера когда мы переходит на просмотр грида. Производит удаление из базы данных всех модулей которые требуют установки. Производит считывание конфигурационных файлов модулей (директория /config/modules/*.xml) сохраняет данные в виде: имя модуля – версия. Получаем список модулей известных веб-приложению. В зависимости от результата сравнения данных (конфигурационные файлы – данные в базе) записывает в базу данных обновленные значения, с флагами информирующими о необходимости установки (данный модуль не найден в базе, но есть конфиг), обновления (модуль есть в базе и есть конфиг, но версия конфига более новая), необходимости удаления (нет конфигурационного файла, но имеется запись в базе). Записывает в конфигурационный файл приложения (/config/modules.php) список всех установленных и требующих обновления модулей.

Метод updateResource производит обновление указанного модуля согласно переданному действию. После успешного выполнения – обновляет таблицу core_resource (меняет версию или стирает модуль)

Метод _modifyResourceDb получает полный список sql файлов из директории модуля /modules/modulename/setup и сохраняет их в массив. Вызывает метод _getModifySqlFiles для получения списка файлов которых необходимо выполнить для обновления данных о ресурсе. После этого производит последовательное выполнение каждого файла требуемого для обновления/установки/удаления ресурса.
Обратите внимание на метод $command1->getPdoStatement()->closeCursor(). Sql файл обновления содержит несколько инструкций для модификации базы данных, некоторые pdo адаптеры не завершают корректно данный запрос, и при следующем запросе мы получим ошибку. Эта инструкция принудительно закрывает курсор (сбрасывает кеш).

Метод _getModifySqlFiles согласно передаваемого действия производит анализ списка файлов и возвращает только те которые необходимо использовать при обновлении до требуемой версии.

Результат работы нашего функционала будет следующий:

Недостатки

Такая система содержит ряд недостатков:

• Конфигурационные файлы модуля сделаны в xml формате. Для меня это удобнее, но не совсем Yii-style.
• Конфигурационный файл модуля находится в отдельной папке, для разработчика это может быть частично не удобно. Желательным будем размещение конфига в папке с модулем.
• При обновлении списка модулей выполняется полная очистка таблицы ресурсов. Это не очень красивый подход, возможна ситуация при которой таблица очиститься, а новые данные добавлены не будут.
• Нет защиты модуля от удаления. Например если мы произведем удаление модуля core — для возврата функционирования придется руками править базу данных
• При выполнении sql скриптов установки/обновления/удаления ошибки возвращаться если выполнение первого запроса было неудачным. При ошибке во втором, третьем и т.д. запросе исключение не генерируется, оставшиеся запросы пропускаются
• Возможна более грамотная генерация конфигурационного файла со списком установленных модулей.

Спасибо за внимание. Буду рад любым предложения, замечаниям и вариантам оптимизации.

Исходный код модуля core можно скачать по ссылке модуль coreПохожие посты:

• Yii: Краткий обзор
• Yii: организация backend для приложения
• Yii: динамическое меню для backend приложения

Собственно перейдем к Yii.

Yii достаточно быстро работает, потребляет мало памяти, поддерживает модульную архитектуру, layout, темы. И что самое главное содержит множество классов упрощающих работу с данными, реализацию поддержки jQuery. Используя только php код в отображении можно сделать табличный вывод содержимого таблицы базы данных, поддерживающую поиск, сортировки и дополнительные действия.


Несомненным плюсом является наличие консольной (а в разрабатываемой версии и графической) утилиты для генерации моделей, модулей, CRUD, phpunit тестов. Про CRUD можно сказать отдельно – несколькими командами в консоли можно полностью реализовать управление таблицей из базы данных: просмотр, добавление, редактирование, удаление.

Конечно, Yii не является идеальным. Есть вещи которые хотелось бы немного поменять для себя, переделать и добавить. Но они не является действительно критичными при разработке веб-приложений, и с ними можно мирится.

К главным недостаткам можно отнести “скрытые фичи” фреймворка. Документация не очень подробная, на мой взгляд она описывает только основные моменты. Для большинства случаев приходится лезть в исходных код или смотреть api. В защиту можно сказать, что весь код очень подробно задокументирован, но не всегда понятно как использовать ту или иную фишку класса.
Yii содержит немного не привычную систему работы с базой данных – Active Record. Конечно можно это понять и в полной мере использовать, но на начальном этапе (а я как раз на нем) бывает достаточно сложно разобраться.

Да и самое главное для Yii написано множество полезных расширений, которые после небольших модификаций можно использовать в своих проектах.

На этом я завершаю свой краткий обзор Yii. В ближайшем будущем я постараюсь выложить в блог результаты моего знакомство с Yii.

И на закуску немного ссылок на полезные сайты связанные с тематикой Yii:

• http://www.yiiframework.com – официальный сайт. Есть форум в том числе русский
• http://yiiframework.ru/ – русское сообщество разработчиков. Форум, русская документация
• http://rmcreative.ru/ – блог одного из разработчиков yii. Обратите внимание что разработчик пишет на русском
• http://dbhelp.ru/ – “Маленький” Yii блог. Мануал создания блога, перевод Cookbook, мелкие заметки
• http://www.simplecoding.org – Содержит цикл статей посвященных созданию сайта на Yii

Похожие посты:

• Yii: инсталяция модулей
• Yii: организация backend для приложения
• Yii: динамическое меню для backend приложения
]]> http://spiri7.net/blog/yii/yii-overview/feed 0 http://spiri7.net/blog/yii/yii-overview http://feedproxy.google.com/~r/Spiri7/~3/rzKsuyYB4w8/magento-build-tree http://spiri7.net/blog/magento/magento-build-tree#comments Mon, 15 Mar 2010 21:36:29 +0000 SpiRi7 http://spiri7.net/?p=273 Manage Categories). Для такого построения используется урезанная библиотека Ext и ее дополнительный компонент TreeCheckNode. Рассмотрим процесс создания такого дерева подробнее. Первым шагом необходимо в контролере включить загрузку библиотеки ExtJs public function indexAction() { [...]]]> Сегодня речь пойдет о встроенной в Magento возможности для построения древовидных структур. Движок использует такое дерево при построение списка категорий магазина (Catalog->Manage Categories). Для такого построения используется урезанная библиотека Ext и ее дополнительный компонент TreeCheckNode.

Рассмотрим процесс создания такого дерева подробнее.
Первым шагом необходимо в контролере включить загрузку библиотеки ExtJs

 public function indexAction() {
        $this->loadLayout();
        // Add out block to content to render
        $this->_addContent($this->getLayout()->createBlock('codename/adminhtml_blockname'));
        // Say Magento Load ExtJs
        $this->getLayout()->getBlock('head')->setCanLoadExtJs(true);
        $this->renderLayout();
}

Далее переходим к отображению. Категории для нашего дерева мы будем подгружать используя Ajax, поэтому для начала просто определим начальную информацию о дереве

<script type="text/javascript">
var tree;
var defaultLoadTreeParams = {
		animate:false,
		enableDD:false,
		containerScroll: true,
		rootUIProvider: Ext.tree.CheckboxNodeUI,
		selModel:new Ext.tree.CheckNodeMultiSelectionModel(),
		rootVisible:false
}
/** 
 * Function for render new Tree. 
 * @param requestUrl url for get tree information
 */
function renderNewTree(requestUrl) {
  if (!requestUrl) {
     requestUrl = 'treesample';
  }
  defaultLoadTreeParams['loader'] = new Ext.tree.CustomUITreeLoader({
     dataUrl: requestUrl,
     baseAttr: {
        uiProvider: Ext.tree.CheckboxNodeUI
     }
  });
 
  if (tree) {
     // Clear prev tree version
     tree.purgeListeners();
     tree.el.dom.innerHTML = '';
  }
 
   tree = new Ext.tree.TreePanel('tree-div', defaultLoadTreeParams);
 
   root = new Ext.tree.AsyncTreeNode({
      text: 'root',
      draggable:false,
      id:'source',
      uiProvider: Ext.tree.CheckboxNodeUI
   });
   tree.setRootNode(root);
   tree.render();
   root.expand(false, false, function() {
      if (root.childNodes.length>0) {
        // Tree Successfull loaded (root node has child).
        //  Show tree container
        $("tree-div").show($("tree-div"));
        root.firstChild.expand(false);
      } else {
         // Root node don't have child elements
         // Hide tree container and show some error 
         $("tree-div").hide($("tree-div"));
         alert("Empty Tree!");
      }
  });
}
</script>

Для инициализации дерева необходимо дополнительно создать контейнер с id=”tree-div”

   <div id="tree-div"></div>

В дальнейшем при загрузке документа необходимо произвести вызов функции renderNewTree.

Рассмотри формат данных используемый для указания информации о дереве.

$categoryList = array(
       0 => array(
           "text" => "Sample",
            "id" => 123123,
            "depth" => 0,
            "leaf" => false,
            "children" => array(
                    0 => array(
                       "text" => "Sample2",
                        "id" => 1231233,
                        "depth" => 1,
                        "leaf" => true
                    )
                )
            )
);
echo json_encode($categoryList);

Преведенный выше код вернет данные, на основании которых будет сгенерировано просто дерево из 2х элементов – “Sample” и “Sample2″
Ключ “depth” указывает уровень вложености элемента дерева, а ключ “leaf” говорит является ли элемент последним (дословно листом дерева)
Вот что получилось:


На этом я заканчиваю краткий обзор компонета для построения деревьев в Magento. Надеюсь данный материал пригодиться кому то.
Похожие посты:

• Magento: программное создание ордера
• Magento: программное создание ордера. Версия 2
• Magento: создание Shipping method
• Magento: создание пользователя
• Magento: конвертация валют
]]> http://spiri7.net/blog/magento/magento-build-tree/feed 4 http://spiri7.net/blog/magento/magento-build-tree http://feedproxy.google.com/~r/Spiri7/~3/0tHtppA4xL8/images-more-view http://spiri7.net/blog/magento/images-more-view#comments Wed, 03 Mar 2010 23:14:55 +0000 SpiRi7 http://spiri7.net/?p=251
Сегодня я хотел бы поговорить о стилизации дополнительных изображений товара. По умолчанию magento производит вывод списка изображений подрядят. Если с товаром указывается много фотографий в дизайне это может выглядеть наляписто. Для решения этой проблемы можно использовать слайдер – позволяющий листать изображения в фиксированном боксе. Реализацию данной возможности Я и рассмотрю далее.





Выше представлено изображения окончательного варианта. Я не буду рассматривать тонкости верстки такого блока, единственное что необходимо учитывать это наличие нескольких контейнеров.
На первом этапе производим изменения файла отображения изображений товара. Это файл: app/design/frontend/default/default/template/catalog/product/view/media.phtml
Нас интересует слейдующий кусок кода:

<?php if (count($this->getGalleryImages()) > 0): ?>
<div class="more-views">
    <h4><?php echo $this->__('More Views') ?></h4>
    <ul>
    <?php foreach ($this->getGalleryImages() as $_image): ?>
        <li>
            <a href="#" onclick="popWin('<?php echo $this->getGalleryUrl($_image) ?>', 'gallery', 'width=300,height=300,left=50,top=50,location=no,status=yes,scrollbars=yes,resizable=yes'); return false;"><img src="<?php echo $this->helper('catalog/image')->init($this->getProduct(), 'thumbnail', $_image->getFile())->resize(56); ?>" alt="<?php echo $this->htmlEscape($_image->getLabel()) ?>" title="<?php echo $this->htmlEscape($_image->getLabel()) ?>" /></a>
        </li>
    <?php endforeach; ?>
    </ul>
</div>
<?php endif; ?>

Производим небольшие изменения, добавляем текущую страницу, стрелки вправо/влево, ограничивающий контейнер.

<div class="more-view-page">Страница <span id="img-more-page">1</span> из <?php echo $pageNumber; ?></div>
	  <div class="more-view-arrow step-left-passive" id="more-view-step-left"></div>
	    <div class="more-view-fix">
		    <ul id="more-view-slider">
			    <?php $i = 0;foreach ($this->getGalleryImages() as $_image): ?>
				<li>
	  		             <a href="#"><img src="<?php echo $this->helper('catalog/image')->init($this->getProduct(), 'thumbnail', $_image->getFile())->resize(51); ?>" alt="<?php echo $this->htmlEscape($_image->getLabel()) ?>" title="<?php echo $this->htmlEscape($_image->getLabel()) ?>" /></a>
				</li>
			    <?php endforeach; ?>
		    </ul>
	    </div>
<div class="more-view-arrow step-right-active" id="more-view-step-right"></div>

Обратите внимание что в стилях необходимо будет для контейнера c классом “more-view-fix” задать фиксированную высоту. И для элементов li указать float: left.
Идея скрола заключается в следующем – мы производим изменение css свойства margin-left для элемента ul в отрицательный диапазон. Для анимации движения я предлагаю использовать библиотеку для prototype animator.js

Производим измение шаблона

<!-- Load animator js lib -->
<script src="<?php echo $this->getSkinUrl('js/animator.js');?>" type="text/javascript"></script>
<?php
     // Total number of images
    $_imageNumber =  count($this->getGalleryImages());
    // Total number of scroll page
    $pageNumber = ceil($_imageNumber/5);
?>
 
<script>
 
var startMargin = 0;
// Width of one set of images, how change margin from one click
var marginStep = 340;
var currentPage = 1;
 
// Scroll on left arrow
function sLeft() {
    // Block if first page
    if (currentPage<=1) {
       return;
    }
    currentPage--;
 
    // Hide left arrow if first page
    if (currentPage<=1) {
	$('more-view-step-left').removeClassName('step-left-active');
	$('more-view-step-left').addClassName('step-left-passive');
    }
 
    // Show right arrow if not last page
    if (currentPage< <?php echo $pageNumber;?>) {
	$('more-view-step-right').removeClassName('step-right-passive');
 	$('more-view-step-right').addClassName('step-right-active');
    }
    // Change current page number
    $('img-more-page').innerHTML = currentPage;
 
    var scrollElement = $('more-view-slider');
 
    var newMargin = startMargin + marginStep;
 
    var animationObject = new Animator();
    animationObject.addSubject(new NumericalStyleSubject(scrollElement, 'margin-left', startMargin, newMargin));
    animationObject.play();
 
    startMargin = newMargin;
 
}
// Click on righ arrow
function sRight() {
    // Block if last page
    if (currentPage>=<?php echo $pageNumber;?>) {
       return;
    }
    currentPage++;
    // Hide right arrow for last page
    if (currentPage>=<?php echo $pageNumber;?>) {
 	$('more-view-step-right').removeClassName('step-right-active');
	$('more-view-step-right').addClassName('step-right-passive');
    }
 
    // Show left arrow if page not first
    if (currentPage>1) {
 	$('more-view-step-left').removeClassName('step-left-passive');
	$('more-view-step-left').addClassName('step-left-active');
    }
    // Change current page - show on of slider
    $('img-more-page').innerHTML = currentPage;
 
    var scrollElement = $('more-view-slider');
 
    var newMargin = startMargin - marginStep;
 
    var animationObject = new Animator();
    animationObject.addSubject(new NumericalStyleSubject(scrollElement, 'margin-left', startMargin, newMargin));
    animationObject.play();
 
    startMargin = newMargin;
 
}
 
document.observe('dom:loaded', function(){
// Add event for click action for our arrow 
  $('more-view-step-left').observe('click', sLeft);
  $('more-view-step-right').observe('click', sRight);
})
 
</script>

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

• Magento: программное создание ордера
• Magento: программное создание ордера. Версия 2
• Magento: создание Shipping method
• Magento: создание пользователя
• Magento: конвертация валют
]]> http://spiri7.net/blog/magento/images-more-view/feed 0 http://spiri7.net/blog/magento/images-more-view http://feedproxy.google.com/~r/Spiri7/~3/QHuJvl4VPVM/javascript-fetch-callback http://spiri7.net/blog/javascript/javascript-fetch-callback#comments Fri, 19 Feb 2010 17:38:49 +0000 SpiRi7 http://spiri7.net/?p=237 В процессе работы мне пришлось столкнуться с интерестным плагином для jQuery. Плагин представляет собой календарь позволяющих добавлять события для определенных дат. Функционал реализуемый плагином, в какой мере, подобен google calendar.
Но в этой заметке речь пойдет не о плагине, а о способе получения событий.
Итак необходимо реализовать интерфейс установки массива событий как в виде масива данных, так и в виде URL на серверный обработчик данных. Дополнительным требованием будет возможность поддерживать возможность установки нескольких серверных обработчиков.

Итак первоначально определим обработчик определяющий тип передаваемых данных

var events = [];
var eventSources = options.eventSources || [];
if (options.events) eventSources.push(options.events);

В этом участке кода – options массив исходных настроек.

Следующей задачей является определение обработчика при вызове которого производится анализ/получение данных и их последующая обработка (преобразование, отрисовка и т. п.)
Итак для вызова этих действий будем использовать одну функцию
fetchEvents(renderEvents);
где renderEvents это callback функция обработчик полученных данных.

//
// Fetch from ALL sources. Clear 'events' array and populate
//
function fetchEvents(callback) {
    events = [];
    if (eventSources.length > 0) {
      var queued = eventSources.length;
      // This is a function, code execute only when we call this function
      // Not now
      var sourceDone = function() {
          if (--queued == 0) {
             //  stack of call ++
             popLoading();
             if (callback) {
                 callback(events);
             }
          }
       };
       // Stack of call --
       pushLoading();
       for (var i = 0; i < eventSources.length; i++) {
            fetchEventSource(eventSources[i], sourceDone);
       }
    }
}
 
//
// methods for reporting loading state
//
var loadingLevel = 0;
 
function pushLoading() {
    if (!loadingLevel++ && options.loading) {
        options.loading(true);
    }
}
 
function popLoading() {
    if (! --loadingLevel && options.loading) {
        options.loading(false);
    }
}

Этот кусок кода проверяет на наличие источников событий, если источников более 0, создает функцию обработчик, увеличивает счетчик запусков получения данных. И для каждого источника вызывает функцию получения данных. Обратите внимание что в функцию fetchEventSource кроме текущего источника мы передаем, так же callback функцию.
Итак функция обработчик получения данных

//
// Fetch from a particular source. Append to the 'events' array
//
 
function fetchEventSource(src, callback) {
    // This is callback function for ajax call
    var reportEvents = function(response) {
         for (var i = 0; i < responseEvents.length; i++) {
                // Translate recived events list to our need format
         }
         events = events.concat(responseEvents);
         if (callback) {
            callback(responseEvents);
         }
     };
     if (typeof src == 'string') {
           // Type of source is url 
           var params = {}; // Params for ajax call
            $.getJSON(src, params, reportEvents);
     } else if ($.isFunction(src)) {
           // Tupe of source is function
           src(start, end, reportEvents);
     } else {
          reportEvents(src);
     }
}

Алгоритм работы функции очень простой. Мы определили функцию обработчик вызова данных — reportEvents. Далее, в зависимости от типа исходных данных (url, функция, масив) производим необходимые действия (отправка ajax запроса, прямой вызов обработчика). В дальнейшем функция обработчик вызывает первоначальный указанный callback
Приблизительная схема алгоритма
Похожие посты:

None Found
]]> http://spiri7.net/blog/javascript/javascript-fetch-callback/feed 0 http://spiri7.net/blog/javascript/javascript-fetch-callback http://feedproxy.google.com/~r/Spiri7/~3/AmV19sUOoWw/magento-left-menu-all-category-tree http://spiri7.net/blog/magento/magento-left-menu-all-category-tree#comments Mon, 15 Feb 2010 23:06:16 +0000 SpiRi7 http://spiri7.net/?p=231 В стандартном шаблоне Magento левый блок меню представляет собой список подкатегорий для текущей выбранной категории товаров магазина. Такой подход является оправданным для магазинов с большим количеством товаров. Нет необходимости дублировать полный список категорий в левом блоке, поскольку главное меню уже отображает его. В этой статье я хочу рассмотреть ситуацию когда верхнее меню заменяется на статическое, а в левой части находится список всех категорий и список фильтров.

Первым шагом нам необходимо произвести изменение в layout – xml файлов конфигурации какие блоки необходимо отображать.
design/frontend/default/default/layout/catalog.xml
Находим блок и вставляем/заменяем в секции следующий блок

<block type="catalog/navigation" name="catalog.leftnav" after="currency" template="catalog/navigation/left.phtml"/>
<block type="catalog/layer_view" name="catalog.leftnav.layer" after="catalog.leftnav" template="catalog/layer/view.phtml"/>

Производим проверку остальных блоков и удаляем их них упоминания catalog/navigation и catalog/layer_view

Следующим этапом производим модификацию левого блока меню — отображающего список категорий и подкатегорий
Файл design/frontend/default/default/template/catalog/navigation/left.phtml

<?php
      /* Get the categories that are active for the store */
      $_main_categories=$this->getStoreCategories();
 
      /* Get the current category the user is in */
      $_current_category=$this->getCurrentCategory();
 
      /* Get the current category path */
      $_categorypath = $this->getCurrentCategoryPath();
?>
 
    <?php if ($_main_categories): ?>
        <div class="box normal-nav">
            <div class="box-top">
            </div>
            <div class="box-content">
                    <ul>
                        <?php
                            /* This bit cycles through the categories - setting the next one to current */
                            foreach ($_main_categories as $_main_category):
                                if($_main_category->getIsActive()):
                                    $cur_category=Mage::getModel('catalog/category')->load($_main_category->getId());
                                    $layer = Mage::getSingleton('catalog/layer');
                                    $layer->setCurrentCategory($cur_category);
                        ?>
 
                                    <li><a href="<?php echo $this->getCurrentCategory()->getUrl()?>"><?php echo $this->getCurrentCategory()->getName();?></a>
 
                                        <?php $_maincategorylisting=$this->getCurrentCategory()?>
 
                                        <?php $_categories=$this->getCurrentChildCategories()?>
 
                                        <?php if($_categories->count()): ?>
                                            <ul class="subcategory">
                                                <? foreach ($_categories as $_category):?>
                                                   <? if($_category->getIsActive()):
                                                          $cur_subcategory=Mage::getModel('catalog/category')->load($_category->getId());
                                                          $layer = Mage::getSingleton('catalog/layer');
                                                          $layer->setCurrentCategory($cur_subcategory);
                                                   ?>
 
                                                          <li><a href="<?php echo $this->getCategoryUrl($_category)?>"> <?php echo $_category->getName()?></a></li>
                                                   <? endif;?>
 
                                                 <?endforeach?>
 
                                            </ul>
                                            <?php $layer->setCurrentCategory($_current_category);  ?>
 
                                        <? endif; ?>
                                    </li>
 
                             <?php endif; ?>
 
                        <?php endforeach; ?>
                    </ul>
                </div>
                <div class="box-bottom">
 
                </div>
        </div>
    <?php endif;  ?>

Производим редактирование шаблона фильтров для соответствии нашем требованиям. Файл: app/design/frontend/default/default/template/catalog/layer/view.phtml

В результате получаем:



P.S. В данную очередь этот пост ориентирован для меня, т.к. регулярно приходиться искать подобную реализацию в интернете.

Похожие посты:

• Magento: программное создание ордера
• Magento: программное создание ордера. Версия 2
• Magento: создание Shipping method
• Magento: создание пользователя
• Magento: конвертация валют
]]> http://spiri7.net/blog/magento/magento-left-menu-all-category-tree/feed 6 http://spiri7.net/blog/magento/magento-left-menu-all-category-tree