Данные страниц: что доступно шаблону
Переменные, которые есть на каждой странице, и то, что приходит своё на каждый раздел витрины.
На этой странице
- Есть на каждой странице
- $storefront
- $theme
- $action
- $seo
- $contacts
- $customer
- $errors, $status, $old
- Постранично
- Набор листинга
- pagination
- filters
- active_filters
- Что приходит на отдельные страницы
- Заказы покупателя в кабинете
- Строка заказа
- Что добавляется на странице заказа
- items — состав заказа
- customer и recipient — поля заказа
- address — куда везти
- timeline — история заказа
- Как посмотреть данные своими глазами
Шаблон не ходит в базу данных — магазин отдаёт ему готовые данные. Часть из них есть на каждой странице, часть приходит своя на каждый раздел витрины.
Есть на каждой странице
| Переменная | Что внутри |
|---|---|
$storefront |
витрина: название, домен, язык, валюта, значок вкладки |
$theme |
значения настроек темы |
$action |
название текущего раздела |
$seo |
заголовок, описание и мета-теги для поисковика |
$shop |
помощник со списками магазина |
$contacts |
контакты магазина |
$customer |
покупатель или пусто, если он не вошёл |
$errors |
ошибки формы после возврата назад |
$status |
сообщение об успехе |
$old |
введённые значения формы после возврата назад |
$storefront
{$storefront.name} название магазина
{$storefront.storefront_name} служебное имя витрины
{$storefront.domain}
{$storefront.locale} текущий язык: ru
{$storefront.locales} языки витрины
{$storefront.default_locale}
{$storefront.currency} валюта витрины: UAH
{$storefront.favicon}
name — это название магазина из общих настроек, его и показывают
покупателю. Служебное имя витрины лежит отдельно и нужно только магазинам с
несколькими витринами.
$theme
Значения настроек темы — плоско и по группам:
{$theme.copyright} {$theme.footer.copyright}
{$theme.per_page} {$theme.catalog.per_page}
{$theme.assets} /theme-assets/имя-темы
{$theme.colors.primary} {$theme.colors.accent}
{$theme.colors.bg} {$theme.colors.text}
Все поля схемы присутствуют, даже незаполненные — они приходят пустыми, и шаблон на них не падает. Подробности — на странице Файл theme.json.
$action
Название текущего раздела: default на главной, дальше category, product,
search, page, checkout/cart. Удобно для класса на <body> и для подсветки
активного пункта меню.
$seo
{$seo.title} {$seo.h1} {$seo.description}
{$seo.keywords} {$seo.robots} {$seo.indexable}
{$seo.canonical} {$seo.hreflang} {$seo.page_type}
{$seo.og.title} {$seo.og.description} {$seo.og.type}
{$seo.og.url} {$seo.og.image} {$seo.og.site_name}
{$seo.og.locale} {$seo.og.locale_alternates}
{$seo.twitter.card} {$seo.twitter.title} {$seo.twitter.description}
{$seo.twitter.image} {$seo.twitter.site}
Все ключи присутствуют всегда, поэтому {if $seo.og.image} безопасно. Магазин
считает эти значения сам, теме остаётся вывести их в <head> — готовый кусок
разметки есть на странице Каркас страницы.
$contacts
{if $contacts.phone}<a href="tel:{$contacts.phone_link}">{$contacts.phone}</a>{/if}
{$contacts.name} {$contacts.email} {$contacts.address}
phone_link — телефон, очищенный до цифр и +, готовый для href="tel:".
Незаполненное поле приходит пустой строкой, ключ на месте всегда.
$customer
Для гостя — пусто, поэтому {if $customer} достаточно.
{$customer.id} {$customer.name} {$customer.initial}
{$customer.first_name} {$customer.last_name} {$customer.middle_name}
{$customer.company} {$customer.email} {$customer.phone}
{$customer.member_since}
$errors, $status, $old
После формы, отправленной обычным POST и вернувшейся с ошибкой:
{if $status}<p class="ok">{$status}</p>{/if}
<input name="email" value="{$old.email|default:''}">
{if $errors.email}<span class="err">{$errors.email}</span>{/if}
Ошибок нет — $errors пустой список. Подробности — на странице
Формы витрины.
Постранично
Данные страницы кладутся поверх общих и могут перекрыть любую из них — не
называйте свои переменные product, если на странице уже есть товар.
| Страница | Шаблон | Переменные |
|---|---|---|
| Главная | home.html |
только общие: содержимое собирается через $shop |
| Категория | category.html |
category, breadcrumbs, landing + набор листинга |
| Товар | product.html |
product, breadcrumbs, rec_cross, rec_up, reviews, questions |
| Страница владельца | page.html |
page, breadcrumbs |
| Поиск | search.html |
query, category_id, has_query, corrected + набор листинга |
| Бренд | brand.html |
brand, breadcrumbs + набор листинга |
| Все бренды | brands.html |
brands |
| Метка | tag.html |
tag, breadcrumbs + набор листинга |
| Все метки | tags.html |
tags |
| Корзина | checkout/cart.html |
items, cart, min_order, below_min, free_shipping_left |
| Оформление | checkout/layout.html |
checkout |
| Заказ принят | checkout/success.html |
order, is_authenticated |
| Оплата заказа | checkout/pay.html |
order, order_id, is_paid, is_online |
| Ошибка оплаты | checkout/pay-error.html |
order_id |
| Избранное | favorites.html |
products |
| Сравнение | compare.html |
колонки товаров и строки характеристик |
| Вход | account/login.html |
auth, captcha |
| Регистрация | account/register.html |
auth, captcha, reg_types |
| Обзор кабинета | account/dashboard.html |
orders, orders_count, bonus |
| Заказы | account/orders.html |
orders, pagination, filters |
| Один заказ | account/order.html |
order |
| Профиль | account/profile.html |
profile |
| Не найдено | 404.html |
только общие |
| Магазин закрыт | maintenance.html |
message |
Набор листинга
Одинаков у категории, поиска, бренда и метки — поэтому список товаров, фильтры и постраничная навигация пишутся один раз и включаются во все четыре страницы.
| Переменная | Что внутри |
|---|---|
products |
карточки товаров текущей страницы |
pagination |
постраничная навигация |
total |
сколько товаров нашлось всего |
filters |
доступные фильтры |
active_filters |
чипсы выбранных условий, у каждого адрес «снять» |
filter_chips |
показывать ли чипсы |
selected |
что выбрано сейчас |
sort, sort_options |
текущая сортировка и её варианты |
action_url |
адрес, на который отправляется форма фильтра |
reset_url |
адрес «сбросить всё» |
keep_params |
параметры, которые нужно сохранить при переходе |
has_filters, show_filters |
есть ли фильтры и показывать ли панель |
lazy_load |
подгружать товары кнопкой «Показать ещё» |
filter_mode |
ajax — применять сразу, button — по кнопке |
filter_show_counts |
показывать счётчики у значений фильтра |
image_lazy |
подгружать картинки при прокрутке |
pagination
{if $pagination.has_pages}
{if $pagination.prev_url}<a href="{$pagination.prev_url}">Назад</a>{/if}
{foreach $pagination.pages as $p}
{if $p.ellipsis}<span>…</span>
{else}<a href="{$p.url}"{if $p.active} class="is-active"{/if}>{$p.num}</a>{/if}
{/foreach}
{if $pagination.next_url}<a href="{$pagination.next_url}">Вперёд</a>{/if}
{/if}
Ещё есть current, last, from, to, total — для подписи «Показано 1–24
из 137».
filters
| Ключ | Что внутри |
|---|---|
price |
min, max, from, to, active |
in_stock |
count, selected, disabled — либо пусто, если фильтр выключен |
discount |
то же |
warehouses |
фильтр по складам |
features |
словарные характеристики: цвет, материал, бренд |
ranges |
размерные характеристики: длина, вес, мощность |
booleans |
характеристики «да/нет» |
Рисуйте фильтры списком по данным, а не по именам. Набор характеристик у каждого магазина свой: хардкод «цвет, размер, бренд» на чужом магазине покажет пустоту.
Значение, по которому при текущем выборе товаров нет, приходит с признаком
disabled — его показывают приглушённым, а не прячут: иначе покупатель не
понимает, куда делся вариант.
active_filters
Чипсы выбранных условий. У каждого свой адрес без этого условия, поэтому снятие фильтра работает и без скриптов:
{foreach $active_filters as $chip}
<a href="{$chip.url}" class="chip">{$chip.label} ✕</a>
{/foreach}
Что приходит на отдельные страницы
Категория всегда получает landing, даже на обычной категории — там это
пустые text_top, text_bottom и related. Сделано, чтобы шаблон писался один
раз, без проверки «а есть ли посадочная страница».
Поиск при запросе короче двух букв получает только query, category_id,
has_query (пусто) и total (ноль) — ни листинга, ни фильтров. Отдельная ветка
«введите хотя бы два символа» в шаблоне нужна.
Корзина: items — позиции, cart — итоги, min_order и below_min —
минимальная сумма заказа, free_shipping_left — сколько добрать до бесплатной
доставки (пусто, если добирать не нужно или порога нет).
Оформление получает checkout. У пустой корзины там только признак «пусто»
и сама корзина; иначе — settings (какие поля включены), prefill,
contact_types, recipient_fields, recipient_company_fields,
saved_addresses, location_fields, cart, calc и то, что добавили
дополнения.
Отзывы могут прийти одним ключом: если владелец выключил отзывы, в
$reviews будет только признак «выключено». Обращаться к $reviews.items без
проверки нельзя.
Заказы покупателя в кабинете
Список заказов (account/orders.html) получает orders — строки заказов,
pagination — страницы и filters — из чего покупателю выбирать в отборе
(shipping, payment, statuses и current — что выбрано сейчас). Список
перерисовывается на месте, поэтому саму таблицу выносят в
account/partials/orders-table.html: магазин просит у темы этот же кусок
разметки и подставляет его обратно.
Страница одного заказа (account/order.html) получает order. Заказ —
снимок: суммы, названия способов и данные покупателя останутся такими, какими
были в день покупки, даже если магазин потом всё это переименует.
Строка заказа
Эти поля есть и у строки списка, и у карточки — вёрстку можно писать один раз.
| Поле | Что внутри |
|---|---|
number |
номер, каким его видит покупатель (с оформлением из настроек) |
number_raw |
номер для адреса страницы: в оформлении бывает #, и ссылка сломалась бы |
date |
дата оформления |
status, status_label, status_color |
код статуса, его название и цвет |
total, currency |
сумма и валюта заказа |
items_count |
сколько позиций |
shipping_name, shipping_logo |
способ доставки и его логотип |
payment_name, payment_logo |
способ оплаты и его логотип |
payment_status, payment_status_label |
состояние оплаты и его название |
is_paid |
оплачен ли заказ полностью |
paid_total, due |
сколько внесено и сколько осталось заплатить |
pay_url |
адрес страницы оплаты — либо пусто |
comment |
комментарий покупателя |
tracking |
номер накладной перевозчика |
Логотип приходит пустым, если владелец его не загружал или способ уже удалён — тогда остаётся название, снятое с заказа при оформлении:
{if $order.shipping_logo}<img src="{$order.shipping_logo}" alt="">{/if}
{$order.shipping_name|default:'—'}
pay_url есть только у неоплаченного заказа и только у способа, который уводит
на страницу банка. У оплаты при получении и оплаты по счёту его нет и быть не
должно — кнопка вела бы в никуда:
{if $order.pay_url && $order.due > 0}
<a href="{$order.pay_url}">Оплатить {money amount=$order.due currency=$order.currency}</a>
{/if}
Что добавляется на странице заказа
| Поле | Что внутри |
|---|---|
placed_at, paid_at |
когда заказ оформлен и когда оплачен, со временем |
items_total, services_total, discount_total |
товары, услуги, скидка |
shipping_total, tax_total, bonus_total |
доставка, налог, оплата баллами |
extra_total |
всё, что дополнение добавило к итогу сверх этих строк |
discounts |
какие правила сработали и на сколько |
promo_code |
промокод, если покупатель его вводил |
needs_callback |
покупатель просил перезвонить |
items |
состав заказа |
customer |
что покупатель указал о себе |
recipient |
другой получатель — либо пусто |
address |
адрес доставки |
timeline |
история смен статуса |
Строки обязаны складываться в итог. extra_total для того и есть: в сумму
заказа мог войти пункт, которого в остальных строках нет — например надбавка за
способ оплаты от дополнения. Покажите его отдельной строкой, иначе покупатель
сложит столбиком и получит не ту сумму.
items — состав заказа
| Поле | Что внутри |
|---|---|
name, sku_code |
название и артикул на день покупки |
image |
фотография варианта — либо пусто |
url |
ссылка на товар; пусто, если товара в каталоге больше нет |
qty, unit |
количество и единица продажи |
pack |
packs и rest, если товар брали упаковками |
price, compare_price |
цена и старая цена |
discount_total, total |
скидка на позицию и её сумма |
services |
услуги к этой позиции: name, price, total |
Фотографии может не быть — товар сняли с продажи или её вовсе не загружали. Ставьте на это место значок, пустая рамка читается как сломанная картинка.
customer и recipient — поля заказа
Оба приходят списком: code, name, value. Названия — те же, которыми поля
названы у магазина в разделе «Оформление заказа», поэтому рисуйте их циклом, а
не по именам: набор полей у каждого магазина свой, и заказ компании несёт ещё
название и налоговый номер.
{foreach $order.customer as $field}
<p><span>{$field.name|escape}</span> <span>{$field.value|escape}</span></p>
{/foreach}
recipient приходит пустым, если заказ оформляли на себя.
address — куда везти
name, phone, email, country, region, city, zip, street (улица,
дом и квартира одной строкой), отдельно street_name, building, apartment,
а также point и point_number — выбранное отделение или пункт выдачи. При
доставке в отделение улицы нет и не будет: магазин намеренно её не заполняет,
чтобы в документах не оказалось и адреса, и отделения сразу.
timeline — история заказа
Смены статуса по порядку: date, status, status_label и comment
менеджера. Внутренних пометок сотрудников покупателю не показывают — их в этом
списке нет.
Как посмотреть данные своими глазами
{dump} что вообще доступно этому шаблону
{dump var=$product} одно значение целиком
{dumpc var=$product} то же в консоль браузера
Видит только сотрудник магазина — покупателю блок не покажется. Это самый быстрый способ понять, что приходит на конкретную страницу, и он всегда актуальнее любой таблицы.