Interfaces
Table of Contents
Interfaces
- AdvertCategoryInterface
- Category of the advert modules (Bazaar adverts, Comcat company listings): a nested-set node with
a price list and parameter targeting.
- AdvertPlaceRelInterface
- Join entity between an advertisement and an ad position (`*AdvertPlaceRel`); holds the position reference.
- AssetRelInterface
- Link between an entity and an image or file (`*AssetRel`, `*ImageRel`) with order and flags.
- BlogContentInterface
- Blog content with a detail page (article, news item, event): translation, main image and region.
- CategoryParameterRelInterface
- Parameter targeting row of an advert category (Bazaar, Comcat): which parameter or option the
advert form of the category shows, in which group and order, and whether it is required or
searchable. Written by {@see \App\Core\Traits\Api\Models\Managers\CategoryParameterRelSyncTrait}.
- CategoryPriceInterface
- Advert category price in a payment region and currency; the "From …" price on the list is computed from it
({@see \App\Core\Base\Shared\Bazaar\Models\Entities\Category::getMinPriceForPaymentRegion()}).
- CategoryRelInterface
- Link between a record and a category (e.g. advert to category); assembled into
{@see \App\Core\Traits\Shared\Models\Entities\Collections\CategoryRelCollectionTrait::getCategories()}.
- CommentThreadInterface
- Comment thread of a record; lists (e.g. discussion posts) read the comment count from it.
- ExpressTariffInterface
- Tariff with quick (SMS) prices; the source of the express payment offer
({@see \App\Core\Traits\Front\Presenters\ExpressPaymentTrait::findExpressPaymentTariffs()}).
- IdentifiableInterface
- Entity with a simple integer primary key. Most entities have one (often via
{@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite
key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the
id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).
- ManageKeyAwareInterface
- Record that a visitor without an account can manage through the "manage" link from the insert e-mail
(Bazaar advert, Comcat company profile, Discussion post).
- OwnerAwareInterface
- Entity that knows who created it (the owner is the author or sender of the record); the named entry point
to the generic base of the conditional RBAC role `owner`.
- ParameterGroupInterface
- ParameterGroupTextInterface
- Translation entity (`*Text`): one row of parent texts for one language.
- ParameterInterface
- ParameterRelInterface
- Link between a parameter value and a host entity (currently an advert, possibly others later).
- ParameterRuleConditionInterface
- Single rule condition: "parameter X satisfies validator V over values Y".
- ParameterRuleConditionValueInterface
- Expected value of a condition: either an option id (`optionId`, for select-like parameters)
or a raw value (`value`, for scalar ones). Exactly one of them is filled.
- ParameterRuleInterface
- Parameter rule: conditions (`conditions`) plus targets (`targets`).
- ParameterRuleTargetInterface
- Rule target. Which fields are filled determines the effect (not `ParameterRuleInterface::getAction()`):
- ParameterTextInterface
- Translation entity (`*Text`): one row of parent texts for one language.
- PaymentRegionScopedInterface
- Record valid for one payment region (tariff prices, quick prices, gateway-to-region links).
- PollPlaceRelInterface
- Join entity of a poll place (`*PollPlaceRel`); holds the poll reference.
- PricedCategoryInterface
- Category with a price list and a free flag (Bazaar, Comcat, Discussion): a nested-set node the shared
{@see \App\Core\Traits\Api\Models\Managers\CategoryPriceSyncTrait} copies to its subtree.
- ReceiverAwareInterface
- Entity that knows who received it (the receiver of the record); the basis of the conditional RBAC role `receiver`.
- ScopedTreeNodeInterface
- Nested-set tree where one table holds several independent trees distinguished by a
scope column (e.g. menu items distinguished by `menuId`). Extends
{@see TreeNodeInterface} with a scope that the entity knows about itself.
- TariffPriceInterface
- Tariff price for a payment region × gateway × currency combination; looked up by
{@see \App\Core\Traits\Shared\Models\Entities\Collections\TariffPriceCollectionTrait::getPrice()}.
- TariffQuickPriceInterface
- Quick (SMS) price of a tariff in one payment region; what the express payment offer
on the detail page needs ({@see \App\Core\Traits\Front\Presenters\ExpressPaymentTrait}).
- TariffTextInterface
- Tariff translation (name and description) for the front-end offer.
- TranslationInterface
- Translation entity (`*Text`): one row of parent texts for one language.
- TreeNodeInterface
- Marker for an entity ordered as a nested set (tree via lft/rgt/level + parentId).