Коллекция — это объект, который может содержать определенный набор других объектов определенного класса. По логике организации коллекции в Magento работают как «список» В Magento коллекции реализовывают интерфейсы IteratorAggregate и Countable, что позволяет их «форичить» и подсчитывать количество элементов с помощью функции count():

foreach ($collection as $item) {
    echo get_class($item);
}

echo count($collection);

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

Коллекция декларирует метод load(), который вызывается автоматически при попытке «посчитать» или проитерировать коллекцию. В абстрактной коллекции метод load() лишь задействует метод loadData(), который ничего не делает — реализовать логику по загрузке данных предоставляется наследникам. Кроме работы с элементами (добавление, удаление, геттеры), есть возможность устанавливать фильтры. Реализацию работы фильтров абстрактная коллекция также предоставляет коллекциям, наследующих ее.

Ресурс-модель Varien_Data_Collection_Db

В библиотеке Varien представлены две ресурс-модели, наследующие абстрактную коллекцию — Varien_Data_Collection_Db и Varien_Data_Collection_Filesystem.

Varien_Data_Collection_Db реализовывает абстрактный уровень доступа к БД, используя Zend_Db_Adapter_Abstract. Основные функциональные возможности класса:

1. сформировать SQL-запрос без привязки к определенному диалекту
2. «скормить» запрос адаптеру для загрузки данных
3. загрузить конкретные данные и создать элементы коллекции с помощью «родительских» методов

Особенностью этой ресурс-модели является то, что метод load() выполняет SQL-запрос и грузит данные лишь один раз — при первом вызове. Последующие вызовы load() ни к чему не приведут. То есть, можно «грузить» или итерировать коллекцию сколько угодно раз, не беспокоясь о лишних запросах к БД.

Можно получить объект SQL-запроса коллекции с помощью метода getSelect(). Этот объект может модифицироваться до загрузки коллекции по мере установке фильтров. Непосредственно перед загрузкой объекту запроса устанавливаются все фильтры, сортировка и ограничения выборки. Чтобы получить конечный SQL-запрос, можно вывести объект запроса после загрузкти коллекции:

$collection->load();
echo $collection->getSelect();

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

Отдельного внимания заслуживает процесс установки фильтра коллекци — метод addFieldToFilter($field, $condition). Метод добавляет условие WHERE в SQL-запрос, абстрагируясь от определенного диалекта и от имени поля в запросе.

• Параметр $field — некое имя «колонки» в результате. Перед вставкой в запрос (точнее, в фильтр запроса), пропускается через «маппер», который может преобразовать имя колонки результата в имя колонки запроса с корелляционным именем.
• Параметр $condition — может быть строкой или массивом — тип сравнения и значение, которое добавить во WHERE запроса. Поддерживаются простые типы сравнения, такие как IS NULL, LIKE, «больше равно», «меньше равно», «равно». Также есть возможность манипулировать интервалами даты.

Для подсчета количества элементов в этой ресурс-модели клонируется объект запроса, полученному объекту применяются фильтры (аналогично как перед загрузкой коллекции), вырезаются ограничения на выборку и сортировки, и колонки запроса заменяются на COUNT(*). Чтобы получить количество без выполнения основного SQL-запроса загрузки, можно вызвать метод getSize().

Ресурс-модель Mage_Core_Model_Mysql4_Collection_Abstract

«Рабочая лошадка». Большинство коллекций Magento основаны на этой ресурс-модели. Добавляет в Varien_Data_Collection_Db немного условностей:

1. у SQL-запроса есть «главная» таблица, ей по умолчанию дается корелляционное имя «main_table»
2. подразумевается, что все эелементы коллекции — модели, наследники Mage_Core_Model_Abstract. Объявление фабричного имени модели элементов должно происходить в инициализации коллекции
3. есть метод save(), который проходится по всем элементам и вызывает им метод save() (реализован в абстрактной модели)

Ресурс-модель Varien_Data_Collection_Filesystem

Файловая коллекция в качестве строк возвращает имена файлов и/или папок, в зависимости от настроек и установленных фильтров. Умеет рекурсивно «ходить» по указанной папке, собирая файлы/папки. Может в результате возвращать сначала все папки, потом все файлы.

Эта ресурс-модель работает по той же схеме, что и Varien_Data_Collection_Db — получает массив данных, считает их, разбивает на страницы и генерирует набор элементов-объектов с указанными «колонками» для текущей «страницы». Принципиальное отличие от БД в том, что приходится загружать весь массив данных, потому что иначе подсчитать их количество (и разбить на страницы) не получится. С целью экономии ресурсов, можно задавать «предварительный» фильтр — регулярные выражения для имен файлов/папок, чтобы они вообще не попадали в выборку.

Базовый набор данных по умолчанию — полное системное имя файла и его базовое имя. Метод _generateRow() можно переопределить и на основании системного имени файла добавить любые другие «колонки».

Метод addFieldToFilter() реализован совместимым с аналогичным в Varien_Data_Collection_Db. Только вместо построения SQL-запроса, здесь строится Одно Большое Условие, которое выполняется с помощью eval() при загрузке данных и генерации элементов. Сама же коллекция и реализовывает простейшие типы сравнения, аналогичные коллекции БД (IS NULL, LIKE, «больше равно», «меньше равно», «равно»).

Общая схема загрузки данных коллекцией

Небольшая историческая справка:

Zend Framework:

Zend Framework (framework.zend.com) – современная, объектно-ориентированная библиотека для построения приложений на PHP 5. Создание Zend Framework было впервые публично анонсировано компанией Zend Technologies Inc. на Zend Conference в октябре 2005 года. Первая версия Zend Framework была выпущена 1 июля 2007 года.

Magento:

Первые идеи о создании собственной открытой платформы для создания ecommerce-сайтов появились в компании Varien в 2006 году. Новая платформа строилась по архитектуре MVC, с использованием ООП-возможностей пятой версии языка PHP, и ориентировалась на использование передовой на тот момент технологии, которую предоставляла новая библиотека от компании Zend. Первый внутренний альфа-релиз Magento состоялся весной 2007 года, тогда же было объявлено о планах по её выпуску, и 31 августа 2007 года была выпущена первая публичная бета-версия Magento.

Начало разработки:

Начиная разработку Magento, несмотря на то, что Zend Framework не был выпущен и находился лишь в стадии разработки, мы были восхищены подходом автором библиотеки и предоставляемыми возможностями уже в самых ранних версиях. Так как Zend Framework является open source библиотекой, уже после первого объявления был предоставлен публичный доступ к Subversion-репозиторию проекта.

На тот момент (напомним, что это было начало 2007 года), были реализованы основные компоненты Zend Framework, а остальные только разрабатывалось и не могли быть использованы для создания полноценного приложения.

Но у нас были свои планы, свой календарь разработки, и мы не могли ожидать, когда все компоненты Zend Framework будут закончены. Поэтому было принято решение включить библиотеку ZF в состав проекта, и стараться использовать её компоненты по максимуму, где это уже было возможно:

• Zend_Acl и Zend_Auth используются для управления пользователями контрольной панели
• Zend_Cache используется для реализации кеширования данных конфигурации, промежуточных данных и вывода
• Zend_Config использовался для работы с конфигурацией
• Zend_Controller использовался для роутинга, работы с входящими запросами и формирования ответа
• Zend_Db используется для работы с базой данных, динамического построения и модификации запросов к ней
• Zend_Filter с дополнительными собственными фильтрами применяется для предварительной обработки вывода
• Zend_Http используется для работы с внешними сервисами по HTTP-протоколу
• Zend_Json используется для работы с данными в JSON-формате, так как встроенные функции json_encode и json_decode появились в составе PHP только начиная с версии 5.2.0
• Zend_Locale используется для локализации Magento
• Zend_Mail используется для отправки исходящей почты
• Zend_Session использовался для работы с данными сессии пользователя
• Zend_Translate использовался для работы с переводами интерфейса Magento
• Zend_Validate для валидации входящих данных

Последующие изменения:

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

• Из-за специфики приложения и некоторых, на тот момент, проблем с производительностью, была реализована собственная система роутинга и контроллеров
• В связи с многоуровневостью системы хранения (конфигурационные файлы модулей, и значения настроек в базе данных) и сложного процесса сборки конфигурационных данными мы отказались от использования Zend_Config
• Для поддержки модульности и иерархии переводов были реализованы свои компоненты

В последующих версиях Magento стали ипользоваться также:

• Zend_Currency
• Zend_Date
• Zend_Feed
• Zend_Gdata
• Zend_Pdf
• Zend_Validate
• Zend_Soap

Какой же из этого можно сделать вывод ?

А вывод таков:

• Magento является приложением, построенным с использованием компонентов Zend Framework, что стало возможным благодаря принципу use-at-will, заложенному в архитектуру этой замечательной библиотеки.
• Magento, на данный момент, не является приложением, построенным на Zend Framework, так как мы используем собственную логику компонентной архитектуры приложения и системы обработки запросов, взамен стандартной реализации, предоставляемой Zend Framework.

Планы на будущее

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

Последний, выпущенный на момент написания этой статьи, релиз Magento 1.3.2.2 включает в себя Zend Framework версии 1.7.2. Последняя доступная версия ZF – 1.8.4, которая уже интегрирована в Magento trunk и в данный момент тестируется. Вполне возможно, что следующий релиз Magento будет включать в себя еще более новый Zend Framework, выпуск версии 1.9.0 которого планируется в конце июля этого года.

Стандартный шаблон MVC (model-view-controller, модель-представление-контроллер):

Уровни разделения в Magento:

• Модели (models)
• Ресурс-модели (resource models)
• Лейауты (layouts)
• Блоки (blocks)
• Шаблоны (templates)
• Контроллеры (controllers)

Модели (models) – это компоненты, реализующие бизнес-логику любых сущностей и связи между ними.

Ресурс-модели (resource models) – это мостики между моделями и источниками данных, с которыми те работают. Ресурс-модели содержат специфический для выбранного источника данных код, позволяющий моделям получать, сохранять и удалять данные из источника.

Лейауты (layouts) – это xml-файлы, описывающие связи между блоками, и привязывающие определенный набор блоков к конкретным действиям (actions) контроллера.

Блоки (blocks) - это составные кирпичики, из которых строятся страницы, отдаваемые броузеру пользователя.

Шаблоны (templates) – это файлы, которые используются блоками для формирования вывода. Они содержат в себе HTML разметку для представления данных в нужном виде.

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

Соответсвенно, распределение этих компонентов по стандартным уровням MVC осуществляется следующим образом:

MVC Модель:

• Модели
• Ресурс-модели

MVC Представление:

• Лейауты
• Блоки
• Шаблоны

MVC Контроллер:

• Контроллеры

В последующих версиях Magento может произойти выделение еще одного дополнительного слоя из ресурс-моделей:

• Ресурс-модели будут предоставлять интерфейс для работы с абстрактным типом источников данных (например, реляционная база данных, используемая только как хранилище данных, в отличие от реляционной базы данных, содержащей часть логики на сервере БД)
• Ресурсы будут являться адаптерами, включащими только тот код, который является специфическим для конкретного источника данных (например ресурс для работы с MySQL, с Oracle или с Microsoft SQL)