Основы Magento, поток запросов, стандарты и лучшие практики

Настраиваемая тема также может содержать папку под названием «locales», в которой будет храниться файл «translate.csv», в котором хранятся все пользовательские переводы, или даже заменяются существующие, уже определенные в стандартном Magento.

Скин и Javascript

CSS-файлы, изображения и пользовательский JS находятся в каталоге skin/ и реализуют ту же структуру тем и приоритет загрузки, что и для Templates and Layout ( skin/area_name/package_name — пользовательское пространство имен может быть определено или является base или по default/theme_name ) ,

Соглашения об именах классов

Magento применяет базовое, хотя и устаревшее соглашение об именах классов Zend, и использует Varien_Autoload::register() для автозагрузки классов, заменяя ‘_’ в имени разделителем каталогов, чтобы найти путь включения в файл. Это очень примитивно, но из-за обратной совместимости не может быть решено раньше — Magento 2 будет использовать ZF2, современный PHP и пространства имен.

Поток запросов

Давайте посмотрим, как приложение Magento обрабатывает запрос, начиная с основного файла index.php .

Инициализация приложения

1) Если вы используете Nginx, вы должны следовать руководству по настройке . Если вы используете Apache, это правила перезаписи для .htaccess из основного каталога приложения, которые не должны быть пропущены.

Перепишите правила для скинов, носителей, каталогов JS, чтобы разрешить загрузку файлов и, если не найдено, вернуть 404. Все остальное переписывается в index.php:

 <IfModule mod_rewrite.c> ############################################ ## enable rewrites Options +FollowSymLinks RewriteEngine on ############################################ ## always send 404 on missing files in these folders RewriteCond %{REQUEST_URI} !^/(media|skin|js)/ ############################################ ## never rewrite for existing files, directories and links RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-l ############################################ ## rewrite everything else to index.php RewriteRule .* index.php [L] </IfModule> 

2) Это шаги, которые следует приложению при инициализации:

• запустить файл index.php app/Mage.php входит app/Mage.php

• вызовите Mage::run($mageRunCode, $mageRunType)

• в ‘run’ мы загружаем Varien Events Collection, класс Mage_Core_Model_Config и класс Mage_Core_Model_App

• Mage_Core_Model_App::run() запущен

• загрузить файлы конфигурации из app/etc/modules

• загрузить конфигурационные xml-файлы внутри модулей app/code/{code pool}/{module name}/etc/config.xml

• инициализировать текущий магазин

• инициализировать объект запроса

• запустить sql и установщики данных

• обновить / создать версии модулей в core_resource

• Mage_Core_Controller_Varien_Front::dispatch(); фронт-контроллера — Mage_Core_Controller_Varien_Front::dispatch();

• собирать маршрутизаторы из конфигурации по области и коду маршрута

• использовать маршруты в соответствии с контроллером

• если контроллер и действие будут сопоставлены, файл контроллера будет включен, создан и будет вызван метод действия

• Метод действия будет создавать экземпляры и вызывать методы на моделях в зависимости от запроса

• контроллер действий Varien будет вызывать объект макета

• этот объект макета создаст список объектов блока, которые действительны для этого запроса, на основе некоторых переменных запроса и системных свойств (также известных как «дескрипторы»)

• Файлы шаблонов (.phtml) назначаются в файле макета XML для каждого блока.

• _prepareLayout() метод _prepareLayout() где на основе структуры XML макета действия создаются конкретные блоки в связанных файлах .phtml.

• _toHtml() метод запускается для генерации HTML

• выходной HTML

Фронт контроллер

1) свойства и роль Front Controller:

• путь к каталогу: app/code/core/Mage/Core/Controller/Varien/Front.php

• базовая роль: получать все запросы из браузера и возвращать HTML-код

• Фронт-контроллер использует маршруты системы для соответствия классу контроллера и его методу действия

• Маршрутизаторы Magento по умолчанию: Стандартный (класс Mage_Core_Controller_Varien_Router_Standard ), Администратор (класс Mage_Core_Controller_Varien_Router_Admin ), По умолчанию (класс Mage_Core_Controller_Varien_Router_Default )

Вот пример определенного маршрута в /etc/config.xml модуля Customer:

 <routers> <customer> <use>standard</use> <args> <module>Mage_Customer</module> <frontName>Customer</frontName> </args> </customer> </routers> 

2) события, которые запускает Front Controller:

• controller_front_init_before

• controller_front_init_routers

• controller_front_send_response_before

• controller_front_send_response_after

URL переписывает

Структура URL / обработка в Magento.

Ссылка в Magento имеет следующую структуру:

https://user:password@host:443/{base_path}/{base_script}/{storeview_path}/{module_front_name}/{controller_name}/{action_name}/{param1}/{value1}?{ query_param=query_value#fragment}

• user:password@host:443/{base_path}/{base_script} : путь к файлу Script, который запускает Magento. Обычно это файл index.php или путь, который использует правила перезаписи доступа к index.php

• {storeview_path} : код представления магазина будет использоваться, если веб-сайт имеет модель просмотра нескольких магазинов (например, поддержка нескольких языков, отмеченная в URL)

• {module_front_name}/{controller_name}/{action_name} : путь к контроллеру модуля и метод действия

• {param1}/{value1} : имя и значение параметра, отправленного URL

• ?query_param=query_value#fragment : запрос параметров, отправленный через стандартный запрос GET

Приведенная выше ссылка будет проходить через следующие файлы, каждый из которых будет соответствовать схеме для URL-адреса, и вызовет правильное действие module-controller-action для вывода содержимого:

• app/Mage.php (Mage::app()->run())

• app/code/core/Mage/Core/Model/App.php

• Контроллер $this->getFrontController()->dispatch(); и диспетчеризации $this->getFrontController()->dispatch();

• app/code/core/Mage/Core/Controller/Varien/Front.php

• выберите определенный маршрутизатор из config.xml чтобы он соответствовал действию модуля-контроллера $router->match($this->getRequest())

  • app/code/core/Mage/Core/Controller/Varien/Router/Admin.php
  • app/code/core/Mage/Core/Controller/Varien/Router/Standard.php
  • app/code/core/Mage/Core/Controller/Varien/Router/Default.php

• app/code/core/Mage/Core/Controller/Varien/Action.php

• вызвать метод Action (пример: indexAction() )

Процесс перезаписи URL

URL переписывается в следующих случаях:

• перезапись основного ядра: имея приоритет над маршрутизаторами, попытается преобразовать пользовательский путь запроса в стандартный путь module/controller/action на основе определенных строк в базе данных (таблица core_url_rewrite )

• перезапись имени модуля: переднее имя будет определено в Mage_Customer config.xml модуля для перезаписи фактического пути и имени (пример: Mage_Customer будет сопоставляться по URL-адресу через его определенное переднее имя «клиент»)

• Пользовательские маршрутизаторы будут переписывать URL-адрес (в основном используется для целей SEO): примером Magento по умолчанию будет модуль CMS, который будет сопоставлять URL-идентификатор, такой как homepage.html с модулем ‘Mage_Cms’, контроллером ‘Page’, действием ‘View ‘и идентификатор параметра, который будет соответствовать строке сущности cms в базе данных.

Стандарты и лучшие практики

Пример конфигурации xml

Это пример модуля config.xml (путь: {base_app_folder}/app/local/{module_name}/etc/config.xml ), который включает в себя основную конфигурацию:

 <?xml version="1.0"?> <config> <modules> <{{localnamespaceC}}_{{modulenameC}}> <version>0.1.0</version> </{{localnamespaceC}}_{{modulenameC}}> </modules> <global> <models> <{{localnamespaceL}}_{{modulenameL}}> <class>{{localnamespaceC}}_{{modulenameC}}_Model</class> </{{localnamespaceL}}_{{modulenameL}}> </models> <resources> <{{localnamespaceL}}_{{modulenameL}}_setup> <setup> <module>{{localnamespaceC}}_{{modulenameC}}</module> </setup> <connection> <use>core_setup</use> </connection> </{{localnamespaceL}}_{{modulenameL}}_setup> </resources> <blocks> <{{localnamespaceL}}_{{modulenameL}}> <class>{{localnamespaceC}}_{{modulenameC}}_Block</class> </{{localnamespaceL}}_{{modulenameL}}> </blocks> <helpers> <{{localnamespaceL}}_{{modulenameL}}> <class>{{localnamespaceC}}_{{modulenameC}}_Helper</class> </{{localnamespaceL}}_{{modulenameL}}> </helpers> </global> <frontend> <routers> <{{localnamespaceL}}_{{modulenameL}}> <use>standard</use> <args> <module>{{localnamespaceC}}_{{modulenameC}}</module> <frontName>{{modulenameL}}</frontName> </args> </{{localnamespaceL}}_{{modulenameL}}> </routers> <layout> <updates> <{{localnamespaceL}}_{{modulenameL}} module="{{localnamespaceC}}_{{modulenameC}}"> <file>{{modulenameL}}.xml</file> </{{localnamespaceL}}_{{modulenameL}}> </updates> </layout> </frontend> </config> 

Условные обозначения:

• localnamespaceC и localnamespaceL — это имя выбранной вами директории пространства имен в app / local / {namespace} (C для первой буквы слова в верхнем регистре и L для нижнего регистра)

• modulenameC и modulenameL — это имя вашего модуля в приложении / local / {namespace} / {modulename}

 <MyNamespace_Customer> <active>true</active> <codePool>local</codePool> <priority>1</priority> <depends> <Mage_Customer/> </depends> </MyNamespace_Customer> 

 $installer = $this; $installer->startSetup(); $sqlQuote = 'ALTER TABLE ' . $this->getTable('sales_flat_quote') . ' ADD `is_urgent` TINYINT UNSIGNED NOT NULL DEFAULT 0'; $installer->run($sqlOrder); $installer->run($sqlQuote); $installer->endSetup(); 

 <MyNamespace_MyCustomModule> <active>true</active> <codePool>local</codePool> <priority>1</priority> <depends> <Mage_Sales/> </depends> </MyNamespace_MyCustomModule>