Entities
Table of Contents
Classes
- AdminMenuItem
- AdminMenuItemText
- AdminPage
- AdminPageMenuItemRel
- AdminPageText
- ApiClient
- Admin list row of an external Api client (Settings, applications with Api access).
- Asset
- Admin variant of an image/asset (`cms_system_images`).
- AssetText
- Blacklist
- Admin variant of the blacklist (`cms_system_blacklists`), hydrated from the Api endpoint
`api/system/blacklist` via `ApiBridge`. Flat entity: value and type.
- BlacklistedWord
- Admin variant of a blacklisted word (`cms_system_blacklisted_words`), hydrated from `api/system/blacklisted-word`.
- BlacklistedWordText
- Admin variant of the value of a blacklisted word in one language.
- Country
- Country (`cms_system_countries`) — ISO 3166-1 alpha-2 code, VAT id prefix, EU membership.
- CountryText
- Country translation (`cms_system_country_texts`) — localized country name.
- CronJob
- Cron job known to the scheduler (`cms_system_cron_jobs`).
- Currency
- Admin variant of a currency (`cms_system_currencies`), hydrated from the Api endpoint
`api/system/currency` via `ApiBridge`. Maps `translations` to {@see CurrencyText}: name,
abbreviation and the plural label after the amount.
- CurrencyText
- Currency translations (cms_system_currency_texts): per-language name, description and
pluralized label after the amount. The `shortcut` is not translated; it is the defined
currency key for payment gateways and stays on {@see Currency}.
- CustomAsset
- Admin variant of a custom code asset, hydrated from `api/system/custom-asset` via `ApiBridge`.
- Email
- EmailQueue
- EmailText
- ExternalConnection
- External connection (third-party integrations: reCAPTCHA, maps, analytics ...).
- File
- Admin variant of a file (`cms_system_files`), the target of nested `file` references in admin
entities (`AdvertFileRel`). Hydrated from the Api endpoint via include `fileRels.file`.
- ImageUsage
- Image usage (`cms_system_asset_usages`): module + purpose, e.g. `blog-articles`.
- ImageVariant
- Image variant (`cms_system_asset_variants`): technical data of a downscaled image shared by
all usages (size, mode, watermark).
- Language
- Localization
- LoginProvider
- Admin variant of a login provider (`cms_system_login_providers`), hydrated from the Api
endpoint `api/system/login-provider` via `ApiBridge`; maps translations.
- LoginProviderText
- Menu
- Admin variant of a menu (`cms_system_menu`), hydrated from the Api endpoint
`api/system/menu` via `ApiBridge`.
- MenuItem
- Admin variant of a menu item (`cms_system_menu_items`), hydrated from the Api endpoint
`api/system/menu-item` via `ApiBridge`.
- MenuItemText
- MenuText
- Notification
- Admin variant of a notification (`cms_system_notifications`), hydrated from the Api endpoint
`api/system/notification`. Flat entity (scalar FKs `userId` / `typeId`).
- NotificationType
- Admin variant of a notification type (`cms_system_notification_types`), hydrated from the Api
endpoint `api/system/notification-type`; maps translations (name).
- NotificationTypeText
- Page
- Admin variant of a front end page (`cms_system_pages`), hydrated from the Api endpoint
`api/system/page` via `ApiBridge`.
- PageSection
- Admin variant of a page section (`cms_system_page_sections`), hydrated from the Api endpoint
`api/system/page-section` via `ApiBridge`. Maps `translations` to {@see PageSectionText}:
heading and HTML content.
- PageSectionText
- Language variant of a page section: heading and HTML content. `content` is markup from the
rich-text editor ("raw" mode): it goes out unescaped on the front end and the template just
prints it ({@see PageSection}).
- PageText
- Payment
- Admin variant of a payment (`cms_system_payments`), hydrated from the Api endpoint
`api/system/payment`. Flat entity (scalar FKs). The form edits a curated set of fields;
system-generated ones (fees, signature, gateway id, callback, URL) are preserved on edit
outside the form.
- PaymentCallback
- Admin variant of a payment callback (`cms_system_payment_callbacks`), hydrated from the Api
endpoint `api/system/payment-callback`. Flat config entity (callback routing).
- PaymentGate
- Admin variant of a payment gateway (`cms_system_payment_gates`), hydrated from the Api
endpoint `api/system/payment-gate`; maps translations. The per-region price links
(`PaymentGateRegionRel`) are not mapped yet.
- PaymentGateText
- PaymentGatewayNotification
- Admin variant of a payment gateway notification (`cms_system_payment_gateway_notifications`), hydrated
from the Api endpoint `api/system/payment-gateway-notification`. Read-only: the payment layer writes it,
the admin lists it on a payment (tab "Communication with the gateway").
- PaymentRegion
- Admin variant of a payment region (`cms_system_payment_regions`), hydrated from the Api
endpoint `api/system/payment-region` via `ApiBridge`; maps translations (name) and the
currency association. The form edits `currencyId` / `regionId` as scalars through selects
(admin `Currency` / `Region` managers).
- PaymentRegionText
- PaymentStatus
- Admin variant of the payment status code list, hydrated from the Api endpoint
`api/system/payment-status` via `ApiBridge`. The list is seed-only (no admin CRUD grid); the
manager is read-only and serves the Invoicer Setting form (choosing invoice generation rules
by payment status).
- PaymentTransaction
- Admin variant of a payment transaction (`cms_system_payment_transactions`), hydrated from the
Api endpoint `api/system/payment-transaction`. Read-only: the payment layer writes it, the
admin only lists it on a payment (how many times it was canceled, what it passed through).
- PdfTemplate
- Admin PDF template (`cms_system_pdf_templates`), hydrated from the Api endpoint
`api/system/pdf-template`. Holds translations (name) and owned variants
(`PdfTemplateVariant`: css plus name/header/html/footer per language).
- PdfTemplateLayout
- Admin variant of the PDF layout code list, hydrated from the Api endpoint
`api/system/pdf-template-layout` via `ApiBridge`. Read-only: it only supplies the options of
the invoice PDF layout select in Settings.
- PdfTemplateText
- PdfTemplateVariant
- Admin variant of a PDF template (`cms_system_pdf_template_variants`), an owned collection of
the template (`PdfTemplate.variants`, cascade persist/remove). Holds `css` per variant, a
semantic name (`translations`: name/header/html/footer; the form does not edit
header/html/footer) and content per variant and layout (`layoutTexts`).
- PdfTemplateVariantLayoutText
- Admin variant of the content per variant and layout, hydrated from the Api endpoint through
the owned collection `PdfTemplateVariant.layoutTexts`.
- PdfTemplateVariantText
- PrivilegeGroup
- Admin variant of a privilege group; CRUD screen (group grid and Multiplier).
- PrivilegeGroupText
- Labels of a privilege group (`cms_system_privilege_group_texts`); derived identity: PK is
`languageId` plus the association to the parent group (declared in the UI leaf).
- Region
- Admin variant of a region (`cms_system_regions`), hydrated from the Api endpoint
`api/system/region` via `ApiBridge`; maps translations (name). Currently a read-only source
for the `regionId` select in the payment region form; it has no CRUD presenter yet.
- RegionText
- Route
- Admin variant of a route (`cms_system_routes`), hydrated from the Api endpoint
`api/system/route` via `ApiBridge`. The admin needs it only as the source of options for the
`route` multiselect in the page form: the label is built from module/presenter/action (see
`PageFormTrait::prepareRouteOptions()`). The link to pages is held by
`cms_system_pages.routes` (owning many-to-many side), so the admin `Route` maps neither `pages`
nor translations (`RouteText`).
- Setting
- SmtpSetting
- SupplyKind
- Supply kind (`cms_system_supply_kinds`) — goods, service, electronic service, …
- SupplyKindText
- Supply kind translation (`cms_system_supply_kind_texts`) — name + admin help text.
- Tariff
- Admin variant of a tariff (`cms_system_user_tariffs`), hydrated from the Api endpoint
`api/system/tariff`; maps translations and the price list (`TariffPrice` per region and
gateway; the currency is the front end axis).
- TariffPrice
- Admin price list row of a membership tariff (`cms_system_user_tariff_prices`): region,
gateway and currency. The `tariff` association holds the identity; the price list is saved
as an object graph with the tariff ({@see \App\UI\Admin\System\Presenters\Traits\Forms\TariffFormTrait}).
- TariffText
- Theme
- Unit
- Admin variant of a unit of measure (`cms_system_units`), hydrated from the Api endpoint
`api/system/unit`; maps translations (full name).
- UnitText
- Translation of a unit of measure (`cms_system_unit_texts`): the full name ("piece",
"kilogram"). The abbreviation is not translated, it lives in {@see Unit::$code}.
- User
- Admin variant of a user (`cms_system_users`), hydrated from the Api endpoint
`api/system/user` via `ApiBridge`. Has no translations; role and group associations are not
mapped because the grid list does not need them.
- UserDiscountLevel
- Admin variant of the discount level code list (`cms_system_user_discount_levels`), hydrated
from the Api endpoint `api/system/user-discount-level` via `ApiBridge`.
- UserGroup
- Admin variant of a user group (`cms_system_user_groups`), hydrated from the Api endpoint
`api/system/user-group` via `ApiBridge`; maps translations (name).
- UserGroupText
- UserPayment
- Admin variant of a user payment (`cms_system_user_payment_items`), hydrated from the Api
endpoint `api/system/user-payment`. Flat entity (scalar FKs user/tariff/payment).
- UserRole
- Admin variant of a user role (`cms_system_user_roles`), hydrated from the Api endpoint
`api/system/user-role`. Maps only `name` and `setAfterRegistration`; the privileges
many-to-many is handled by `UserRolePrivilege`.
- UserRolePrivilege
- UserRolePrivilegeRel
- UserRolePrivilegeText
- Labels of a privilege (`cms_system_user_role_privilege_texts`); derived identity: PK is
`languageId` plus the association to the parent privilege (declared in the UI leaf).
- UserType
- Admin variant of a user type (`cms_system_user_types`), hydrated from the Api endpoint
`api/system/user-type` via `ApiBridge`; maps translations (name).
- UserTypeText
- Vat
- Admin variant of a VAT rate (`cms_system_vats`), hydrated from the Api endpoint
`api/system/vat` via `ApiBridge`. Flat entity: percentage and multiplier.
- VatRate
- VAT rate (`cms_system_vat_rates`) of a supply kind in a country for a validity period.