Разработчикам

Razor API

Руководство разработчика PageCharm

Справочник по объектам и методам, которые обычно используются во вьюшках: PageCharmPageModel, IPageCharmContentQuery, медиа, настройки, slug и URL helpers.

Что подключать во вьюшке

Публичное представление получает модель PageCharmPageModel. Дополнительные сервисы можно внедрять обычным Razor @inject: чаще всего это IPageCharmContentQuery для контента и IPageCharmSettings для настроек сайта.

PageCharmPageModel

Чтение полей контента

Поддерживаемые типы для Get<T>: string, int, long, decimal, bool, DateOnly, TimeOnly, DateTimeOffset. Для сложных типов PageCharm пытается десериализовать JsonValue через System.Text.Json.

Медиа helpers

CmsMediaAsset содержит Id, FileName, ContentType, Size, StorageKey, Url, Alt, FocalX, FocalY, MetadataJson, CreatedAt. Для локального storage Url обычно относительный, например /uploads/image.jpg; для CDN/S3 может быть абсолютным. Для resized-варианта используйте image.GetPresetUrl("card"); он вернет путь вида /_pagecharm/images/{id}/{preset}/{file}.

IPageCharmContentQuery: фильтры

Все методы фильтрации возвращают новый IPageCharmContentQuery. Это позволяет переиспользовать базовый запрос для CountAsync() и списка. Если сортировку не указать, PageCharm сортирует по ручному порядку Order, затем по Id.

IPageCharmContentQuery: сортировка и завершение

Типы сортировки

Словари

IPageCharmDictionaryQuery читает раздел «Словари» без прямой зависимости view от EF Core. Tags используют словари как множество значений и фильтруются через WithAnyTags, WithAllTags, WhereTagsContain. Select со словарным источником хранит один alias значения, поэтому фильтруется как обычное поле: WhereFieldEquals("brand", "avtovaz").

Настройки сайта

Для GetAsync<string> возвращается сохраненное значение как строка. Для чисел, bool и JSON-значений можно использовать типизированный GetAsync<T>. Если настройка хранится как дата/время в редакторском формате, берите строку или FindAsync и парсите ValueJson явно. Для настройки типа Tags удобнее получить CmsSetting через FindAsync и вызвать setting.GetTags().

URL и slug helpers

SEO aliases

Системные SEO-поля доступны через константы CmsSystemAttributeAliases.SeoTitle, SeoDescription, CanonicalUrl, Robots. В админке они отображаются только у шаблонов с включенной галочкой SEO параметры. Если значение не задано, Get<string> просто вернет null.

Пример

@model PageCharmPageModel
@inject IPageCharmContentQuery Content
@inject IPageCharmDictionaryQuery Dictionaries
@inject IPageCharmSettings Settings

@{
    var siteTitle = await Settings.GetAsync<string>("site", "title") ?? "PageCharm";
    var brands = await Dictionaries.GetValuesAsync("brands");

    var breadcrumbs = await Content.Active()
        .GetBreadcrumbsAsync(Model.Content);

    var baseQuery = Content.Active()
        .FromBlocks("catalog", "special-offers")
        .WithTemplates("product", "promo-card")
        .SearchFields("ноутбук", "title", "description")
        .WhereDecimalFieldBetween("price", min: 1000m, max: 250000m);

    var total = await baseQuery.CountAsync();

    var items = await baseQuery
        .OrderByField("price", CmsContentFieldSortType.DecimalNumber)
        .Skip(0)
        .Take(12)
        .ToListAsync();
}

<title>@(Model.Content.Get<string>(CmsSystemAttributeAliases.SeoTitle) ?? Model.Content.Name)</title>

<nav>
    <a href="/">Главная</a>
    @foreach (var parent in breadcrumbs)
    {
        <a href="@parent.Url">
            @(parent.Get<string>("title") ?? parent.Name)
        </a>
    }
</nav>

<h1>@siteTitle</h1>
<p>Найдено: @total</p>

@foreach (var item in items)
{
    var cover = item.GetFirstMedia("cover");
    <article>
        @if (cover is not null)
        {
            <img src="@cover.GetPresetUrl("kartochka-tovara")" alt="@cover.Alt">
        }
        <h2><a href="@item.Url">@(item.Get<string>("title") ?? item.Name)</a></h2>
        <strong>@item.Get<decimal>("price")</strong>
    </article>
}

Слой для public-сайта

Во вьюшках лучше читать CMS через IPageCharmContentQuery и helpers. EF Core напрямую оставьте для админки, миграций и специальных сервисов приложения.