Snippet
Общее
Используйте редактируемый элемент Snippet для внедрения фрагмента документа, например, тизеров или других блоков в ваш документ.
Сниппеты напоминают небольшие страницы, которые можно вставлять в другие документы. Их нужно создавать таким же образом, как и другие документы (страницы).
Конфигурация
| Имя | Тип | Описание |
|---|---|---|
defaultHeight | integer | Высота по умолчанию, если элемент пустой |
height | integer | Высота сниппета в пикселях |
reload | bool | Перезагрузить документ при изменении |
title | string | Вы можете задать элементу заголовок |
width | integer | Ширина сниппета в пикселях |
class | string | CSS-класс, который добавляется к окружающему контейнеру этого элемента в режиме редактирования |
cache | bool | Включить кэш для отрендеренного сниппета |
Методы
| Имя | Возвращает | Описание |
|---|---|---|
getId() | int | Возвращает ID назначенного фрагмента |
getSnippet() | Snippet | Возвращает объектб назначенный фрагменту |
isEmpty() | bool | Проверяет, пуст ли редактируемый элемент или нет |
Примеры
Основное использование
{{ pimcore_snippet("mySnippet", {"width": 250, "height": 100}) }}
Кэширование
По умолчанию кэширование отключено.
Вы можете включить кэширование фрагмента, передав в конфигурацию cache: true
или включив кэширование всей страницы.
Независимо от того, используете ли вы кэширование всей страницы или нет, рекомендуется включить кэш прямо на редактируемом элементе,
если результат фрагмента должен быть закэширован.
{{ pimcore_snippet("mySnippet", {cache: true}) }}
Вы можете предложить улучшение документации или задать вопрос в комментариях.
Если вам нужна полноценная консультация — вы можете заказать её на нашем сайте.