1.8.6 Порог вхождения

Не все фреймворки просты в освоении, это очень важно учитывать при выборе, так как на освоение одного фреймворка может не хватить и года, а на освоение другого -- хватит всего недели.

В качестве проекта, для ознакомления с возможностями фреймворков, была выбрана разработка сайта-каталога одежды и обуви, который будет обладать следующими особенностями:

1. Товары разделены по категориям, с возможностью создания подкатегорий;

2. Удобная административная панель;

3. Многоязычность, поддержка русского, румынского и английского языков;

4. Поддержка высоких нагрузок(кэширование).

Для разработки такого проекта был выбран MVC-фреймворк yii, который обладает относительно низким «порогом вхождения» и большим русскоязычным сообществом.

Работу над созданием любого сайта можно разделить на следующие этапы:

1. выбор и установка необходимых инструментов;

2. разработка дизайна проекта и верстки;

3. проектирование и создание базы данных;

4. создание основы приложения и конфигурация;

5. генерация каркаса кода с помощью кодогенератора Gii;

6. установка верстки и доработка каркаса;

7. настройка кэширования, многоязычности и «красивых» ссылок.

2.1 Приложения, использованные при разработке проекта

Для оптимизации разработки проекта, а также удобства, были использованы следующие приложения:

1. Пакет «denwer»;

2. Графический интерфейс «HeidiSQL» для управления СУБД MySQL;

3. Редактор программного кода PhpStorm;

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

2.1.1 Пакет для web-разработки «Denwer»

Denwer - портативный набор дистрибутивов и программная оболочка, созданный для отладки сайтов на локальной Windows - машине, без подключения к сети Интернет. Состав базового пакета:

· Apache2.2, SSI, SSL, mod_rewrite, mod_php;

· PHP5 с поддержкой GD и MySQL5;

· MySQL с поддержкой транзакций (mysqld - max);

· поддержка виртуальных хостов на основе папок из /home;

· система управления запуском и завершением;

· phpMyAdmin -- система управления MySQL через Web - интерфейс;

· эмулятор sendmail (отладочная «заглушка», складывающая приходящие письма в /tmp); поддерживается работа совместно с PHP и Perl;

· установщик (нечто вроде InstallShield).

2.1.2 Система управления СУБД MySQL “HeidiSQL”

HeidiSQL - бесплатный клиент с открытым исходным кодом, а так же графический интерфейс для управления и администрирования СУБД MySQL (рис 2.1). Проект находится в активном развитии и поддерживает множество возможностей:

· Поддержка множества одновременно открытых подключений с помощью TCP/IP, именованных каналов или SSH-туннелирования, с возможностью сохранения авторизационных данных.

· Управление пользователями и их правами на сервере в рамках базы данных или глобально.

· Поддержка управления серверными переменными;

· Просмотр серверной статистики и управление запущенными процессами с возможностью проанализировать выполняемые SOL-запросы и прервать “плохие”.

· Поддержка экспорта баз данных в SQL файл или на другой сервер, с возможностью последующего импорта;

· Просмотр и управление базами данных, таблицами, отображениями, триггерами и хранимыми процедурами.

Размещено на http://www.allbest.ru/

2.1.3 Редактор программного кода PhpStorm

JetBrains PhpStorm - коммерческое IDE для PHP разработанное на основе платформы IntelliJ IDEA (рис. 2.2). Предоставляет «умный» редактор для PHP, HTML и JavaScript кода с поддержкой анализа качества кода «на лету» и продвинутыми возможностями автоматического рефакторинга. Дополнение кода полностью поддерживает все возможности PHP 5.3, включая пространство имен и замыкания. Ключевые особенности:

· Поддержка фреймворка для тестирования PhpUnit;

· Поддержка отладки PHP и JavaScript кода;

· Удаленная выгрузка по FTP, SFTP, сетевому диску с автоматической синхронизацией;

· Поддержка спецификаций HTML5 и EcmaScript 5.

· Интеграция с системами контроля версий:CVS, SVN, Git, Perforce, Mercurial;

· Интеграция с баг-треккерами.

Размещено на http://www.allbest.ru/

2.2 Разработка дизайна проекта и верстки

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

Дизайн сайта выполнен в серебристо-пурпурных тонах (рис. 2.3). Серебристый цвет символизировать строгость, стиль, силу. Пурпурный подчеркивает стиль и дополняет его вкусом. Дизайн умеренно консервативен, традиционен и говорит о мужском стиле. Шапка сайта с логотипом и баннером отражает название и выгодное коммерческое предложение.

Размещено на http://www.allbest.ru/

2.3 Проектирование и создание базы данных

Во время проектирования база данных были выделены следующие таблицы:

· Таблица категорий «Category», которая хранит в себе название категорий на 3-х языках в древовидном виде Adjacency List: titleRu, titleEn, titleRo и parent;

· Таблица товаров «Price» с названиями и описаниями на 3-х языках, цену, размеры, наличие товара, а так же дату добавления и поле для связи с категорией: titleRu, titleRo, titleEn, descrRu, descrRo, descrEn, idCategory, cost, time, present, sizes;

· Таблица для хранения пути к фотографиям «Photo» с полем для связи с товаром: idItem, path;

· Таблица для хранения текстовых страниц «Text» с названиями и описаниями на 3-х языках, а так же красивым адресом для ссылок: titleRu, titleRo, titleEn, descrRu, descrRo, descrEn, name.

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

2.4 Cоздание основы приложения и конфигурация

При создании проекта использовался виртуальный хост в denwer, расположенный по пути z:\home\magazin.local\www. Использование виртуального хоста облегчает разработку и тестирование проекта.

Для создания приложения на основе фреймворка yii, необходимо загрузить последнюю версию с официального сайта www.yiiframework.com, распаковать и скопировать папку framework в z:\home\magazin.local\www. Так как для установки под denwer, инструкция отличается от официальной, то, перед установкой, необходимо отредактировать файл z:\home\magazin.local\www\framework\yiic.bat, указав в нем вместо php.exe полный путь к php: z:\usr\local\php5\php.exe. После этого необходимо запустить командный интерпретатор и ввести следующие команды:

C:\Users\root>z:

Z:\>cd \home\magazin.local\www

Z:\home\magazin.local\www>framework\yiic.bat webapp magazin

При появлении вопроса «Create a Web application under 'Z:\home\magazin.local\www\magazin'? [yes|no]» необходимо нажать y, после чего будет создан каркас приложения и выведен список созданных файлов (рис. 2.4).

Размещено на http://www.allbest.ru/

Созданная основа обладает рядом базовых функций, такими как встроенная авторизация, вывод статических страниц и т.д.

Для удобства переноса на другой web-сервер или хостинг, после создания, каркас приложения был вынесен из папки magazin на один уровень выше, а в index.php и index-test.php исправлен путь к фреймворку.

Файл конфигурации приложения расположен по следующему пути: protected/config/main.php. Файл описывает настройки приложения в виде ассоциативного php-массива. Для настройки подключения к бд был настроен компонент приложения db в секции components:

'db'=>array(

// строка в формате dsn для подключения к БД

'connectionString' => 'mysql:host=localhost;dbname=magazin',

// имя пользователя

'username' => 'root',

'password' => '',

'charset' => 'utf8',

),

2.5 Генерация каркаса кода с помощью кодогенератора Gii

После того как основа приложения создана и настроена, можно приступить к разработке контроллеров и моделей. Начиная с версии 1.1.2, фреймворк доступен вместе с встроенным генератором кода Gii. Gii позволяет генерировать модели на основе таблиц в базе данных, а так же CRUD-контроллеры для основных действий по управлению записями, такими как добавление записи (Create), просмотр списка записей, просмотр записи (Read), редактирование записи (Update) и удаление (Delete). Для активации Gii в файл конфигурации приложения было добавлено описание подключения модуля gii:

'gii'=>array(

'class'=>'system.gii.GiiModule',

// Пароль для входа в кодогенератор

'password'=>'generate',

// Разрешенные ip-адреса

'ipFilters'=>array('127.0.0.1','::1'),

),

После этого, для того чтобы зайти в Gii необходимо перейти по следующей ссылке в браузере: http://magazin.local/index.php?r=gii/. После авторизации будет доступен простой, удобный интерфейс для генерации кода (рис. 2.5).

Размещено на http://www.allbest.ru/

Так как модель используется для управления записями в одной таблице, то были сгенерированы 4 модели: Price, Category, Photo, Text. Для этого использовался раздел Model Generator, в котором в качестве имени таблицы была указана *.

Для генерации CRUD-контроллеров, в Gii есть раздел Crud Generator. Так как таблица Photo является вспомогательной, то для управлению записями в ней не нужен отдельный контроллер, поэтому были сгенерированы 3 контроллера: PriceController, MenuController (для Category), TextController.

2.6 Установка верстки и доработка каркаса

Представление в фреймворке yii -- это специальный php-скрипт, состоящий из простых выражений, отвечающий за отображение элементов пользовательского интерфейса. У каждого представления есть имя, которое используется для поиска скрипта представления. Если имя представления test, то имя скрипта представления test.php.

Для отображения представления используется метод CController::render, которому передается имя представления и массив значений, который преобразуется в локальные переменные внутри представления. Например, если внутри действия update контроллера ItemController вызывается:

$this->render('update',array(

'model'=>$model,

'language'=>Yii::app()->language,

));

то, скрипт представления будет расположен по следующему пути: protected/views/item/update.php, а внутри него будут доступны две локальные переменные: $model и $language.

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

Так же, при обработке скрипта представления неявно используется специальное представление - макет, который декорирует пользовательский интерфейс и может содержать такие элементы как шапка сайта и подвал. Внутри макета доступна локальная переменная $content, в которой хранится вывод скрипта представления. Макет, по-умолчанию, расположен по следующему пути: protected/views/layouts/main.php.

Виджет -- это компонент, встраиваемый в представление, с целью отображения сложной, самостоятельной части интерфейса. Например, виджет может использоваться для вывода меню, таблицы и т. д.

Помимо виджетов, в фреймворке присутствует класс CHtml, статические методы которого позволяют выводить ссылки на основе заданных маршрутов(route), формы и её элементов ввода и т. д. Наиболее часто используемый метод это Chtml::link(<заголовок>,<маршрут в виде массива или строки>), который позволяет вывести ссылку на основе правил маршрутизации.

Все действия по установке верстки и доработке каркасы можно разделить на следующие пункты:

1. настройка макета;

2. настройка представлений видимых для посетителей;

3. доработка правил валидации моделей и провайдеров данных;

4. настройка представлений администратора;

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

2.6.1 Настройка макета

Установка верстки была начата с макета. Основные элементы, которые присутствуют в макете это шапка сайта, включая меню, меню категорий справа и подвал.

Для отображения меню сайта использовался виджет zii.widgets.CMenu, который очень просто подключается и настраивается:

<?php $this->widget('zii.widgets.CMenu',array(

// Список пунктов

'items'=>array(

array('label'=>Yii::t('menu','Home'), 'url'=>array('/price/index')),

array('label'=>Yii::t('menu','New'), 'url'=>array('/price/new')),

array('label'=>Yii::t('menu','Help'), 'url'=>array('text/index','page'=>'help')),

array('label'=>Yii::t('menu','Price'), 'url'=>array('/price/get')),

array('label'=>Yii::t('menu','Contact'), 'url'=>array('/text/index','page'=>'contact')),

array('label'=>Yii::t('menu','Logout'), 'url'=>array('/admin/logout'),'visible'=>!Yii::app()->user->isGuest),

),

)); ?>

где label - название пункта меню, url - маршрут(route) к контроллеру и действию, а visible - статус видимости пункта. Для отображения меню категорий товаров использовался виджет CTreeView, настройка которого полностью аналогична, за исключением формирования списка вложенных категорий, который был вынесен в отдельный виджет-адаптер -- LeftMenu, который изначально разрабатывался для вывода меню слева, но в связи с неудобством интерфейса вынесен в правую часть.

Так же, для отображения заголовка страницы использовалось св-во контроллера $this->pageTitle.

2.6.2 Настройка представлений видимых для посетителей

Для отображения главной страницы с товарами, а так же страницы новинок использовался виджет zii.widgets.CListView:

<?php $this->widget('zii.widgets.CListView',array(

'dataProvider'=>$dataProvider,

'itemView'=>'_item',

'template'=>'{sorter}{items}{pager}',

'sortableAttributes'=>array(

'title'.ucfirst(Yii::app()->language),

'time',

'cost'

),

'pagerCssClass'=>'pager clear',

));?>

где dataProvider - провайдер данных, itemView -- специальный файл представления отображающий одну модель в виде локальной переменной $data, template -- шаблон вывода, sortableAttributes отвечают за сортировку данных по полям, а pagerCssClass использовался для настройки положения переключателя страниц. Провайдер данных -- специальный компонент-адаптер, который отвечает за выборку моделей (записей) по определенному условию, их сортировку, а также за разбиение по страницам, будет рассмотрен позже в работе. Js-скрипт HighSlide был подключен в соответствии с описанием на оф. странице.

Отображение прайс-листа и остальных страниц было выполнено без применения виджетов в виде стандартного php-кода.

2.6.3 Доработка правил валидации моделей и провайдеров данных

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

Правила валидации описываются в методе rules модели. Этот метод должен вернуть массив с описанием правил валидации, например:

public function rules()

{

return array(

array('titleRu,titleEn,titleRo','length','max'=>255,'min'=>4),

array('titleRu,titleEn,titleRo','required'),

array('parent', 'numerical', 'integerOnly'=>true,'allowEmpty'=>false),

);

}

Формат описания правила выглядит следующим образом:

array(<имя св-ва/св-в модели (полей в таблице)>,<псевдоним валидатора>,<имя доп. параметра валидатора 1>=><значение параметра 1>, …)

Каждое имя валидатора является псевдонимом класса. Это позволяет создавать и использовать свои классы валидации. Основные валидаторы:

1. default (CDefaultValueValidator) - присваивает значение по умолчанию выбранным атрибутам;

2. in (CRangeValidator) - проверяет, содержится ли значение атрибута в указанном наборе значений;

3. length (CStringValidator) - проверяет, находится ли длина строкового значения атрибута в в указанном интервале;

4. numerical (CNumberValidator) - проверяет, является ли значение атрибута числом;

5. required (CRequiredValidator) - проверяет, не является ли значение атрибута пустым;

6. match: псевдоним класса CRegularExpressionValidator, проверяющего значение атрибута на соответствие регулярному выражению;

7. unique: псевдоним класса CUniqueValidator, который проверяет, является ли значение атрибута уникальными в пределах столбца таблицы базы данных;

Дополнительные параметры каждого из валидаторов подробно описаны в руководстве по yii.

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

public static function searchByCategory($category,$pageSize)

{

// создание условия выборки

$criteria=new CDbCriteria();

$criteria->select='Id, title'.ucfirst(Yii::app()->language).' as title,cost';

$criteria->addInCondition('idCategory',Category::getAllChildren($category));

// создание провайдера данных

return new CActiveDataProvider(__CLASS__,array(

// условие выборки

'criteria'=>$criteria,

// настройка постраничного вывода

'pagination'=>array(

'pageSize'=>$pageSize

),

// поддержка сортировки

'sort'=>array(

'defaultOrder'=>'title'.ucfirst(Yii::app()->language),

'attributes'=>array(

'title'.ucfirst(Yii::app()->language),

'time',

'cost'

)

)

));

}

Как видно из приведенного выше кода провайдер данных является экземпляром класса CActiveDataProvider (а так же потомком CDataProvider) и очень гибок в настройке.

2.6.4 Настройка представлений администратора

Для вывода ссылок для администраторских действий необходимо проверка является ли пользователь администратором. Так как администратор всего один в системе и разделение прав не используется, то достаточно лишь проверки на авторизованность пользователя: if(Yii::app()->user->isGuest).

После того как были выведены все ссылки, были доработаны представления форм с учетом специфики моделей и правил валидации. Для этого использовались статические методы CHtml, ответственные за вывод полей ввода формы. Наиболее часто используемые методы CHtml для форм:

1. CHtml::activeLabelEx(<модель>,<имя св-ва>) - выводит заголовок поля ввода, где заголовок берется из метода attributeLabels модели, а так же помечает его красной *, если оно обязательное(имеет валидатор required).

2. CHtml::activeTextField(<модель>,<имя св-ва>) - выводит текстовое поле ввода.

3. CHtml::activeTextArea(<модель>,<имя св-ва>) - выводит textarea-поле ввода.

4. CHtml::submitButton(<имя кнопки>) - выводит кнопку для отправки формы на сервер.

Для добавления фотографий использовалось расширение SwfUpload, использование которого подробно описано на странице руководства.

2.7 Настройка кэширования, многоязычности и «красивых» ссылок

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

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

Для настройки кэширования в контроллерах использовался компонент COutputCache, описанный в методе filters контроллера:

array(

// Компонент отключен для администраторских действий

'COutputCache -create, update, upload',

// Срок годности

'duration'=>24*3600*365,

// зависимости

'dependency'=>array(

'class'=>'CChainedCacheDependency',

'dependencies'=>array(

// по глобальному изменению pm_time

new CGlobalStateCacheDependency('pm_time'),

// по глобальному изменению cu_time

new CGlobalStateCacheDependency('cu_time'),

),

),

// данные в кэше отличаются по категории, сортировке, страницам, языку

'varyByParam'=>array('category','sort','page','lang'),

// и по статусу авторизованности пользователя

'varyByExpression'=>'Yii::app()->user->isGuest',

// кэш используется только для GET-запросов

'requestTypes'=>array('GET'),

),

где cu_time -- последнее время обновления категорий, а pu_time - товаров и меняются по событию сохранения модели.

Так как, по-умолчанию, приложение уже поддерживает многоязычность с помощью класса CPhpMessageSource, который хранит переводы в php-файлах перевода, то в проекте использовался именно этот способ хранения.

Каждое сообщение перевода относится к какой-либо категории. Сообщения переводов хранятся по следующему пути: protected/messages/<код языка>/<имя категории>.php. Файлы переводы содержат в себе ассоциативный массив, где ключем является фраза на исходном (английский) языке, а значение -- переведенное для данного кода (русский, например).

Для перевода сообщения, фреймфорк yii предоставляет статический метод Yii::t(<имя категории>,<сообщение>), а для хранения текущего языка в ссылке в файл конфигурации было подключено стороннее расширение в качестве компонента приложения urlManager: LangUrlManager.

Для активации «красивых», человекопонятных ссылок компонент приложения urlManager был настроен следующим образом:

'urlManager'=>array(

'class'=>'application.extensions.urlManager.CLangUrlManager',

//формировать ссылку в формате /route/p1/v1/p2/v2/...

'urlFormat'=>'path',

'rules'=>array(

// код языка всегда расположен впереди ссылки

'<lang:(en|ru|ro)>'=>'/price',

'<lang:(en|ru|ro)>/<_c>'=>'<_c>',

'<lang:(en|ru|ro)>/<_c>/<_a>'=>'<_c>/<_a>',

'<lang:(en|ru|ro)>/text/index/<page:.*>'=>'text/index',

),

// не выводить index.php в ссылке

'showScriptName'=>false,

),

а в корневой папке сайта (www) был добавлен файл .htaccess с активацией и настройкой mod_rewrite в web-сервере apache:

Options +FollowSymLinks

IndexIgnore */*

RewriteEngine on

RewriteCond %{REQUEST_FILENAME} !-f

RewriteCond %{REQUEST_FILENAME} !-d

RewriteRule . index.php

ЗАКЛЮЧЕНИЕ

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

Вот небольшой список который стоит выделить:

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

2. Помощь от разработчика фреймворка. Большой плюс поддержки Yii - это возможность в любой день пообщаться и задать вопросы разработчику Yii на форуме. Было замечено что он практически каждый день просмотривает и отвечает на вопросы на форуме, помогает советами и полезными "фишками". Вы всегда можете написать ему личное сообщение и быть уверены что получите самый правильный ответ по вашему вопросу. К сожалению, разработчик фреймворка плохо знает русский язык, поэтому сообщения просим излагать ему на английском или китайском.

3. Полная поддержка ООП. Фреймворк полностью заточен под пятую версию php что позволяет поддерживать весь функционал при обьектно ориентированном программировании. Разработчики не пошли на поддержку php4 в ущерб гибкости и удобства ооп. В связи с этим фреймворк не будет работать на php4, но зато отлично покажет себя на php5! Если вы знаете что такое ООП и умеете его использовать в php - тогда Yii лучший выбор для вас.

4. Генератор кода. Yii предоставляет отличный встроенный генератор исходного кода. Указав лишь основные параметры - Yii генерирует для вас общую структуру приложения которая будет содержать все необходимые модели/контроллеры/отображения для старта. В yii версии 1.1 обещают браузерный генератор кода с еще большим функционалом!

5. Темы. Благодаря встроенной поддержке тем вы можете изменять дизайн вашего приложения в пару нажатий клавиш.

6. Защита. Все стандартные классы Yii заточены под высокий уровень безопасности что при умелом обращении позволяет полностью обезопасить свой сайт от Sql-Inj, XSS, CSRF и других атак.

Если честно то перечислять можно долго, и пятнадцатью пунктами список естественно не ограничится. Много из того что написанно выше - и стало для меня стимулом перейти на Yii Framework.

БИБЛИОГРАФИЯ

Джордж Шлосснейгл.Профессиональное программирование на PHP,2006.

Максим Кузнецов, Игорь Симдянов, Сергей Голышев.PHP 5 на примерах. БХВ-Петербург.2005, ISBN: 5-94157-670-6

А.Кухарчик. PHP: обучение на примерах. 240 стр., 2004 г. Издательство: Новое знание. ISBN 985-475-050-7

Леон Аткинсон, Зеев Сураски. PHP 5. Библиотека профессионала,2006

Джон Коггзолл. PHP 5. Полное руководство,2006.

Антон Орлов. PHP: Полезные приемы,2005.

Александр Мазуркевич, Дмитрий Еловой. PHP: настольная книга программиста.