Адаптация существующих модулей и тем под CS-Cart 4.21.1¶

Как работает новый интерфейс?¶

1. Он требует реализовать в shipping-сервисе метод getPickupPointsLoader(): IPickupPointsLoaderByLocation, который должен вернуть объект класса-loader вашего shipping-сервиса, реализующего интерфейс TyghShippingsPickupPointsLoaderByLocationIPickupPointsLoaderByLocation.
2. Интерфейс IPickupPointsLoaderByLocation, в свою очередь, предполагает, что в классе-loader вашего сервиса будет метод getPickupPointsByLocation(): PickupPoint[], который обязан вернуть список ПВЗ, каждый из которых является объектом класса TyghShippingsPickupPointsDtoPickupPoint.
3. Дальше ядро само определяет, реализует ли ваш сервис новый интерфейс и, в зависимости от этого, принимает решение по какой логике получать список ПВЗ (старой или новой).

В целом, на этом все. Вы реализовываете метод, который может вернуть список ПВЗ в унифицированном виде, таким образом далее для работы со списком и его отображения можно использовать глобальные шаблоны. Например, если в будущем будет реализована карта с пунктами выдачи всех доступных способов доставки, ваши ПВЗ также попадут на эту карту. В противном случае - нет.

Из чего состоит объект PickupPoint?¶

Объект класса TyghShippingsPickupPointsDtoPickupPoint состоит из базовых полей ПВЗ, необходимых для отображения (город, адрес, координаты, время работы и т.п.). Также для хранения всей информации о ПВЗ, которую предоставляет API сервиса, предусмотрено отдельное поле $shipping_extra, туда в качестве массива нужно передавать все данные целиком.

Как кэшируется список ПВЗ?¶

Для кэширования предусмотрена таблица shipping_pickup_points. Она содержит столбцы, соответствующие полям в классе PickupPoint. На данный момент реализовано так, что каждый сервис реализует кеширование сам в своем loader-классе.

Функции для работы с таблицами кэширования находятся в TyghShippingsPickupPointsRepository.

1. Перед запросом в API сервиса на получение списка ПВЗ из параметров запроса формируется cache_key, который равен hash(‘sha256’, implode(‘,’, $params)). Предварительно params должны быть отсортированы.
2. С помощью метода findFreshPickupPointsSyncStates($provider, $cache_key) проверяется, есть ли свежеполученные ПВЗ. Свежими считаются те, что получены в течение текущих суток.
3. Если есть, то список ПВЗ получаем методом findPickupPointsByProviderAndCacheKey($provider, $cache_key).
4. Если нет, то: * Получаем список ПВЗ из API. * Циклом каждый элемент списка приводим к объекту PickupPoint. То есть создаем объект и записываем в него сеттерами все параметры. * Полученный список объектов PickupPoint записываем в таблицу кэша методом setPickupPointsByCacheKey($pickup_points, $cache_key). * Также в таблицу текущего состояния записываем новые данные с помощью метода setPickupPointSyncState.

Новые хуки¶

• fn_set_hook('get_pickup_points_for_checkout_pre', $cart, $pickup_points); - Выполняется перед получением списка ПВЗ для оформления заказа. Позволяет предотвратить дальнейшее выполнение кода, задав собственный список ПВЗ.
• fn_set_hook('get_pickup_points_for_checkout_post', $cart, $pickup_points); - Выполняется после получения списка ПВЗ для оформления заказа. Позволяет изменить данные в списке ПВЗ.
• fn_set_hook('get_checkout_pickup_points_loader_pre', $cart, $loader); - Выполняется перед получением загрузчика ПВЗ для оформления заказа. Позволяет использовать собственный загрузчик.
• fn_set_hook('get_checkout_pickup_points_loader_post', $cart, $loader); - Выполняется после получения загрузчика ПВЗ для оформления заказа. Позволяет изменить данные загрузчика.
• fn_set_hook('get_pickup_points_for_order_management_pre', $cart, $pickup_points); - Выполняется перед получением списка ПВЗ для управления заказом. Позволяет предотвратить дальнейшее выполнение кода, задав собственный список ПВЗ.
• fn_set_hook('get_pickup_points_for_order_management_post', $cart, $pickup_points); - Выполняется после получения списка ПВЗ для управления заказом. Позволяет изменить данные в списке ПВЗ.
• fn_set_hook('get_order_management_pickup_points_loader_pre', $cart, $loader); - Выполняется перед получением загрузчика ПВЗ для управления заказом. Позволяет использовать собственный загрузчик.
• fn_set_hook('get_order_management_pickup_points_loader_post', $cart, $loader); - Выполняется после получения загрузчика ПВЗ для управления заказом. Позволяет изменить данные загрузчика.
• fn_set_hook('get_pickup_points_for_order_pre', $order_info, $pickup_points); - Выполняется перед получением списка ПВЗ для заказа. Позволяет предотвратить дальнейшее выполнение кода, задав собственный список ПВЗ.
• fn_set_hook('get_pickup_points_for_order_post', $order_info, $pickup_points); - Выполняется после получения списка ПВЗ для заказа. Позволяет изменить данные в списке ПВЗ.
• fn_set_hook('get_order_pickup_points_loader_pre', $order_info, $loader); - Выполняется перед получением загрузчика ПВЗ для заказа. Позволяет использовать собственный загрузчик.
• fn_set_hook('get_order_pickup_points_loader_post', $order_info, $loader); - Выполняется после получения загрузчика ПВЗ для заказа. Позволяет изменить данные загрузчика.
• fn_set_hook('get_storefront_theme_manifest_features_post', $features); - Выполняется после загрузки раздела features файла manifest.json активной темы витрины.

Измененные хуки¶

- fn_set_hook('get_store_locations_for_shipping_before_select', $destination_id, $fields, $joins, $conditions, \Tygh\Shippings\Services\StoreLocator $this);
+ fn_set_hook('get_store_locations_for_shipping_before_select', $destination_id, $fields, $joins, $conditions, \Tygh\Shippings\PickupPoints\StoreLocatorPickupPointsByLocationLoader $this);

Как это работает¶

Image Panel использует API, управляемый данными (data-driven API): вместо того чтобы вручную писать HTML для элементов поверх изображения, вы описываете их в виде элементов массива Smarty. Компонент самостоятельно отвечает за компоновку, позиционирование, сортировку и отрисовку.

1. common/product_data.tpl перехватывает вывод Image Panel, если включен параметр show_image_panel.
2. views/products/components/image_panel_data.tpl` формирует массив ``$image_panel_items и предоставляет шаблонный хук products:image_panel для расширений.
3. views/products/components/image_panel_process.tpl сортирует элементы внутри каждого угла.
4. views/products/components/image_panel.tpl выполняет отрисовку панели.

Каждый элемент размещается в одном из четырех углов:

• top_left
• top_right
• bottom_left
• bottom_right

Расширение Image Panel в модуле¶

Добавьте элементы в массив $image_panel_items в шаблонном хуке products:image_panel.

Пример

design/themes/responsive/templates/addons/wishlist/hooks/products/image_panel.post.tpl

{strip}
{if !$hide_wishlist_button && $show_wishlist_button_on_image_panel}
    {$image_panel_items.top_right.add_to_wishlist = [
        type => "a",
        insert_before_id => "add_to_compare",
        id => "button_wishlist_`$obj_prefix``$product.product_id`",
        class => "ty-btn ty-btn__tertiary ty-btn-icon ty-add-to-wish cm-submit",
        title => __("add_to_wishlist"),
        icon => "ty-icon-heart",
        element_attrs => [
            "data-ca-dispatch" => "dispatch[wishlist.add..`$product.product_id`]"
        ]
    ]}
{/if}

{$image_panel_items = $image_panel_items scope=parent}
{/strip}

Структура данных элемента¶

Добавляйте элементы в массив $image_panel_items, используя ключи, соответствующие углам. Для каждого угла используется ассоциативный массив элементов.

Общие поля

Отрисовка с использованием пользовательского шаблона

Если для элемента требуется нестандартная разметка, задайте параметр file и создайте шаблон, которому будут переданы переменные $item и $item_id:

{$image_panel_items.top_left.my_addon_button = [
    file => "addons/my_addon/views/products/components/my_image_panel_button.tpl"
]}

design/themes/responsive/templates/addons/my_addon/views/products/components/my_image_panel_button.tpl

{* $item and $item_id are provided by Image Panel *}
<div class="my-addon-image-panel-button">
    {* custom markup *}
</div>