📚 Документация пакета bia/page-bundle для управления страницами сайта

📑 Содержание

Описание
Требования
Установка
Конфигурация
Функционал

Описание

Этот пакет предоставляет набор инструментов для управления страницами и их содержимым для bia админ-панели. Пакет позволяет создавать динамические страницы, управлять блоками и шаблонами, управлять контентом страниц.

Требования

PHP: версии 8.1 или выше
composer пакеты:
- bia/admin-bundle: версия dev-master Репозиторий
- doctrine/doctrine-bundle: версия ^2.7
- symfony-cmf/routing-bundle: версия 3.1.*
- symfony/framework-bundle: версия 6.4.*
- symfony/uid: версия 6.2.*

Установка

Для установки пакета необходимо добавить репозиторий в composer.json:

json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://gitlab.srvdev.ru/bia-cms/bundles/page-bundle.git"
    }
  ]
}

Выполнить команду:

bash

$ composer require bia/page-bundle

Затем добавьте пакет в config/bundles.php вашего Symfony приложения:

php

return [
    // ...
    Bia\PageBundle\BiaPageBundle::class => ['all' => true],
];

Конфигурация

После установки пакета, необходимо сконфигурировать его в вашем приложении.

Необходимо зарегистрировать маршруты, пример регистрации в config/routes.php:

php

$routes->import('@BiaPageBundle/Resources/config/routing.yml');

Сгенерировать и выполнить миграции

bash

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

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

bash

php bin/console menu:generate

Сгенерировать роли для административных панелей страниц, шаблонов, Shared блоков:

bash

php bin/console roles:generate

Функционал

Страницы

Сущность страницы является версионируемой (реализовывает интерфейс BaseVersioningEntityInterface), это позволяет хранить историю изменений описаний и блоков, а также публиковать страницу в различные среды (prod, test).

В настоящий момент для страниц реализован функционал составления, копирования, динамической генерации маршрутов без вмешательства в код, генерация sitemap.xml на основе страниц в базе данных.

Шаблоны

Шаблоны представляют из себя сущность в базе данных, которая описывает области для подключения блоков, а также минимальный html/css/js доступный для редактирования из административной панели, что позволяет быстро редактировать содержимое страниц без вмешательства в код приложения.

Добавление файла шаблона

Необходимо создать конфиг templates.yml и в массив templates указать название, описание и путь к шаблону, на примере MockTemplate поставляемого с пакетом:

yaml

templates:
  - title: 'MockTemplate'
    description: 'MockTemplate'
    path: '@BiaPage/mock.html.twig'

Благодаря этой манипуляции, шаблон будет доступен для выбора в административной панели при создании или редактировании сущности шаблона.

Пример шаблона

html

<html>
<head>
    <title>{{ seo.title }}</title>

    <meta name="description" content="{{ seo.description }}">
    <meta name="keywords" content="{{ seo.keywords }}">

    {{ bia_render_template_head|raw }}

    <style>
        .page-bundle-container .page-bundle-area {
            border: 1px solid #000000;
        }

        {{ bia_render_template_css|raw }}
    </style>
</head>
<body>

{{ bia_render_template_html|raw }}

<script>
    {{ bia_render_template_js|raw }}
</script>

</body>
</html>

Переменные доступные в twig шаблоне:

seo.title - сео заголовок, который подставляет из мета-данных страницы или связного со страницей блока реализующего интерфейс BlockSeoInterface
bia_render_template_head - содержимое поля head из сущности Template. Доступно к редактированию из административной панели. Содержит HTML
bia_render_template_css - содержимое поля css из сущности Template. Доступно к редактированию из административной панели. Содержит HTML
bia_render_template_html - содержимое поля html из сущности Template. Доступно к редактированию из административной панели. Содержит HTML
bia_render_template_js - содержимое поля js из сущности Template. Доступно к редактированию из административной панели. Содержит HTML

Функции доступные в twig шаблоне:

bia_page_render_blocks_area - функция отрисовки блоков для указанной области для текущей страницы. На вход принимает строку с названием области, которая генерируется в шаблоне через визуальный редактор в административной панели.
bia_page_render_block - функция отрисовки блока, на вход принимает объект PageBlockDTO
getAvailableSites - функция возвращает список активных сайтов (Site[])
getCurrentSite - функция возвращает текущий сайт (Site)
getCurrentAlias - функция возвращает текущий алиас (Alias)
getCurrentPageState - функция возвращает текущее состояние страницы (PageState)
isCurrentSiteProduction - функция используется для определения является ли текущий сайт продакшном.

Список функций и переменных может измениться

BlockMetadata

Назначение:

Класс BlockMetadata реализует BlockMetadataInterface и используется для хранения метаданных блока. Мета-данные блока содержат описание, иконку, символьный код. Эта информация используются для отрисовки блоков в административной панели.

Методы:

getCode(): возвращает код блока.
getName(): возвращает имя блока.
getIcon(): возвращает иконку блока.
getBundle(): возвращает бандл блока.
jsonSerialize(): сериализует метаданные в JSON.

BreadcrumbsBlock.php

BreadcrumbsBlock - класс блока, который отвечает за отображение хлебных крошек на страницах. Он определяет настройки блока и шаблон для его отображения.

BlockSeoInterface.php

BlockSeoInterface - интерфейс для блоков, которые предоставляют SEO-данные. Он определяет метод для получения SEO-информации из блока.

TextBlock.php и HtmlBlock.php

Эти классы реализуют текстовые и HTML блоки, которые позволяют пользователям добавлять текстовый или HTML контент на страницы. Они наследуют от AbstractBlock и предоставляют методы для настройки и рендеринга контента.

AbstractBlock.php и TwigBlock.php

AbstractBlock - базовый класс для всех блоков, который предоставляет основные методы и свойства для их реализации. TwigBlock - позволяет использовать Twig шаблоны для динамического отображения контента.

BlockInterface.php

BlockInterface - интерфейс для всех блоков, определяющий основные методы, которые должен реализовать каждый блок.

PageCRUDController.php и SharedBlockCRUDController.php

Эти контроллеры обеспечивают CRUD-операции для страниц и общих блоков. Они содержат методы для создания, редактирования, удаления и отображения страниц и блоков.

BlockCompilerPass.php

BlockCompilerPass - класс, который добавляет все зарегистрированные блоки в BlockAggregator при компиляции контейнера служб в Symfony.

TemplateDTO.php, TemplateAreaDTO.php и TemplateLayoutDTO.php

Эти классы представляют собой объекты передачи данных (DTO), которые используются для работы с шаблонами, областями шаблонов и макетами.

PageBlockDTO.php и PageSeoDTO.php

PageBlockDTO - DTO для блоков страниц, который содержит информацию о блоке, такую как ID, код, настройки и позиция. PageSeoDTO - DTO для SEO-информации страницы.

SharedBlock.php и Template.php

Эти классы представляют сущности Doctrine для общих блоков и шаблонов. Они определяют свойства и методы для работы с данными в базе данных.

SiteCreationSubscriber.php

SiteCreationSubscriber - подписчик событий Doctrine, который автоматически создает главную страницу для нового сайта после его создания.

PageSharedBlock.php и PageState.php

Эти классы представляют сущности для управления общими блоками страниц и состояниями страниц. Они используются для поддержания версионности и управления состояниями страниц.

Page.php

Page - сущность, представляющая страницу, с методами для управления её свойствами и состояниями.

BlockEditFormType.php и BlockCreateFormType.php

Эти классы определяют формы для создания и редактирования блоков. Они используют FormMapper для настройки полей формы.

BiaCodeEditorType.php и BiaTemplateGridType.php

Эти классы представляют собой типы форм для редактирования кода и сеток шаблонов, которые могут быть использованы в админ-интерфейсе.

PageRouter.php

PageRouter - реализация интерфейса RouterInterface, который управляет маршрутизацией страниц на основе их состояний и URL.

BlockDebugHelper.php

BlockDebugHelper - утилитарный класс, который помогает в отладке блоков, предоставляя методы для рендеринга отладочной информации.

BlockAggregator.php и BlockResolver.php

BlockAggregator - класс, который собирает зарегистрированные блоки и предоставляет методы для их получения. BlockResolver - класс, который решает блоки по их коду, используя контейнер служб.

BlockProcessor.php и PageComposeHelper.php

Эти классы предоставляют методы для рендеринга блоков и управления их порядком и состоянием на странице.

PageProcessor.php и TemplateProcessor.php

PageProcessor - класс, который управляет текущим состоянием страницы и рендерит её через TemplateProcessor, который отвечает за рендеринг шаблонов с использованием Twig.

TemplateAggregator.php и GlobalVariables.php

TemplateAggregator - класс, который управляет коллекцией шаблонов и предоставляет их для использования в приложении. GlobalVariables - класс, который предоставляет глобальные переменные для использования в Twig шаблонах.

Заключение

Этот пакет предоставляет мощные инструменты для управления страницами и их содержимым в Symfony приложениях. Используйте предоставленные классы и сервисы для создания динамичных и гибких страниц, которые легко управляются через админ-интерфейс.

📚 Документация пакета bia/page-bundle для управления страницами сайта ​

📑 Содержание ​

Описание ​

Требования ​

Установка ​

Конфигурация ​

Функционал ​

Страницы ​

Шаблоны ​

Добавление файла шаблона ​

Пример шаблона ​

Переменные доступные в twig шаблоне: ​

Функции доступные в twig шаблоне: ​

BlockMetadata ​

BreadcrumbsBlock.php ​

BlockSeoInterface.php ​

TextBlock.php и HtmlBlock.php ​

AbstractBlock.php и TwigBlock.php ​

BlockInterface.php ​

PageCRUDController.php и SharedBlockCRUDController.php ​

BlockCompilerPass.php ​

TemplateDTO.php, TemplateAreaDTO.php и TemplateLayoutDTO.php ​

PageBlockDTO.php и PageSeoDTO.php ​

SharedBlock.php и Template.php ​

SiteCreationSubscriber.php ​

PageSharedBlock.php и PageState.php ​

Page.php ​

BlockEditFormType.php и BlockCreateFormType.php ​

BiaCodeEditorType.php и BiaTemplateGridType.php ​

PageRouter.php ​

BlockDebugHelper.php ​

BlockAggregator.php и BlockResolver.php ​

BlockProcessor.php и PageComposeHelper.php ​

PageProcessor.php и TemplateProcessor.php ​

TemplateAggregator.php и GlobalVariables.php ​

Заключение ​

📚 Документация пакета bia/page-bundle для управления страницами сайта

📑 Содержание

Описание

Требования

Установка

Конфигурация

Функционал

Страницы

Шаблоны

Добавление файла шаблона

Пример шаблона

Переменные доступные в twig шаблоне:

Функции доступные в twig шаблоне:

BlockMetadata

BreadcrumbsBlock.php

BlockSeoInterface.php

TextBlock.php и HtmlBlock.php

AbstractBlock.php и TwigBlock.php

BlockInterface.php

PageCRUDController.php и SharedBlockCRUDController.php

BlockCompilerPass.php

TemplateDTO.php, TemplateAreaDTO.php и TemplateLayoutDTO.php

PageBlockDTO.php и PageSeoDTO.php

SharedBlock.php и Template.php

SiteCreationSubscriber.php

PageSharedBlock.php и PageState.php

Page.php

BlockEditFormType.php и BlockCreateFormType.php

BiaCodeEditorType.php и BiaTemplateGridType.php

PageRouter.php

BlockDebugHelper.php

BlockAggregator.php и BlockResolver.php

BlockProcessor.php и PageComposeHelper.php

PageProcessor.php и TemplateProcessor.php

TemplateAggregator.php и GlobalVariables.php

Заключение