omnibase/marketplace Référence de l’API

App\Controller

DemoController class

class DemoController extends AbstractController DemoController.php:29

The demonstrator's one page: it seeds a small shop, signs a visitor in, fills a cart and pays two orders - then hands over to the shop itself.

Everything here is demo scaffolding. A real application seeds stores from a fixture or the admin, and members shop through the bundle's pages; nothing in this file is a pattern to copy.

DemoController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly Security $security, readonly Cart $cart, readonly Checkout $checkout, readonly PaymentGatewayRegistry $gateways, EventDispatcherInterface $dispatcher)

DemoController::index()

public function index(): Response

App\Entity

User class

class User extends User User.php:15

The demo's member. base-bundle's User identifies people by email and has no username; the forum and the mailbox address members by username (an @mention, a recipient typed by hand), so the application's User carries one - as every base-bundle application's User does.

User::getUsername()

public function getUsername(): ?string

User::setUsername()

public function setUsername(string $username): self

User::__toString()

public function __toString(): string

App\Payment

DemoGateway class

final class DemoGateway implements PaymentGatewayInterface DemoGateway.php:16

An application's own gateway, as small as one gets: it accepts every order at once. A real one would call its payment service and answer paid(), pending(), redirect($url) or refused('reason.key').

DemoGateway::name()

public static function name(): string

DemoGateway::supports()

public function supports(Order $order, PaymentMethod $method): bool

DemoGateway::pay()

public function pay(Order $order, Transaction $transaction, PaymentMethod $method): PaymentResult

App\Repository

UserRepository class

class UserRepository extends UserRepository UserRepository.php:5

Base\Marketplace

MarketplaceBundle class

class MarketplaceBundle extends AbstractBaseBundle MarketplaceBundle.php:9

MarketplaceBundle::__construct()

public function __construct()

MarketplaceBundle::getPath()

public function getPath(): string

Modern bundle layout: the class lives in src/, the bundle root is the package root - so TwigBundle picks up ./templates as @Marketplace.

MarketplaceBundle::build()

public function build(ContainerBuilder $container): void

Base\Marketplace\Attribute

OrderReference class

class OrderReference extends AbstractAttribute OrderReference.php:23

A human order reference, generated once on the first flush:

#[OrderReference(format: 'CCC-XXXX-YYY')]

C the buyer's country (from their cookie), as digits X random digits Y the date, down to the minute

Found by base-bundle's AttributeReader because MarketplaceExtension adds this directory to base.attributes.paths.

OrderReference::__construct()

public function __construct(protected string $format = 'CCC-XXXX-YYY')

OrderReference::supports()

public function supports(string $target, ?string $targetValue = null, $object = null): bool

OrderReference::generate()

public function generate(): string

OrderReference::unique()

public function unique(OnFlushEventArgs $event, mixed $entity, string $property): string

A reference no other order holds, neither stored nor flushed with this one. The format leaves only its X digits to chance within a second (the country and the date are the same for every order of that second): two orders made in the same second drew the same reference once in 9 000 pairs, and the column being unique, the second flush failed. Seen in the suite (SupplyTest, which makes orders a few milliseconds apart), and as likely for two buyers paying in the same second.

OrderReference::onFlush()

public function onFlush(OnFlushEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null)

Base\Marketplace\Catalogue

CatalogueNotificationListener class

final class CatalogueNotificationListener CatalogueNotificationListener.php:16

A platform's product or stock webhook (through PaymentController's /marketplace/{gateway}/webhook, checked by the omnitrade gateway): the product brought in again, taken off sale when deleted, its stock counted - when the catalogue is read from that gateway (marketplace.catalogue.source).

CatalogueNotificationListener::__construct()

public function __construct(readonly PlatformSynchronizer $synchronizer, readonly ?string $source = null)

CatalogueNotificationListener::__invoke()

public function __invoke(CatalogueNotificationEvent $event): void

InventorySynchronizer class

class InventorySynchronizer InventorySynchronizer.php:15

The stock levels alone, more often than the whole catalogue: every linked variant's count read from the platform (FetchInventory) and written here.

A platform that counts nothing (Stripe) is left alone: the stock stays the site's.

InventorySynchronizer::__construct()

public function __construct(readonly PlatformSynchronizer $products, readonly PlatformLinkRepository $links, readonly bool $enabled = true)

InventorySynchronizer::reads()

public function reads(string $gatewayName): bool

Whether this gateway's stock is read at all.

InventorySynchronizer::sync()

public function sync(string $gatewayName, bool $dryRun = false): int

Returns

how many products got a new count

PlatformSynchronizer class

class PlatformSynchronizer PlatformSynchronizer.php:49

The catalogue kept on a platform, copied here: every product an omnitrade gateway reads (Stripe's Products, a Shopify shop, a WooCommerce site) becomes a Product of the store - its variants Variants -, its vendor a Brand, its key/value attributes the attributes of the same code, its tags Features, its SKU and barcode identifiers. Payment stays wherever the shop pays (omnitrade/stripe), whatever the source of the catalogue.

One way only, the platform to the site, and gently:

1. only the fields of marketplace.catalogue.owned_fields are written: the taxa, the pairings, the age gate, the lots, an image chosen here - never listed, never touched; 2. a variant whose owned fields hash the same as last time is not written at all (no updatedAt bump, no cache invalidated); 3. nothing is deleted: a product gone from the platform (or no longer active) is taken off sale (DISCONTINUED, no stock), its order history intact, its link kept as orphaned.

A first import finds what the shop already sells by SKU and links it rather than making a duplicate.

const UNMANAGED_TAG = 'platform-unmanaged'

A product carrying this feature (a tag) is never written by the sync.

PlatformSynchronizer::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly PlatformLinkRepository $links, readonly ?Registry $registry = null, readonly ?string $storeSlug = null, readonly array $ownedFields = [], readonly string $defaultCurrency = 'EUR', readonly string $environment = 'prod')

PlatformSynchronizer::stats()

public function stats(): array

PlatformSynchronizer::resetStats()

public function resetStats(): void

PlatformSynchronizer::gateway()

public function gateway(string $name): GatewayInterface

Throws

LogicException without glitchr/omnitrade, and in a demonstration (glitchr/omnibase's demo environment): its catalogue is its fixtures', no platform is read there

PlatformSynchronizer::sync()

public function sync(string $gatewayName, ?\DateTimeInterface $since = null, bool $full = false, bool $dryRun = false, ?callable $progress = null, ?string $query = null): array

Every product of the platform, page by page - only what changed since $since when given. With $full, what the platform no longer has is taken off sale here.

$progress

told of each product and what became of it

Returns

the counters

PlatformSynchronizer::synchronize()

public function synchronize(string $gatewayName, RemoteProduct $remote, bool $dryRun = false): string

One platform product into the catalogue: its first variant is the Product, the others its Variants.

Returns

created, updated, unchanged, skipped or discontinued (the first variant's)

PlatformSynchronizer::discontinue()

public function discontinue(string $gatewayName, string $remoteProduct, bool $dryRun = false): int

The product is gone from the platform: taken off sale, never deleted.

PlatformSynchronizer::updateStock()

public function updateStock(string $gatewayName, Stock $stock): bool

A stock level the platform counted: by the variant's id there, or its counted item's.

PlatformSynchronizer::flush()

public function flush(): void

PlatformSynchronizer::fingerprint()

public function fingerprint(RemoteProduct $remote, RemoteVariant $variant): string

What a variant's owned fields hash to: the same as last time, nothing is written.

Base\Marketplace\Console

CatalogueSyncCommand class

class CatalogueSyncCommand extends Command CatalogueSyncCommand.php:25

marketplace:catalogue:sync [gateway]: the catalogue of a platform read in (marketplace.catalogue.source when no gateway is named). Incremental by default - what changed there since the last change read -, --full reads everything and takes off sale what the platform no longer has, --inventory reads the stock levels only. Run it from the cron container.

CatalogueSyncCommand::__construct()

public function __construct(readonly PlatformSynchronizer $products, readonly InventorySynchronizer $inventory, readonly PlatformLinkRepository $links, readonly ?string $source = null)

InvoiceIssueCommand class

class InvoiceIssueCommand extends Command InvoiceIssueCommand.php:21

marketplace:invoice:issue <order>...: the invoices of paid orders, by their reference - what the back office's "Issue the invoice" does, for a script or a catch-up. An order that has its invoice is said and skipped.

--paid-without-invoice issues every paid order's that has none.

InvoiceIssueCommand::__construct()

public function __construct(readonly Invoices $invoices, readonly EntityManagerInterface $entityManager)

ReferralsCommand class

class ReferralsCommand extends Command ReferralsCommand.php:13

marketplace:referrals: every night from the cron container - the referrers whose referee's order held are rewarded.

ReferralsCommand::__construct()

public function __construct(readonly Referrals $referrals)

StripeWebhookCommand class

final class StripeWebhookCommand extends Command StripeWebhookCommand.php:47

Makes sure Stripe knows where to send the marketplace's events: for every payment method on an omnitrade gateway whose provider is Stripe, the webhook endpoint on marketplace_payment_webhook, listening to the Checkout events PaymentController handles. Safe to run again and again - on every deploy, from the container's entrypoint:

• no API key yet, or an address Stripe cannot reach (localhost: use stripe listen there): nothing to do, said so, success;
• the endpoint exists: its events are completed if some are missing;
• it does not: it is created, and the signing secret Stripe returns - ONLY at creation - is stored in the back office's setting api.payment_method.<gateway>.webhook_secret, which the omnitrade gateway runs on from then on: every event's signature is checked against it. No secret to copy.

The API key: the one the omnitrade gateway runs on - typed in the back office (api.payment_method.<gateway>.api_key) or configured (omnitrade.gateways.<gateway>.options.api_key, STRIPE_API_KEY). The address: --url, else the method's webhook_url setting, else the route's absolute URL under the router's default URI.

An endpoint that exists but whose secret is known nowhere (created by hand, or the settings lost) cannot be read back from the API: reveal it in the Dashboard into webhook_secret, or run with --recreate for a new one.

const EVENTS = ['checkout.session.completed', 'checkout.session.async_payment_succeeded', 'checkout.session.expired', 'checkout.session.async_payment_failed']

StripeWebhookCommand::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly UrlGeneratorInterface $urls, readonly HttpClientInterface $http, readonly SettingBagInterface $settings, readonly PaymentGatewayRegistry $gateways)

SubscriptionsCommand class

class SubscriptionsCommand extends Command SubscriptionsCommand.php:21

marketplace:subscriptions: every night from the cron container. Announces the rights that ended (EntitlementEndedEvent) and those about to (EntitlementEndingEvent), once each; --sync first asks the providers where each running subscription stands, for the events a webhook missed.

SubscriptionsCommand::__construct()

public function __construct(readonly Subscriptions $subscriptions, readonly EntityManagerInterface $entityManager)

WishlistRefreshCommand class

class WishlistRefreshCommand extends Command WishlistRefreshCommand.php:19

marketplace:wishlist:refresh-prices: every night from the cron container.

Reads again the prices of the open lists' objects that are older than marketplace.wishlist.price_ttl, and lets the lapsed reservations go.

WishlistRefreshCommand::__construct()

public function __construct(readonly Wishlists $wishlists, readonly Reservations $reservations)

Base\Marketplace\Controller\Admin

AbstractMarketplaceCrudController class

abstract class AbstractMarketplaceCrudController extends AbstractCrudController AbstractMarketplaceCrudController.php:17

Every marketplace screen of the back office: products, stores, orders, taxes, exchange rates... For the creators (marketplace.admin_role, by default ROLE_SUPERADMIN; ROLE_EDITOR inherits it), and for a shop's owners to read (MarketplaceVoter): an application's other staff keep their own screens (a kitchen, a till) without the catalogue, the prices or the money.

The admin bundle checks this permission on every action of the CRUD and hides the menu entries and dashboard cards that lead to it.

MarketplaceAdminTrait trait

trait MarketplaceAdminTrait MarketplaceAdminTrait.php:20

The marketplace screens' permissions (MarketplaceVoter), for every marketplace CRUD - used by AbstractMarketplaceCrudController, and directly by a CRUD controller that already extends another admin base (taxons, adapters):

reading MARKETPLACE_VIEW: the creators, and the shops' owners; changing the creators (the admin's default for new, edit, delete) - or, on a screen of VAT and prices (isPricing()), the shops' owners too: MARKETPLACE_PRICING.

MarketplaceAdminTrait::configureCrud()

public function configureCrud(Crud $crud): Crud

MarketplaceAdminTrait::configureActions()

public function configureActions(Actions $actions): Actions

QuotePipelineController class

class QuotePipelineController extends AbstractController QuotePipelineController.php:23

The quotes as a pipeline, in the back office (it opens in the nest, like every admin page): one column per status - asked, being written, sent, accepted, paid, declined -, each card its client, company, terms, total and how long it has waited, a click away from its form.

QuotePipelineController::__construct()

public function __construct(readonly QuoteRepository $quotes, readonly AdminContext $adminContext, readonly MenuBuilder $menuBuilder, readonly AdminUrlGenerator $adminUrlGenerator)

QuotePipelineController::index()

public function index(): Response

Base\Marketplace\Controller\Admin\Crud

AttributeSetCrudController class

class AttributeSetCrudController extends AbstractMarketplaceCrudController AttributeSetCrudController.php:20

The typed sheets: for a kind of product (a taxon), its attributes in order, which are required, which the list filters on. The attributes themselves (their label in each language, their type, their unit) are omnibase's adapters.

AttributeSetCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

AttributeSetCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

AttributeSetCrudController::configureFields()

public function configureFields(string $pageName): iterable

BarcodeStandardCrudController class

class BarcodeStandardCrudController extends AdapterCrudController BarcodeStandardCrudController.php:14

The barcode standards products can be identified with (EAN-13, UPC...): one per standard, used by the product identifiers and the feeds.

BarcodeStandardCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

BarcodeStandardCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

BrandCrudController class

class BrandCrudController extends AbstractMarketplaceCrudController BrandCrudController.php:17

The brands: the estates and houses, the makers - their story, logo, place and pictures.

BrandCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

BrandCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

BrandCrudController::configureFields()

public function configureFields(string $pageName): iterable

ChannelCrudController class

class ChannelCrudController extends AbstractMarketplaceCrudController ChannelCrudController.php:19

The sales channels a product is published on (the storefront, a product feed, an export): a product appears where its channels say.

ChannelCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ChannelCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ChannelCrudController::configureFields()

public function configureFields(string $pageName): iterable

CouponCrudController class

class CouponCrudController extends AbstractMarketplaceCrudController CouponCrudController.php:23

Coupons: a code members type in their cart. A quota caps how many orders may use it (per member too), an owner reserves it to one member, and "individual use" keeps it from mixing with anything else.

CouponCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

CouponCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

CouponCrudController::configureFields()

public function configureFields(string $pageName): iterable

ExchangeRateCrudController class

class ExchangeRateCrudController extends AbstractMarketplaceCrudController ExchangeRateCrudController.php:28

The exchange rates (Forex) prices and promotions are converted with: one row per currency pair, set by hand or refreshed on demand - the refresh is the only way the shop reaches a rate provider (ExchangeRates: one request for every pair, Fixer's counted against its monthly quota), and only the creators may run it.

ExchangeRateCrudController::__construct()

public function __construct(readonly ExchangeRates $rates)

ExchangeRateCrudController::configureActions()

public function configureActions(Actions $actions): Actions

ExchangeRateCrudController::refreshRates()

public function refreshRates(): Response

One request for every pair; at most once an hour (ExchangeRates::MIN_INTERVAL).

ExchangeRateCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ExchangeRateCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ExchangeRateCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ExchangeRateCrudController::configureFields()

public function configureFields(string $pageName): iterable

FeatureCrudController class

class FeatureCrudController extends AbstractMarketplaceCrudController FeatureCrudController.php:21

The product features shown as badges (washable, made in France...): an icon or a picture, a label and a description per language. A feature products still carry cannot be deleted.

FeatureCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

FeatureCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

FeatureCrudController::isDeletable()

public function isDeletable(object $entity): bool

FeatureCrudController::configureFields()

public function configureFields(string $pageName): iterable

FeeCrudController class

class FeeCrudController extends AbstractMarketplaceCrudController FeeCrudController.php:18

Additional fees on an order (handling, small-order surcharge...): where they apply (scopes), when (rules) and how much (actions).

FeeCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

FeeCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

FeeCrudController::configureFields()

public function configureFields(string $pageName): iterable

InvoiceCrudController class

class InvoiceCrudController extends AbstractMarketplaceCrudController InvoiceCrudController.php:31

The shop's invoices and credit notes: read, never edited - an issued invoice does not change. Its actions: its PDF, sending it to its buyer, marking it paid, cancelling it by a credit note. An order's invoice is issued from the order (OrderCrudController's "Issue the invoice"), or by itself when the order is paid (marketplace.invoice.auto_issue).

With glitchr/omnibill, sending goes through its gateway: the screen shows where the invoice stands there (its lifecycle status), and asks again.

InvoiceCrudController::setInvoiceServices()

public function setInvoiceServices(Invoices $invoices, TranslatorInterface $translator): void

InvoiceCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

InvoiceCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

InvoiceCrudController::isDeletable()

public function isDeletable(object $entity): bool

InvoiceCrudController::configureCrud()

public function configureCrud(Crud $crud): Crud

InvoiceCrudController::configureActions()

public function configureActions(Actions $actions): Actions

InvoiceCrudController::new()

public function new(Request $request): Response

InvoiceCrudController::edit()

public function edit(Request $request, string $entityId): Response

InvoiceCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

InvoiceCrudController::configureFields()

public function configureFields(string $pageName): iterable

InvoiceCrudController::send()

public function send(string $entityId): Response

InvoiceCrudController::refresh()

public function refresh(string $entityId): Response

InvoiceCrudController::markPaid()

public function markPaid(string $entityId): Response

InvoiceCrudController::credit()

public function credit(string $entityId): Response

OptionGroupCrudController class

class OptionGroupCrudController extends AbstractMarketplaceCrudController OptionGroupCrudController.php:21

The options of the products: a group per choice the buyer makes (a cooking, extras, a finish) - one option or several, how many at least and at most - and its options, each with what it adds to the price.

OptionGroupCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

OptionGroupCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

OptionGroupCrudController::configureFields()

public function configureFields(string $pageName): iterable

OrderCrudController class

class OrderCrudController extends AbstractMarketplaceCrudController OrderCrudController.php:28

Admin view of the orders: a list and a detail page. Their state moves through the shop (cart, checkout, payment), so nothing here edits them.

OrderCrudController::setInvoiceServices()

public function setInvoiceServices(Invoices $invoices, TranslatorInterface $translator): void

OrderCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

OrderCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

OrderCrudController::configureActions()

public function configureActions(Actions $actions): Actions

Orders are born at checkout and move through it: the admin reads them.

Shipping, refunds and the like belong in dedicated actions, not in a form over the order's columns.

OrderCrudController::issueInvoice()

public function issueInvoice(string $entityId): Response

OrderCrudController::new()

public function new(Request $request): Response

A disabled action only loses its button in base-bundle-admin; the route itself still answers. Close both here.

OrderCrudController::edit()

public function edit(Request $request, string $entityId): Response

OrderCrudController::configureRecordNote()

public function configureRecordNote(object $entity): ?string

OrderCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

OrderCrudController::configureFields()

public function configureFields(string $pageName): iterable

PaymentMethodCrudController class

class PaymentMethodCrudController extends AbstractMarketplaceCrudController PaymentMethodCrudController.php:22

Admin CRUD for the payment methods offered at checkout. The gateway is the name() of a service tagged marketplace.payment_gateway ("manual" ships with the bundle; an application adds its own).

PaymentMethodCrudController::__construct()

public function __construct(readonly PaymentGatewayRegistry $gateways)

PaymentMethodCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

PaymentMethodCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

PaymentMethodCrudController::isDeletable()

public function isDeletable(object $entity): bool

A method orders were paid with stays: they point to it.

PaymentMethodCrudController::configureRecordNote()

public function configureRecordNote(object $entity): ?string

Whether its gateway is installed, and how many of its settings are filled (marketplace.gateways.<slug>).

PaymentMethodCrudController::configureFields()

public function configureFields(string $pageName): iterable

ProductCrudController class

class ProductCrudController extends AbstractMarketplaceCrudController ProductCrudController.php:23

Admin CRUD for the products. Prices are integers in the currency's smallest unit (cents, or one pepette); an empty stock means unlimited.

ProductCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ProductCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ProductCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ProductCrudController::configureFields()

public function configureFields(string $pageName): iterable

ProductIdentifierCrudController class

class ProductIdentifierCrudController extends AbstractMarketplaceCrudController ProductIdentifierCrudController.php:18

A product's codes (EAN, UPC...): what the marketplaces and feeds match it by. One identifier per product or variant, one barcode per standard.

ProductIdentifierCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ProductIdentifierCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ProductIdentifierCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ProductIdentifierCrudController::configureFields()

public function configureFields(string $pageName): iterable

ProductTaxonCrudController class

class ProductTaxonCrudController extends TaxonCrudController ProductTaxonCrudController.php:12

The product categories of a store: base-bundle's taxonomy, with the store they belong to.

ProductTaxonCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

PromotionCrudController class

class PromotionCrudController extends AbstractMarketplaceCrudController PromotionCrudController.php:21

Promotions run by themselves between two dates, highest priority first: an event, a sale. Rules say when they hold (a minimum total...), scopes which lines they touch (a store, a product...), actions what comes off.

PromotionCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

PromotionCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

PromotionCrudController::configureFields()

public function configureFields(string $pageName): iterable

QuoteCrudController class

class QuoteCrudController extends AbstractMarketplaceCrudController QuoteCrudController.php:43

The quotes asked from the site: price the lines (a product of the catalogue or a free line, by the lot), the terms (which way, the Incoterm and its place, the country), a discount and a date, then "Send" mails the client their link. The pipeline (QuotePipelineController) shows them by status.

QuoteCrudController::setQuoteSignatures()

public function setQuoteSignatures(?\Base\Marketplace\Quote\Signature\QuoteSignatures $signatures = null): void

The quotes signed in the page: with glitchr/omnisign only (the service does not exist without it).

QuoteCrudController::setQuoteServices()

public function setQuoteServices(MailerInterface $mailer, TranslatorInterface $translator, int $validity = 30): void

QuoteCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

QuoteCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

QuoteCrudController::configureCrud()

public function configureCrud(Crud $crud): Crud

QuoteCrudController::configureActions()

public function configureActions(Actions $actions): Actions

QuoteCrudController::configureFields()

public function configureFields(string $pageName): iterable

QuoteCrudController::createEntity()

public function createEntity(string $entityFqcn): object

QuoteCrudController::persistEntity()

public function persistEntity(EntityManagerInterface $entityManager, object $entity): void

Numbered when saved, not when the form opens: two forms open took the same number.

QuoteCrudController::send()

public function send(string $entityId): Response

Sent: the client gets their link by mail, and may accept it until its date.

RegionCrudController class

class RegionCrudController extends AbstractMarketplaceCrudController RegionCrudController.php:23

The regions a store sells to: their countries, currency and priority (the first region covering a visitor's country wins). A disabled region is kept but no longer offered. A region orders were placed in stays.

RegionCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

RegionCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

RegionCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

RegionCrudController::isDeletable()

public function isDeletable(object $entity): bool

RegionCrudController::configureFields()

public function configureFields(string $pageName): iterable

ReviewCrudController class

class ReviewCrudController extends AbstractMarketplaceCrudController ReviewCrudController.php:24

Customer reviews: the product and store they are about, their rating and pictures, and when they show (a review is a Thread: published or not).

ReviewCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ReviewCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ReviewCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ReviewCrudController::configureFields()

public function configureFields(string $pageName): iterable

ReviewTaxonCrudController class

class ReviewTaxonCrudController extends TaxonCrudController ReviewTaxonCrudController.php:12

The review categories of a store: base-bundle's taxonomy, with the store they belong to.

ReviewTaxonCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ShipmentCrudController class

class ShipmentCrudController extends AbstractMarketplaceCrudController ShipmentCrudController.php:20

The parcels sent for an order: their tracking number, method and the items they hold. Kept once sent - a shipment is not deleted.

ShipmentCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ShipmentCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ShipmentCrudController::isDeletable()

public function isDeletable(object $entity): bool

ShipmentCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ShipmentCrudController::configureFields()

public function configureFields(string $pageName): iterable

ShippingMethodCrudController class

class ShippingMethodCrudController extends AbstractMarketplaceCrudController ShippingMethodCrudController.php:22

Shipping methods offered at checkout for physical goods. Rate type RATE_FLAT costs the unit price once, RATE_PRIORITY per shipping unit; the tracking URL may hold {number}.

ShippingMethodCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ShippingMethodCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ShippingMethodCrudController::isDeletable()

public function isDeletable(object $entity): bool

A method orders were shipped with stays: they point to it.

ShippingMethodCrudController::configureRecordNote()

public function configureRecordNote(object $entity): ?string

The carrier behind it and how many of its settings are filled (omnibus.<slug>).

ShippingMethodCrudController::configureFields()

public function configureFields(string $pageName): iterable

StoreCrudController class

class StoreCrudController extends AbstractMarketplaceCrudController StoreCrudController.php:21

Admin CRUD for the stores: a name, the currency it trades in, open or shut.

StoreCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

StoreCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

StoreCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

StoreCrudController::isDeletable()

public function isDeletable(object $entity): bool

A store orders were placed in stays: they point to it.

StoreCrudController::configureFields()

public function configureFields(string $pageName): iterable

TaxRateCrudController class

class TaxRateCrudController extends AbstractMarketplaceCrudController TaxRateCrudController.php:19

Every tax, VAT rates included: a rate, and the scopes it applies to - a region, a store, a taxon, a product. One created here is an additional tax; VAT rates are created on their own screen (VatCrudController), the ones Pricing adds to each line.

TaxRateCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

TaxRateCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

TaxRateCrudController::configureFields()

public function configureFields(string $pageName): iterable

TransactionCrudController class

class TransactionCrudController extends AbstractMarketplaceCrudController TransactionCrudController.php:20

The payments recorded against orders, as the gateways reported them. A record of what happened: read, never written or deleted from here.

TransactionCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

TransactionCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

TransactionCrudController::configureActions()

public function configureActions(Actions $actions): Actions

TransactionCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

TransactionCrudController::configureFields()

public function configureFields(string $pageName): iterable

VatCrudController class

class VatCrudController extends TaxRateCrudController VatCrudController.php:13

The VAT rates, the taxes Pricing charges on each line (Service/Pricing.php reads Vat rows only): a rate and the scopes it applies to - the buyer's region, a product, a taxon. A rate created under "Taxes" is a plain Tax, which Pricing never reads: VAT is created here.

VatCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

VatCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

Base\Marketplace\Controller\Client

AgeGateController class

class AgeGateController extends AbstractController AgeGateController.php:17

The age gate's answer (@Marketplace/client/_age_gate.html.twig): yes keeps the age confirmed in a cookie and goes back to the page; no leaves for the page the application names (marketplace.age_gate: its home without the restricted products, or elsewhere).

AgeGateController::Answer()

public function Answer(Request $request, AgeGate $gate): RedirectResponse

AttachmentController class

class AttachmentController extends AbstractController AttachmentController.php:21

Downloading a file given with a quote request or an order line (Entity\Attachment). The files are private: the back office reads them (whoever may see the shop's screens), anybody else needs the signed link Service\Attachments::url() hands out.

AttachmentController::Download()

public function Download(Request $request, int $id, EntityManagerInterface $entityManager, Attachments $attachments, UriSigner $signer): Response

CartController class

class CartController extends AbstractController CartController.php:24

The carts and the checkout. Every change is a POST with a CSRF token; nothing needs JavaScript.

CartController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly Cart $cart, readonly Checkout $checkout, readonly TranslatorInterface $translator)

CartController::Index()

public function Index(Pricing $pricing): Response

CartController::Add()

public function Add(Request $request, int $id): Response

CartController::Update()

public function Update(Request $request, int $order, int $item): Response

CartController::Checkout()

public function Checkout(Request $request, int $order, Pricing $pricing, Shipping $shipping): Response

CartController::Files()

public function Files(Request $request, int $order, int $item, \Base\Marketplace\Service\Attachments $attachments): Response

The buyer's files for a line of their cart - the artwork of a printed item (Service\Attachments).

CompanyController class

class CompanyController extends AbstractController CompanyController.php:15

What the forms ask as a SIRET is typed: the company it names, to fill its name and show whether it trades - from the State's register (CompanyRegistry, through Omnistate), the answer kept a day.

CompanyController::lookup()

public function lookup(string $number, CompanyRegistry $registry): JsonResponse

CompanySearchController class

final class CompanySearchController extends CompanySearchController CompanySearchController.php:17

Omnistate's company search, GET /omnistate/company/search?q=: routed here so every shop has it without importing Omnistate's controllers (the Store form's company field asks it). Its route is the parent's.

For the back office only (MARKETPLACE_VIEW: creators and store owners): open, any visitor could search the State's register through the shop and spend its rate limit (about seven calls a second, per server).

CouponController class

class CouponController extends AbstractController CouponController.php:19

A coupon code entered in the cart, or taken back out.

CouponController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly Cart $cart, readonly Pricing $pricing, readonly TranslatorInterface $translator)

CouponController::Apply()

public function Apply(Request $request, int $order): Response

CouponController::Remove()

public function Remove(Request $request, int $order, int $coupon): Response

InvoiceController class

class InvoiceController extends AbstractController InvoiceController.php:20

An invoice, as its PDF (its Factur-X XML attached): for its buyer signed in, the back office (InvoiceVoter), or whoever holds its signed link (Invoices::signedUrl(), the one its e-mail carries).

InvoiceController::__construct()

public function __construct(readonly Invoices $invoices)

InvoiceController::Download()

public function Download(Request $request, string $number, UriSigner $signer): Response

InvoiceWebhookController class

class InvoiceWebhookController extends AbstractController InvoiceWebhookController.php:17

An approved platform's callback about an invoice it carries (glitchr/omnibill, omnibill.gateways.<gateway>: a gateway that takes webhooks): its signature checked by the gateway, the invoice's lifecycle status updated. Without glitchr/omnibill there is no transmission: 404.

InvoiceWebhookController::__construct()

public function __construct(readonly ?InvoiceTransmission $transmission = null)

InvoiceWebhookController::Webhook()

public function Webhook(Request $request, string $gateway): JsonResponse

OrderController class

class OrderController extends AbstractController OrderController.php:17

The member's orders - carts excluded - and one order's receipt.

OrderController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly PaginatorInterface $paginator, readonly int $perPage = 20)

OrderController::Index()

public function Index(Request $request): Response

OrderController::Show()

public function Show(string $reference): Response

PaymentController class

class PaymentController extends AbstractController PaymentController.php:31

Where a payment provider sends people and events back, for every omnitrade gateway: the buyer's return page and the webhook both settle the same transaction, found by the provider's reference; Checkout::confirm() is idempotent, so both may arrive.

PaymentController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly Checkout $checkout, readonly PaymentGatewayRegistry $gateways, readonly TranslatorInterface $translator, readonly ?EventDispatcherInterface $dispatcher = null)

PaymentController::Return()

public function Return(Request $request, int $order, string $gateway): Response

PaymentController::Webhook()

public function Webhook(Request $request, string $gateway): JsonResponse

PickupController class

class PickupController extends AbstractController PickupController.php:15

Following a hand-over (Entity\Order\Pickup) through its link, without an account: the token is the key. The orders made together share it and show on the same page.

PickupController::Track()

public function Track(string $token, PickupRepository $pickups): Response

QuickOrderController class

class QuickOrderController extends AbstractController QuickOrderController.php:37

A product bought in one step (Service\QuickOrder): the form of @Marketplace/client/_quick_order.html.twig (Form\QuickOrderType, guarded as glitchr/omnibase guards a form) posts an e-mail address here, the payment follows, and the buyer ends on the order's own page - a signed link, no account. The provider sends the buyer back to marketplace_payment_return, which expects its customer signed in: QuickOrderReturnListener hands the return of a quick order to back() here instead.

const SESSION = 'marketplace/quick_orders'

Session: the ids of the quick orders this visitor made.

QuickOrderController::__construct()

public function __construct(readonly QuickOrder $quickOrder, readonly EntityManagerInterface $entityManager, readonly TranslatorInterface $translator)

QuickOrderController::Buy()

public function Buy(Request $request, int $id, QuickOrderTwigExtension $forms): Response

QuickOrderController::Back()

public function Back(Request $request, int $order, string $gateway, PaymentGatewayRegistry $gateways, Checkout $checkout): Response

Back from the payment provider (QuickOrderReturnListener routes marketplace_payment_return here for a quick order).

QuickOrderController::Done()

public function Done(Request $request, string $reference, UriSigner $signer, EventDispatcherInterface $dispatcher): Response

QuoteController class

class QuoteController extends AbstractController QuoteController.php:54

Business quotes on the site: the form asking for one (from a product's page, from a cart that cannot go where it should, from a trade page), the quote read through its own link (/cotation/<token>), accepted - it becomes an order waiting in the client's carts (Service\QuoteToOrder) - or declined, and the client's quotes in their account.

With glitchr/omnisign and marketplace.quotes.signature, accepting a priced quote is signing it in the page (Quote\Signature\QuoteSignatures): the client goes to the provider's signing page and comes back to /cotation/<token>/signee, the quote accepted once the signature is completed; the signed quote and its evidence are downloaded from its page.

Under /cotation by default ("cotation", not "devis": omnibase/forge keeps /devis for a studio's); marketplace.quotes.path moves it - "devis" on a site without the forge.

QuoteController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly QuoteRepository $quotes, readonly TranslatorInterface $translator, readonly bool $enabled = true, readonly ?string $recipient = null, readonly bool $phone = true, readonly bool $attachments = true, readonly bool $consent = false, readonly ?QuoteSignatures $signatures = null)

QuoteController::Request()

public function Request(Request $request, MailerInterface $mailer, CompanyRegistry $registry, VatNumbers $vatNumbers, Attachments $files): Response

QuoteController::Show()

public function Show(string $token, QuoteToOrder $quoteToOrder): Response

QuoteController::Accept()

public function Accept(Request $request, string $token, QuoteToOrder $quoteToOrder): Response

QuoteController::Signed()

public function Signed(string $token): Response

Back from the provider's signing page: the quote accepted once signed, open again when declined or expired.

QuoteController::SignatureFile()

public function SignatureFile(string $token, string $kind): Response

The signed quote ("document") or its evidence ("preuve"): for its client and the shop's staff.

QuoteController::Decline()

public function Decline(Request $request, string $token): Response

QuoteController::Mine()

public function Mine(): Response

ShipmentController class

class ShipmentController extends AbstractController ShipmentController.php:27

The staff side of posting goods: the orders waiting to leave, each with its address, and the two steps - shipped (with the tracking number) and delivered. The member follows both on their order page.

A screen of the back office: under /admin, in its layout with its menus, and nestable (X-Transparent-Nest) like every admin page - not a page of the shop. Its first address, /commandes/a-expedier, leads there.

ShipmentController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly Shipping $shipping, readonly TranslatorInterface $translator, readonly AdminContext $adminContext, readonly MenuBuilder $menuBuilder)

ShipmentController::Queue()

public function Queue(): Response

ShipmentController::LegacyQueue()

public function LegacyQueue(): Response

The queue's address before it moved into the back office: bookmarks and old links still land.

ShipmentController::Ship()

public function Ship(Request $request, string $reference): Response

ShipmentController::Deliver()

public function Deliver(Request $request, string $reference): Response

StoreController class

class StoreController extends AbstractController StoreController.php:21

Browsing: the stores, a store's shelf, a product. Route names are marketplace_*; the paths are French, as the Chapaland site is - an application wanting others overrides the routes, not the controller.

StoreController::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly PaginatorInterface $paginator, readonly Cart $cart, readonly int $perPage = 24)

StoreController::Stores()

public function Stores(): Response

StoreController::Store()

public function Store(Request $request, string $slug): Response

StoreController::Product()

public function Product(string $store, string $slug): Response

SupplyController class

class SupplyController extends AbstractController SupplyController.php:22

The suppliers' side: the page a partner workshop reaches from its brief's signed link - what to make, and a form to accept, say where it stands and give the tracking -, and the webhook of the suppliers that have one.

SupplyController::__construct()

public function __construct(readonly Supply $supply)

SupplyController::Offline()

public function Offline(Request $request, UriSigner $signer, string $reference): Response

SupplyController::Webhook()

public function Webhook(Request $request, SupplierRegistry $suppliers, string $supplier): JsonResponse

Base\Marketplace\DependencyInjection

MarketplaceConfiguration class

class MarketplaceConfiguration extends AbstractBaseConfiguration MarketplaceConfiguration.php:8

MarketplaceConfiguration::getConfigTreeBuilder()

public function getConfigTreeBuilder(): TreeBuilder

MarketplaceExtension class

class MarketplaceExtension extends AbstractBaseExtension implements PrependExtensionInterface MarketplaceExtension.php:18

const ENUMS = [OrderState::class, PaymentState::class, ProductAvailability::class, ShippingRate::class, Barcode::class]

The bundle's enums, registered as the Doctrine column types its entities name.

MarketplaceExtension::getConfiguration()

public function getConfiguration(array $config, ContainerBuilder $container): MarketplaceConfiguration

MarketplaceExtension::prepend()

public function prepend(ContainerBuilder $container): void

Two things the host would otherwise have to declare by hand:

• the enum column types, registered with DBAL the way base-bundle registers its own (a type discovered late is a column missing from the schema);
• this bundle's attribute directory (#[OrderReference]), added to the paths base-bundle's AttributeReader scans.

MarketplaceExtension::load()

public function load(array $configs, ContainerBuilder $container): void

Base\Marketplace\Entity

Attachment class

class Attachment implements Stringable Attachment.php:16

A file somebody gave the shop: with a quote request (a logo, a photo of the shopfront, a plan), or for an order line (the artwork of a printed item). Kept outside the public directory (marketplace.attachments.directory) under a name nobody chose; read through the back office, or through a signed link (Service\Attachments).

Attachment::__construct()

public function __construct(string $path, string $name, string $mimeType = 'application/octet-stream', int $size = 0)

Attachment::__toString()

public function __toString(): string

Attachment::getId()

public function getId(): ?int

Attachment::getQuote()

public function getQuote(): ?Quote

Attachment::setQuote()

public function setQuote(?Quote $quote): self

Attachment::getOrderItem()

public function getOrderItem(): ?OrderItem

Attachment::setOrderItem()

public function setOrderItem(?OrderItem $orderItem): self

Attachment::getPath()

public function getPath(): string

Attachment::getName()

public function getName(): string

Attachment::getMimeType()

public function getMimeType(): string

Attachment::getSize()

public function getSize(): int

Attachment::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Attachment::isImage()

public function isImage(): bool

Brand class

class Brand extends Thread implements TranslatableInterface, LinkableInterface Brand.php:26

Who makes a product: a wine estate or a négociant house, a brewery, a maker. A thread - its title the name, its content the story (translated like any thread) - with a logo, where it is (country, region), a gallery, its own site, and its products (Product::$brand).

It is what Shopify calls a product's vendor and WooCommerce its brand: the catalogue synchronisation (Catalogue\PlatformSynchronizer) files a platform's product under the brand of that name.

Brand::__iconizeStatic()

public static function __iconizeStatic(): ?array

Brand::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

The application names the page of a brand: marketplace.brand_route (none: no link).

Brand::__construct()

public function __construct(?string $name = null)

Brand::getProducts()

public function getProducts(): Collection

Brand::getLogo()

public function getLogo()

Brand::getLogoFile()

public function getLogoFile()

Brand::setLogo()

public function setLogo($logo): self

Brand::getGallery()

public function getGallery(): array

The pictures of the place: the vineyard, the cellar, the people.

Brand::setGallery()

public function setGallery($gallery): self

Brand::getCountry()

public function getCountry(): ?string

Brand::setCountry()

public function setCountry(?string $country): self

Brand::getRegion()

public function getRegion(): ?string

Brand::setRegion()

public function setRegion(?string $region): self

Brand::getWebsite()

public function getWebsite(): ?string

Brand::setWebsite()

public function setWebsite(?string $website): self

Credit class

class Credit Credit.php:19

A line of somebody's credit ledger, of one kind ("ai": answers of an assistant, "stationery": cents of print, "hour": hours of work...): a positive quantity credits (a pack bought, a plan's allowance, a gift), a negative one spends. The balance is the sum (Service\Credits); a credit with an expiry stops counting then, what was spent before stays spent.

Generic on purpose: a bundle keeps its units here under its own kind rather than in a ledger of its own.

Credit::__construct()

public function __construct(User $holder, string $kind, int $quantity, ?string $reason = null, ?\DateTimeImmutable $expiresAt = null)

Credit::getId()

public function getId(): ?int

Credit::getHolder()

public function getHolder(): ?User

Credit::getKind()

public function getKind(): string

Credit::getQuantity()

public function getQuantity(): int

Credit::isGrant()

public function isGrant(): bool

Credit::getReason()

public function getReason(): ?string

Credit::getOrderReference()

public function getOrderReference(): ?string

Credit::setOrderReference()

public function setOrderReference(?string $orderReference): self

Credit::getResourceType()

public function getResourceType(): ?string

Credit::getResourceId()

public function getResourceId(): ?string

Credit::setResource()

public function setResource(?string $type, int|string|null $id): self

Credit::getExpiresAt()

public function getExpiresAt(): ?\DateTimeImmutable

Credit::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Entitlement class

class Entitlement implements Stringable Entitlement.php:28

A right somebody holds: what a plan bought gives (its grants: limits, switches, rates), from when until when, and where it comes from (the product, the order's reference, the subscription that carries it).

Generic on purpose - any bundle hangs its own rights here rather than keeping a table of its own:

• a plan of a platform: code "plan-b", grants {"events.major": 1, "guests": 150, "list": true}, no resource;
• an access to one thing (a course, a download): code "course", the resource named (resourceType "classroom_course", resourceId "42"), no grants needed - holding it is the right;
• anything granted by hand (a gift, a partner): no product, no order.

Counted grants are consumed through Entity\Usage; Service\Entitlements answers "may they?" and "how many are left?".

Entitlement::__construct()

public function __construct(User $holder, string $code, array $grants = [], ?\DateTimeImmutable $expiresAt = null, ?\DateTimeImmutable $startsAt = null)

Entitlement::__toString()

public function __toString(): string

Entitlement::getId()

public function getId(): ?int

Entitlement::getHolder()

public function getHolder(): ?User

Entitlement::getCode()

public function getCode(): string

Entitlement::getGrants()

public function getGrants(): array

Entitlement::setGrants()

public function setGrants(array $grants): self

Entitlement::getGrant()

public function getGrant(string $key, mixed $default = null): mixed

Entitlement::getLevel()

public function getLevel(): int

Entitlement::setLevel()

public function setLevel(int $level): self

Entitlement::getResourceType()

public function getResourceType(): ?string

Entitlement::getResourceId()

public function getResourceId(): ?string

Entitlement::setResource()

public function setResource(?string $type, int|string|null $id): self

Entitlement::isFor()

public function isFor(?string $type, int|string|null $id): bool

Entitlement::getProduct()

public function getProduct(): ?Product

Entitlement::setProduct()

public function setProduct(?Product $product): self

Entitlement::getOrderReference()

public function getOrderReference(): ?string

Entitlement::setOrderReference()

public function setOrderReference(?string $orderReference): self

Entitlement::getSubscription()

public function getSubscription(): ?Subscription

Entitlement::setSubscription()

public function setSubscription(?Subscription $subscription): self

Entitlement::getStartsAt()

public function getStartsAt(): \DateTimeImmutable

Entitlement::getExpiresAt()

public function getExpiresAt(): ?\DateTimeImmutable

Entitlement::setExpiresAt()

public function setExpiresAt(?\DateTimeImmutable $expiresAt): self

Entitlement::getRevokedAt()

public function getRevokedAt(): ?\DateTimeImmutable

Entitlement::revoke()

public function revoke(?\DateTimeImmutable $at = null): self

Entitlement::getEndedAt()

public function getEndedAt(): ?\DateTimeImmutable

Entitlement::markEnded()

public function markEnded(): self

Entitlement::getRemindedAt()

public function getRemindedAt(): ?\DateTimeImmutable

Entitlement::markReminded()

public function markReminded(): self

Entitlement::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Entitlement::isActive()

public function isActive(?\DateTimeImmutable $at = null): bool

Held at that moment: started, not revoked, not expired, its subscription (if any) running.

Invoice class

class Invoice Invoice.php:25

An invoice of the shop, or a credit note (avoir): what was sold, to whom, by whom, for how much - written once, when it is issued (Service\Invoices::issue(), ::credit()), and never again.

Its number is the next of a sequence without a gap, one per series and year (F-2026-000041; A-2026-000003 for a credit note). The seller and the buyer are copied onto it as they are that day (name, address, SIREN, SIRET, VAT number), and so are its lines and amounts, taken from the order (its VAT included: the order computed it). What follows - sent, paid, cancelled by a credit note - is its state; nothing else of it changes: Doctrine refuses the update. A correction is a credit note, then a new invoice.

Amounts are integers in the currency's smallest unit, as the order's.

const TYPE_INVOICE = 'invoice'

const TYPE_CREDIT_NOTE = 'credit_note'

const STATE_ISSUED = 'issued'

const STATE_SENT = 'sent'

const STATE_PAID = 'paid'

const STATE_CANCELLED = 'cancelled'

const MUTABLE = ['state', 'sentAt', 'paidAt', 'cancelledAt', 'creditNote']

What may still change once issued: where it stands.

Invoice::__construct()

public function __construct(string $type, string $series, int $year, int $sequence, string $number, \DateTimeImmutable $issuedAt, ?Order $order, string $currency, array $seller, array $buyer, array $lines, array $totals, array $mentions = [], ?\DateTimeImmutable $soldAt = null, ?\DateTimeImmutable $dueAt = null, ?Invoice $credited = null)

Invoice::__toString()

public function __toString(): string

Invoice::refuseChanges()

public function refuseChanges(PreUpdateEventArgs $event): void

Issued, nothing but its state changes: an update of anything else is refused.

Invoice::getId()

public function getId(): ?int

Invoice::getType()

public function getType(): string

Invoice::isCreditNote()

public function isCreditNote(): bool

Invoice::getSeries()

public function getSeries(): string

Invoice::getYear()

public function getYear(): int

Invoice::getSequence()

public function getSequence(): int

Invoice::getNumber()

public function getNumber(): string

Invoice::getIssuedAt()

public function getIssuedAt(): \DateTimeImmutable

Invoice::getSoldAt()

public function getSoldAt(): ?\DateTimeImmutable

Invoice::getDueAt()

public function getDueAt(): ?\DateTimeImmutable

Invoice::getOrder()

public function getOrder(): ?Order

Invoice::getOrderReference()

public function getOrderReference(): ?string

Invoice::getCredited()

public function getCredited(): ?Invoice

Invoice::getCreditNote()

public function getCreditNote(): ?Invoice

Invoice::getCurrency()

public function getCurrency(): string

Invoice::getSeller()

public function getSeller(): array

Invoice::getBuyer()

public function getBuyer(): array

Invoice::getLines()

public function getLines(): array

Invoice::getTotals()

public function getTotals(): array

Invoice::getTotal()

public function getTotal(): int

Invoice::getMentions()

public function getMentions(): array

Invoice::getState()

public function getState(): string

Invoice::isCancelled()

public function isCancelled(): bool

Invoice::isPaid()

public function isPaid(): bool

Invoice::getSentAt()

public function getSentAt(): ?\DateTimeImmutable

Invoice::getPaidAt()

public function getPaidAt(): ?\DateTimeImmutable

Invoice::getCancelledAt()

public function getCancelledAt(): ?\DateTimeImmutable

Invoice::markSent()

public function markSent(\DateTimeImmutable $at = new \DateTimeImmutable()): static

Invoice::markPaid()

public function markPaid(\DateTimeImmutable $at = new \DateTimeImmutable()): static

Invoice::cancelBy()

public function cancelBy(Invoice $creditNote, \DateTimeImmutable $at = new \DateTimeImmutable()): static

Cancelled by that credit note: Service\Invoices::credit().

Order class

class Order implements IconizeInterface, LinkableInterface Order.php:33

Order::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Order::__iconize()

public function __iconize(): ?array

Order::__iconizeStatic()

public static function __iconizeStatic(): ?array

Order::__toString()

public function __toString(): string

Order::__construct()

public function __construct(?Store $store = null)

Order::getId()

public function getId()

Order::getManager()

public function getManager(): ?MerchantInterface

Order::getManagers()

public function getManagers(): Collection

Order::addManager()

public function addManager(MerchantInterface $manager): self

Order::removeManager()

public function removeManager(MerchantInterface $manager): self

Order::getReference()

public function getReference()

Order::getStore()

public function getStore(): ?Store

Order::setStore()

public function setStore(?Store $store): self

Order::getCustomer()

public function getCustomer(): ?User

Order::isCustomer()

public function isCustomer(mixed $user): bool

Whether $user is this order's customer. Compared by id, never by instance: the order and the logged-in member can come out of the second-level cache as two objects for the same row.

Order::setCustomer()

public function setCustomer(?User $customer): self

Order::getState()

public function getState(): string

Order::setState()

public function setState(string $state): self

Order::markAsConfirmed()

public function markAsConfirmed(): self

Order::markAsBeingProcessed()

public function markAsBeingProcessed(): self

Order::markAsPending()

public function markAsPending(): self

Order::markAsShipped()

public function markAsShipped(): self

Order::markAsCompleted()

public function markAsCompleted(): self

Order::markAsCancelled()

public function markAsCancelled(): self

Order::markAsRefunded()

public function markAsRefunded(): self

Order::markAsCart()

public function markAsCart(): self

Order::markAsAbandoned()

public function markAsAbandoned(): self

Order::getShipments()

public function getShipments(): Collection

Order::addShipment()

public function addShipment(Shipment $shipment): self

Order::removeShipment()

public function removeShipment(Shipment $shipment): self

Order::isEmpty()

public function isEmpty(): bool

Order::getUniqueProducts()

public function getUniqueProducts(): array

Every distinct product in this order.

Generic again, as the commented-out original beside it always was: the filter that had been added here kept only Wallpapers, which made the name a lie everywhere except one shop and was the reason Order could not move into a bundle. Callers that really do want one kind say so, with getUniqueProductsOf() below.

Order::getUniqueProductsOf()

public function getUniqueProductsOf(string $class): array

Order::getItem()

public function getItem(int $i): ?OrderItem

Order::getItems()

public function getItems(): Collection

Order::getAttachments()

public function getAttachments(): array

Returns

the files the buyer gave for its lines

Order::addItem()

public function addItem(OrderItem $item): self

Order::removeItem()

public function removeItem(OrderItem $item): self

Order::getCreatedAt()

public function getCreatedAt(): ?\DateTimeInterface

Order::getUpdatedAt()

public function getUpdatedAt(): ?\DateTimeInterface

Order::getPaidAt()

public function getPaidAt(): ?\DateTimeInterface

Order::getRegion()

public function getRegion(): ?Region

Order::setRegion()

public function setRegion(?Region $region): self

Order::getPaymentMethod()

public function getPaymentMethod(): ?PaymentMethod

Order::setPaymentMethod()

public function setPaymentMethod(?PaymentMethod $paymentMethod): self

Order::getShippingMethod()

public function getShippingMethod(): ?ShippingMethod

Order::setShippingMethod()

public function setShippingMethod(?ShippingMethod $shippingMethod): self

Order::getShippingUnits()

public function getShippingUnits(): int

Order::notify()

public function notify(): ?bool

Order::setNotify()

public function setNotify(bool $notify): self

Order::getDiscounts()

public function getDiscounts(): Collection

Order::getCoupons()

public function getCoupons(): array

Order::getPromotions()

public function getPromotions(): array

Order::addDiscount()

public function addDiscount(Discount $discount): self

Order::removeDiscount()

public function removeDiscount(Discount $discount): self

Order::getAdditionalFees()

public function getAdditionalFees(): Collection

Order::addAdditionalFee()

public function addAdditionalFee(Fee $additionalFee): self

Order::removeAdditionalFee()

public function removeAdditionalFee(Fee $additionalFee): self

Order::getAdditionalTaxes()

public function getAdditionalTaxes(): Collection

Order::addAdditionalTax()

public function addAdditionalTax(Tax $additionalTax): self

Order::removeAdditionalTax()

public function removeAdditionalTax(Tax $additionalTax): self

Order::isPaid()

public function isPaid()

Order::isCompleted()

public function isCompleted()

Order::isReviewed()

public function isReviewed()

Order::isAbandoned()

public function isAbandoned()

Order::isConfirmed()

public function isConfirmed()

Order::isBeingProcessed()

public function isBeingProcessed()

Order::isCancelled()

public function isCancelled()

Order::isRefunded()

public function isRefunded()

Order::isBeingShipped()

public function isBeingShipped()

Order::isPending()

public function isPending()

Order::isDelayed()

public function isDelayed()

Order::isBeingReturned()

public function isBeingReturned()

Order::isReturned()

public function isReturned()

Order::getArrivingTime()

public function getArrivingTime()

Order::getCurrency()

public function getCurrency(): string

Order::setCurrency()

public function setCurrency(string $currency)

Order::getGrossPrice()

public function getGrossPrice(): int

Order::getSalePrice()

public function getSalePrice(): int

Order::getVatCharge()

public function getVatCharge(): int

Order::getVatExemption()

public function getVatExemption(): ?string

Order::setVatExemption()

public function setVatExemption(?string $vatExemption): self

Order::isVatExempt()

public function isVatExempt(): bool

Order::getQuoteReference()

public function getQuoteReference(): ?string

Order::setQuoteReference()

public function setQuoteReference(?string $quoteReference): self

Order::isQuoted()

public function isQuoted(): bool

Order::getNetPrice()

public function getNetPrice(): int

Order::getTotalPaid()

public function getTotalPaid(): int

Order::getBalanceDue()

public function getBalanceDue(): int

Order::getAdditionalTaxCharge()

public function getAdditionalTaxCharge(): int

Order::setAdditionalTaxCharge()

public function setAdditionalTaxCharge(float|int $additionalTaxCharge, ?string $currency = null): self

Order::getShippingCharge()

public function getShippingCharge(): int

Order::setShippingCharge()

public function setShippingCharge(float|int $shippingCharge, ?string $currency = null): self

Order::getServiceCharge()

public function getServiceCharge(): int

Order::setServiceCharge()

public function setServiceCharge(float|int $serviceCharge, ?string $currency = null): self

Order::getDiscountCharge()

public function getDiscountCharge(): int

Order::setDiscountCharge()

public function setDiscountCharge(float|int $discountCharge, ?string $currency = null): self

Order::getBillingAddress()

public function getBillingAddress(): ?BillingAddress

Order::setBillingAddress()

public function setBillingAddress(?BillingAddress $billingAddress): self

Order::getShippingAddress()

public function getShippingAddress(): ?ShippingAddress

Order::setShippingAddress()

public function setShippingAddress(?ShippingAddress $shippingAddress): self

Order::getReviews()

public function getReviews(): Collection

Order::addReview()

public function addReview(Review $review): self

Order::removeReview()

public function removeReview(Review $review): self

Order::isAbandonable()

public function isAbandonable(): bool

Order::getAbandonDelay()

public static function getAbandonDelay(): int

Order::getAbandonTime()

public function getAbandonTime(): ?int

Order::getAbandonTimeStr()

public function getAbandonTimeStr(): ?string

Order::isDeletable()

public function isDeletable(): bool

Order::getDeleteDelay()

public static function getDeleteDelay(): int

Order::getDeleteTime()

public function getDeleteTime(): ?int

Order::getDeleteTimeStr()

public function getDeleteTimeStr(): ?string

Order::getTransactions()

public function getTransactions(): Collection

Order::addTransaction()

public function addTransaction(Transaction $transaction): self

Order::markAsPaidAt()

public function markAsPaidAt(?\DateTimeInterface $at = null): self

When the money came in. Set by the checkout once a gateway says so - attaching a transaction is not being paid: a bank transfer is attached the day it is announced and paid the day it arrives.

Order::removeTransaction()

public function removeTransaction(Transaction $transaction): self

Product class

class Product extends Thread implements TranslatableInterface, AutocompleteInterface, LinkableInterface, ShippingUnitInterface Product.php:48

const INHERITS_FROM = true

Product::__toKey()

public function __toKey(mixed ...$variadic): string

Product::__typesense()

public function __typesense(): ?string

Product::__iconize()

public function __iconize(): ?array

Product::__iconizeStatic()

public static function __iconizeStatic(): ?array

Product::__autocomplete()

public function __autocomplete(): string

Product::__autocompleteData()

public function __autocompleteData(): array

Product::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Product::getRouteIdentifierClass()

public function getRouteIdentifierClass(): string

Which class this product is ROUTED as, which is not always the class it is.

A product whose route is its own (a wallpaper, a book) answers with itself and needs nothing here. One that is a satellite of another - a free sample, a bundle, a made-to-measure cut - overrides this to name the class whose route it should appear under, so it does not need a route of its own.

Exists so Review (and anything else building a product route) can stop switching on concrete product classes. That switch is what tied the marketplace to one shop's catalogue and kept it out of a bundle.

Product::__toString()

public function __toString()

Product::__construct()

public function __construct(?MerchantInterface $merchant = null, ?Store $store = null, int $unitPrice = 0, ?string $currency = null)

Product::getHeadline()

public function getHeadline(?string $locale = null, int $inheritanceDepthIfNotSet = 0): ?string

Product::getCategories()

public function getCategories(): ?array

Product::getBrands()

public function getBrands(): ?array

Product::getReference()

public function getReference(int $chrLength = 3, int $numLength = 4): ?string

Product::setStore()

public function setStore(?Store $store)

Product::getStore()

public function getStore(): ?Store

Product::isShippable()

public function isShippable(): bool

Something to send: goods. A plan or a pack of credits is delivered as a right, with no address asked.

Product::getMaxQuantity()

public function getMaxQuantity(): ?int

Product::isVariant()

public static function isVariant()

Product::getVariants()

public function getVariants(): Collection

Product::addVariant()

public function addVariant(Product $variant): self

Product::removeVariant()

public function removeVariant(Product $variant): self

Product::removeAllVariants()

public function removeAllVariants(): self

Product::getPriceRange()

public function getPriceRange(): array

The lowest and the highest price it sells at: its variants' still for sale when it has some (a banner by the square metre, a print by the hundred), its own otherwise. Smallest unit, before VAT.

Product::getPriceFrom()

public function getPriceFrom(): ?int

Product::setPriceFrom()

public function setPriceFrom(?int $priceFrom): self

Product::getStartingPrice()

public function getStartingPrice(): ?int

The price a list shows: the one typed (priceFrom), else the lowest of its range. Null when there is none to show: no price was ever written (nor on a variant), or a product of its own kind has an empty range - a list says "on request" then, never a price of zero.

Product::isPricedFrom()

public function isPricedFrom(): bool

Whether that price is a "from": typed as one, or the lowest of several.

Product::getPrice()

public function getPrice()

Product::getUnitPrice()

public function getUnitPrice(): ?int

Product::setUnitPrice()

public function setUnitPrice(?int $unitPrice): self

A form sent with its price left empty gives null: taken as it is, for the validation to say so (NotNull) rather than a type error to stop the page.

Product::getCurrency()

public function getCurrency(): ?string

Product::setCurrency()

public function setCurrency(string $currency): self

Product::getColors()

public function getColors(): array

Product::getWeight()

public function getWeight(): ?int

Product::getWeightUnit()

public function getWeightUnit(): ?string

Product::getWidth()

public function getWidth(): ?int

Product::getWidthUnit()

public function getWidthUnit(): ?string

Product::getHeight()

public function getHeight(): ?int

Product::getHeightUnit()

public function getHeightUnit(): ?string

Product::getLength()

public function getLength(): ?int

Product::getLengthUnit()

public function getLengthUnit(): ?string

Product::getDimensions()

public function getDimensions(): array

Product::getShippingUnits()

public function getShippingUnits(): float

Product::getStock()

public function getStock(): ?int

Product::setStock()

public function setStock(?int $stock): self

Product::isForSell()

public function isForSell()

Product::getAvailability()

public function getAvailability()

Product::setAvailability()

public function setAvailability($availability): self

An availability is never nothing (the column refuses null): given none, the product keeps the one it had - in stock for a new one. The back office's select is filled by a script; a form sent without it carries no value, and the insertion stopped on "Column 'availability' cannot be null".

Product::getAttributes()

public function getAttributes(?string $code = null, ?string $abstractAttributeClassName = null): Collection

Product::getAttribute()

public function getAttribute(string $code, ?string $abstractAttributeClassName = null): ?Attribute

Product::addAttribute()

public function addAttribute(Attribute $attribute): self

Product::removeAttribute()

public function removeAttribute(Attribute $attribute): self

Product::getExports()

public function getExports(?string $code = null): Collection

Product::getExport()

public function getExport(string $code): mixed

Product::addExport()

public function addExport(Hyperlink $attribute): self

Product::removeExport()

public function removeExport(Hyperlink $attribute): self

Product::getFeatures()

public function getFeatures(): Collection

Product::addFeature()

public function addFeature(Feature $feature): self

Product::removeFeature()

public function removeFeature(Feature $feature): self

Product::getOrderItems()

public function getOrderItems(): Collection

Product::addOrderItem()

public function addOrderItem(OrderItem $orderItem): self

Product::removeOrderItem()

public function removeOrderItem(OrderItem $orderItem): self

Product::getIdentifiers()

public function getIdentifiers(): Collection

Product::getSku()

public function getSku(): ?string

Its stock keeping unit: the SKU among its identifiers' barcodes, or null. What a payment provider's line item names (Payment\Omnitrade\OmnitradeGateway) - a product sold without one (a licence, an hour pack) has none.

Product::addIdentifier()

public function addIdentifier(Identifier $identifier): self

Product::getAuthor()

public function getAuthor(int $i = 0)

Product::getAuthors()

public function getAuthors(): Collection

The owners that count as authors of this product.

Not every owner is one - a product is owned by the merchant selling it as well as by whoever created it - so this filters, and getAuthorClass() below decides on what. It used to filter on instanceof Artist, a class belonging to one shop, which is what kept Product out of a bundle.

Product::getOwnersOf()

public function getOwnersOf(string $class): Collection

Product::getEAN()

public function getEAN(): ?string

Product::getBarcodes()

public function getBarcodes(string $std): Collection

Product::removeIdentifier()

public function removeIdentifier(Identifier $identifier): self

Product::getImage()

public function getImage(?int $i = null): ?Image

Product::getImages()

public function getImages(): Collection

Product::getImageCrop()

public function getImageCrop(string $slug, ?int $i = null): ?ImageCrop

Product::addImage()

public function addImage(Image $image): self

Product::removeImage()

public function removeImage(Image $image): self

Product::getImageMarketplaces()

public function getImageMarketplaces()

Product::getImageMarketplaceFiles()

public function getImageMarketplaceFiles()

Product::setImageMarketplaces()

public function setImageMarketplaces($imageMarketplaces)

Product::getReviews()

public function getReviews(): Collection

Product::addReview()

public function addReview(Review $review): self

Product::removeReview()

public function removeReview(Review $review): self

Product::getChannels()

public function getChannels(): Collection

Product::addChannel()

public function addChannel(Channel $channel): self

Product::removeChannel()

public function removeChannel(Channel $channel): self

Product::getBrand()

public function getBrand(): ?Brand

Product::setBrand()

public function setBrand(?Brand $brand): self

Product::getPackSize()

public function getPackSize(): int

Product::getOwnPackSize()

public function getOwnPackSize(): ?int

Product::setPackSize()

public function setPackSize(?int $packSize): self

Product::getMinimumQuantity()

public function getMinimumQuantity(): int

Product::getOwnMinimumQuantity()

public function getOwnMinimumQuantity(): ?int

Product::setMinimumQuantity()

public function setMinimumQuantity(?int $minimumQuantity): self

Product::boundQuantity()

public function boundQuantity(int $wanted, ?int $max = null): int

A quantity a cart may hold of it: at least the minimum, a whole number of lots, at most $max (the shop's cart_max_quantity, the stock) rounded down to the lot. 0 when not even the minimum fits under $max.

Product::getKind()

public function getKind(): \Base\Marketplace\Enum\ProductKind

Product::setKind()

public function setKind(\Base\Marketplace\Enum\ProductKind|string $kind): self

Product::isPlan()

public function isPlan(): bool

Product::isCreditPack()

public function isCreditPack(): bool

Product::getPlan()

public function getPlan(): ?array

Product::setPlan()

public function setPlan(\Base\Marketplace\Model\PlanTerms|array|null $plan): self

Product::getPlanTerms()

public function getPlanTerms(): \Base\Marketplace\Model\PlanTerms

Product::getSupplier()

public function getSupplier(): ?string

Product::setSupplier()

public function setSupplier(?string $supplier): self

Product::getSupplierReference()

public function getSupplierReference(): ?string

Product::setSupplierReference()

public function setSupplierReference(?string $supplierReference): self

Product::isAgeRestricted()

public function isAgeRestricted(): bool

Product::getAgeRestricted()

public function getAgeRestricted(): bool

Product::setAgeRestricted()

public function setAgeRestricted(bool $ageRestricted): self

Product::getAssociations()

public function getAssociations(?AssociationType $type = null): Collection

Product::addAssociation()

public function addAssociation(Association $association): self

Product::removeAssociation()

public function removeAssociation(Association $association): self

Product::associate()

public function associate(Product $target, AssociationType $type = AssociationType::PAIRING, array $notes = []): Association

A pairing, a cross-sell or an upsell to another product, with its note by language.

Product::getOptionGroups()

public function getOptionGroups(): Collection

Returns

its own; a variant without any offers its principal's

Product::hasOptions()

public function hasOptions(): bool

Product::addOptionGroup()

public function addOptionGroup(OptionGroup $group): self

Product::removeOptionGroup()

public function removeOptionGroup(OptionGroup $group): self

Product::getAttributeValue()

public function getAttributeValue(string $code, ?string $locale = null): mixed

Its attribute of this code (an AttributeSet's field), resolved in a language: "Margaux", 13.5, ["Merlot", "Cabernet sauvignon"]. A variant without it reads its principal's.

Quote class

class Quote extends AbstractQuote Quote.php:23

A business quote: a professional buyer asks (the quote form), the seller prices lines - a product of the catalogue or a free line, by the lot - with the terms of the trade (which way, which Incoterm, to which country and place, for when), sends it, the buyer accepts it in their account, and it becomes an order paid like any other (Service\QuoteToOrder). An export's order carries no VAT (Pricing\ExportExemption).

Quote::__construct()

public function __construct(string $reference = '')

Quote::getCompanyName()

public function getCompanyName(): ?string

Quote::setCompanyName()

public function setCompanyName(?string $companyName): static

Quote::getPhone()

public function getPhone(): ?string

Quote::setPhone()

public function setPhone(?string $phone): static

Quote::getAttachments()

public function getAttachments(): Collection

Quote::addAttachment()

public function addAttachment(Attachment $attachment): static

Quote::getVatNumber()

public function getVatNumber(): ?string

Quote::setVatNumber()

public function setVatNumber(?string $vatNumber): static

Quote::getDirection()

public function getDirection(): ?TradeDirection

Quote::setDirection()

public function setDirection(?TradeDirection $direction): static

Quote::getIncoterm()

public function getIncoterm(): ?Incoterm

Quote::setIncoterm()

public function setIncoterm(?Incoterm $incoterm): static

Quote::getPlace()

public function getPlace(): ?string

Quote::setPlace()

public function setPlace(?string $place): static

Quote::getTerms()

public function getTerms(): ?string

"FOB Le Havre", "DAP Tokyo": the Incoterm and its place, as a contract writes them.

Quote::getCountry()

public function getCountry(): ?string

Quote::setCountry()

public function setCountry(?string $country): static

Quote::getDeliveryAddress()

public function getDeliveryAddress(): ?string

Quote::setDeliveryAddress()

public function setDeliveryAddress(?string $deliveryAddress): static

Quote::getVolume()

public function getVolume(): ?string

Quote::setVolume()

public function setVolume(?string $volume): static

Quote::getTargetDate()

public function getTargetDate(): ?\DateTimeImmutable

Quote::setTargetDate()

public function setTargetDate(?\DateTimeImmutable $targetDate): static

Quote::getStore()

public function getStore(): ?Store

Quote::setStore()

public function setStore(?Store $store): static

Quote::getOrder()

public function getOrder(): ?Order

Quote::setOrder()

public function setOrder(?Order $order): static

Quote::getLines()

public function getLines(): Collection

Quote::addLine()

public function addLine(QuoteLine $line): static

Quote::removeLine()

public function removeLine(QuoteLine $line): static

Quote::getSubtotal()

public function getSubtotal(): int

Quote::getUnits()

public function getUnits(): int

How many units (bottles) the lines hold together.

Review class

class Review extends Thread implements IconizeInterface, AutocompleteInterface, LinkableInterface Review.php:22

Review::__toKey()

public function __toKey(mixed ...$variadic): string

Review::__iconizeStatic()

public static function __iconizeStatic(): ?array

Review::__typesense()

public function __typesense(): ?string

Review::__autocompleteData()

public function __autocompleteData(): array

Review::__autocomplete()

public function __autocomplete(): string

Review::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Review::__construct()

public function __construct(?User $reviewer = null, $rating = 1.0, array $pictures = [])

Review::getRating()

public function getRating(): ?float

Review::setRating()

public function setRating(float $rating): self

Review::getPicture()

public function getPicture(int $i = 0)

Review::getPictures()

public function getPictures()

Review::getPictureFiles()

public function getPictureFiles()

Review::setPictures()

public function setPictures(array $pictures)

Review::getProduct()

public function getProduct(): ?Product

Review::setProduct()

public function setProduct(?Product $product): self

Review::getColors()

public function getColors(): array

Review::getAuthor()

public function getAuthor(int $i = 0)

Review::getAuthors()

public function getAuthors(): Collection

Review::getStore()

public function getStore(): ?Store

Review::setStore()

public function setStore(?Store $store): self

Review::getOrder()

public function getOrder(): ?Order

Review::setOrder()

public function setOrder(?Order $order): self

Store class

class Store extends Thread implements TranslatableInterface, LinkableInterface Store.php:27

Store::__iconizeStatic()

public static function __iconizeStatic(): ?array

Store::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Store::__construct()

public function __construct(?MerchantInterface $merchant = null)

Store::getProducts()

public function getProducts(): Collection

Store::addProduct()

public function addProduct(Product $product): self

Store::removeProduct()

public function removeProduct(Product $product): self

Store::getRegions()

public function getRegions(): Collection

Store::addRegion()

public function addRegion(Region $region): self

Store::removeRegion()

public function removeRegion(Region $region): self

Store::getOrders()

public function getOrders(): Collection

Store::addOrder()

public function addOrder(Order $order): self

Store::removeOrder()

public function removeOrder(Order $order): self

Store::getReviews()

public function getReviews(): Collection

Store::addReview()

public function addReview(Review $review): self

Store::removeReview()

public function removeReview(Review $review): self

Store::getCurrency()

public function getCurrency(): ?string

Store::setCurrency()

public function setCurrency(string $currency): self

Store::chargesVat()

public function chargesVat(): bool

Store::setChargesVat()

public function setChargesVat(bool $chargesVat): self

Store::getVatNumber()

public function getVatNumber(): ?string

Store::setVatNumber()

public function setVatNumber(?string $vatNumber): self

Store::validateVat()

public function validateVat(ExecutionContextInterface $context): void

Store::getProductTaxa()

public function getProductTaxa(): Collection

Store::addProductTaxon()

public function addProductTaxon(ProductTaxon $productTaxon): self

Store::removeProductTaxon()

public function removeProductTaxon(ProductTaxon $productTaxon): self

Store::getReviewTaxa()

public function getReviewTaxa(): Collection

Store::addReviewTaxon()

public function addReviewTaxon(ReviewTaxon $reviewTaxon): self

Store::removeReviewTaxon()

public function removeReviewTaxon(ReviewTaxon $reviewTaxon): self

Store::isOpen()

public function isOpen(): ?bool

Store::setOpen()

public function setOpen(bool $open): self

Usage class

class Usage Usage.php:14

A counted grant used: one of the "events.major": 1 of a plan taken by this event, 3 of its 5 exports made. Releasing it (the event deleted) gives the unit back. What used it is named the way an Entitlement names its resource.

Usage::__construct()

public function __construct(Entitlement $entitlement, string $key, int $quantity = 1, ?string $resourceType = null, int|string|null $resourceId = null)

Usage::getId()

public function getId(): ?int

Usage::getEntitlement()

public function getEntitlement(): Entitlement

Usage::getKey()

public function getKey(): string

Usage::getQuantity()

public function getQuantity(): int

Usage::getResourceType()

public function getResourceType(): ?string

Usage::getResourceId()

public function getResourceId(): ?string

Usage::getUsedAt()

public function getUsedAt(): \DateTimeImmutable

Usage::getReleasedAt()

public function getReleasedAt(): ?\DateTimeImmutable

Usage::isReleased()

public function isReleased(): bool

Usage::release()

public function release(): self

Base\Marketplace\Entity\Catalogue

PlatformLink class

class PlatformLink PlatformLink.php:20

A product of this site and its original on a platform (an omnitrade gateway reading a catalogue: Stripe, Shopify, WooCommerce): which gateway, the product's and the variant's ids there, the stock item counted there, and a fingerprint of what was last written - a product that did not change there is not written again.

One row per variant: a platform product with three variants is a Product and two Variants here, three links. It replaces the Shopify-only ProductLink of the former src/Shopify module (table marketplace_shopify_link).

PlatformLink::__construct()

public function __construct(Product $product, string $gateway, string $remoteProduct, string $remoteVariant)

PlatformLink::getId()

public function getId(): ?int

PlatformLink::getProduct()

public function getProduct(): Product

PlatformLink::getGateway()

public function getGateway(): string

PlatformLink::getRemoteProduct()

public function getRemoteProduct(): string

PlatformLink::getRemoteVariant()

public function getRemoteVariant(): string

PlatformLink::getRemoteItem()

public function getRemoteItem(): ?string

PlatformLink::setRemoteItem()

public function setRemoteItem(?string $remoteItem): self

PlatformLink::getSku()

public function getSku(): ?string

PlatformLink::setSku()

public function setSku(?string $sku): self

PlatformLink::getFingerprint()

public function getFingerprint(): string

PlatformLink::isOrphaned()

public function isOrphaned(): bool

PlatformLink::setOrphaned()

public function setOrphaned(bool $orphaned): self

PlatformLink::getRemoteUpdatedAt()

public function getRemoteUpdatedAt(): ?\DateTimeImmutable

PlatformLink::getSyncedAt()

public function getSyncedAt(): \DateTimeImmutable

PlatformLink::synced()

public function synced(string $fingerprint, ?\DateTimeImmutable $remoteUpdatedAt = null): self

Written now from what the platform said.

Base\Marketplace\Entity\Order

OrderItem class

class OrderItem OrderItem.php:16

OrderItem::__toString()

public function __toString()

OrderItem::__construct()

public function __construct(Product $product, int $quantity = 1)

OrderItem::getId()

public function getId()

OrderItem::getRegion()

public function getRegion(): ?Region

OrderItem::getCustomer()

public function getCustomer(): ?User

OrderItem::getOrder()

public function getOrder(): ?Order

OrderItem::setOrder()

public function setOrder(?Order $order): self

OrderItem::getProduct()

public function getProduct(): ?Product

OrderItem::setProduct()

public function setProduct(?Product $product): self

OrderItem::getRecipient()

public function getRecipient(): ?array

OrderItem::setRecipient()

public function setRecipient(?array $recipient): self

OrderItem::getPersonalisation()

public function getPersonalisation(): ?array

OrderItem::setPersonalisation()

public function setPersonalisation(?array $personalisation): self

OrderItem::getOptions()

public function getOptions(): array

OrderItem::applyOptions()

public function applyOptions(\Base\Marketplace\Model\OptionSelection $selection, ?string $locale = null): self

The line takes these options: kept as a copy, their surcharge added to the product's unit price (before VAT, like it).

OrderItem::getOptionsSurcharge()

public function getOptionsSurcharge(): int

What the options add to each unit, before VAT.

OrderItem::getOptionsLabel()

public function getOptionsLabel(): string

"Bien cuit, Œuf mollet" - empty without options.

OrderItem::getOptionsKey()

public function getOptionsKey(): string

Which options, whatever their order: two lines of a product differ by it.

OrderItem::getAttachments()

public function getAttachments(): Collection

OrderItem::getComment()

public function getComment(): ?string

OrderItem::setComment()

public function setComment(?string $comment): self

OrderItem::getQuantity()

public function getQuantity(): ?int

OrderItem::setQuantity()

public function setQuantity(int $quantity): self

OrderItem::getCurrency()

public function getCurrency(): string

OrderItem::setCurrency()

public function setCurrency(string $currency)

OrderItem::getGrossPrice()

public function getGrossPrice(): int

OrderItem::getSalePrice()

public function getSalePrice(): int

OrderItem::getSalePricePerUnit()

public function getSalePricePerUnit(): int

OrderItem::getVAT()

public function getVAT(): float

OrderItem::getNetPrice()

public function getNetPrice(): int

OrderItem::getUnitPrice()

public function getUnitPrice(): int

OrderItem::setUnitPrice()

public function setUnitPrice(float|int $unitPrice, ?string $currency = null): self

OrderItem::getDiscountCharge()

public function getDiscountCharge(): int

OrderItem::setDiscountCharge()

public function setDiscountCharge(float|int $discountCharge, ?string $currency = null): self

OrderItem::getVatCharge()

public function getVatCharge(): int

OrderItem::setVatCharge()

public function setVatCharge(float|int $vatCharge, ?string $currency = null): self

OrderItem::getShipments()

public function getShipments(): Collection

OrderItem::addShipment()

public function addShipment(Shipment $shipment): self

OrderItem::removeShipment()

public function removeShipment(Shipment $shipment): self

Pickup class

class Pickup Pickup.php:21

How an order is handed over, when it is not simply posted: collected at the shop on a slot, brought nearby by the shop (a list of postcodes), or sent - and for when, to whom, how far along the shop is. The Order keeps the lines, the prices and the payment; this keeps the rest, one row per order, and a token: /…/{token} follows it without an account.

"Fulfilment" names this in some applications and "Supply" is what is made to order by a supplier (Entity\Order\SupplyJob): hence Pickup.

Pickup::__construct()

public function __construct(Order $order, \DateTimeImmutable $day, PickupMode $mode = PickupMode::PICKUP, ?string $token = null)

Pickup::newToken()

public static function newToken(): string

32 random bytes, URL-safe: nobody guesses a tracking page.

Pickup::getId()

public function getId(): ?int

Pickup::getOrder()

public function getOrder(): Order

Pickup::getToken()

public function getToken(): string

Pickup::getMode()

public function getMode(): PickupMode

Pickup::setMode()

public function setMode(PickupMode $mode): self

Pickup::isPickup()

public function isPickup(): bool

Pickup::isDelivery()

public function isDelivery(): bool

Pickup::isShipping()

public function isShipping(): bool

Pickup::getStatus()

public function getStatus(): PickupStatus

Pickup::setStatus()

public function setStatus(PickupStatus $status): self

Pickup::isAtCheckout()

public function isAtCheckout(): bool

Pickup::isOpen()

public function isOpen(): bool

Pickup::getFlow()

public function getFlow(): array

Returns

the steps of its tracking page

Pickup::getStep()

public function getStep(): int

Where it stands among its steps; -1 once cancelled, refused or refunded.

Pickup::getContactName()

public function getContactName(): ?string

Pickup::setContactName()

public function setContactName(?string $contactName): self

Pickup::getEmail()

public function getEmail(): ?string

Pickup::setEmail()

public function setEmail(?string $email): self

Pickup::getPhone()

public function getPhone(): ?string

Pickup::setPhone()

public function setPhone(?string $phone): self

Pickup::getDay()

public function getDay(): \DateTimeImmutable

Pickup::setDay()

public function setDay(\DateTimeImmutable $day): self

Pickup::getSlot()

public function getSlot(): ?string

Pickup::setSlot()

public function setSlot(?string $slot): self

Pickup::getReadyAt()

public function getReadyAt(): ?\DateTimeImmutable

Pickup::setReadyAt()

public function setReadyAt(?\DateTimeImmutable $readyAt): self

Pickup::getAddress()

public function getAddress(): ?string

Pickup::setAddress()

public function setAddress(?string $address): self

Pickup::getPostcode()

public function getPostcode(): ?string

Pickup::setPostcode()

public function setPostcode(?string $postcode): self

Pickup::getCity()

public function getCity(): ?string

Pickup::setCity()

public function setCity(?string $city): self

Pickup::getCountry()

public function getCountry(): ?string

Pickup::setCountry()

public function setCountry(?string $country): self

Pickup::getNote()

public function getNote(): ?string

Pickup::setNote()

public function setNote(?string $note): self

Pickup::getTrackingNumber()

public function getTrackingNumber(): ?string

Pickup::setTrackingNumber()

public function setTrackingNumber(?string $trackingNumber): self

Pickup::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Shipment class

class Shipment implements IconizeInterface, LinkableInterface Shipment.php:17

Shipment::__toString()

public function __toString()

Shipment::__toLink()

public function __toLink(array $routeParameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Shipment::__iconize()

public function __iconize(): ?array

Shipment::__iconizeStatic()

public static function __iconizeStatic(): ?array

Shipment::getId()

public function getId()

Shipment::__construct()

public function __construct()

Shipment::getOrder()

public function getOrder(): ?Order

Shipment::setOrder()

public function setOrder(?Order $order): self

Shipment::getMethod()

public function getMethod(): ?ShippingMethod

Shipment::setMethod()

public function setMethod(?ShippingMethod $method): self

Shipment::getCreatedAt()

public function getCreatedAt(): ?\DateTimeInterface

Shipment::getUpdatedAt()

public function getUpdatedAt(): ?\DateTimeInterface

Shipment::getItems()

public function getItems(): Collection

Shipment::addItem()

public function addItem(OrderItem $item): self

Shipment::removeItem()

public function removeItem(OrderItem $item): self

Shipment::getNumber()

public function getNumber(): ?string

Shipment::setNumber()

public function setNumber(string $number): self

Subscription class

class Subscription implements Stringable Subscription.php:19

A plan paid by subscription: who subscribes, to which plan, through which omnitrade gateway, and the provider's own ids (the subscription, the customer its portal opens for). Its state and the end of the period paid follow the provider's events (Service\Subscriptions); the Entitlements it carries last as long as it runs.

Subscription::__construct()

public function __construct(User $subscriber, string $gateway, string $providerReference, ?Product $product = null, ?Order $order = null)

Subscription::__toString()

public function __toString(): string

Subscription::getId()

public function getId(): ?int

Subscription::getSubscriber()

public function getSubscriber(): ?User

Subscription::getProduct()

public function getProduct(): ?Product

Subscription::setProduct()

public function setProduct(?Product $product): self

Subscription::getOrder()

public function getOrder(): ?Order

Subscription::getGateway()

public function getGateway(): string

Subscription::getProviderReference()

public function getProviderReference(): string

Subscription::getProviderCustomer()

public function getProviderCustomer(): ?string

Subscription::setProviderCustomer()

public function setProviderCustomer(?string $providerCustomer): self

Subscription::getStatus()

public function getStatus(): SubscriptionStatus

Subscription::setStatus()

public function setStatus(SubscriptionStatus $status): self

Subscription::getInterval()

public function getInterval(): string

Subscription::setInterval()

public function setInterval(string $interval): self

Subscription::getCurrentPeriodEnd()

public function getCurrentPeriodEnd(): ?\DateTimeImmutable

Subscription::setCurrentPeriodEnd()

public function setCurrentPeriodEnd(?\DateTimeImmutable $currentPeriodEnd): self

Subscription::isCancelAtPeriodEnd()

public function isCancelAtPeriodEnd(): bool

Subscription::setCancelAtPeriodEnd()

public function setCancelAtPeriodEnd(bool $cancelAtPeriodEnd): self

Subscription::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Subscription::getEndedAt()

public function getEndedAt(): ?\DateTimeImmutable

Subscription::isRunning()

public function isRunning(): bool

What it gives is due now.

SupplyJob class

class SupplyJob implements Stringable SupplyJob.php:15

Part of a paid order handed to a supplier to be made and sent: the lines for one recipient at one supplier, the supplier's reference for it, where it stands and, once it left, its parcel's tracking.

SupplyJob::__construct()

public function __construct(Order $order, string $supplier, string $reference, array $lines, array $recipient)

SupplyJob::__toString()

public function __toString(): string

SupplyJob::getId()

public function getId(): ?int

SupplyJob::getOrder()

public function getOrder(): Order

SupplyJob::getSupplier()

public function getSupplier(): string

SupplyJob::getReference()

public function getReference(): string

SupplyJob::getSupplierReference()

public function getSupplierReference(): ?string

SupplyJob::getStatus()

public function getStatus(): SupplyStatus

SupplyJob::getLines()

public function getLines(): array

SupplyJob::getRecipient()

public function getRecipient(): array

SupplyJob::getTrackingNumber()

public function getTrackingNumber(): ?string

SupplyJob::getTrackingUrl()

public function getTrackingUrl(): ?string

SupplyJob::getCarrier()

public function getCarrier(): ?string

SupplyJob::getMessage()

public function getMessage(): ?string

SupplyJob::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

SupplyJob::getUpdatedAt()

public function getUpdatedAt(): \DateTimeImmutable

SupplyJob::update()

public function update(SupplyStatus $status, ?string $supplierReference = null, ?string $trackingNumber = null, ?string $trackingUrl = null, ?string $carrier = null, ?string $message = null): bool

What the supplier says, kept; true when something moved.

Transaction class

class Transaction implements IconizeInterface Transaction.php:13

Transaction::__iconize()

public function __iconize(): ?array

Transaction::__iconizeStatic()

public static function __iconizeStatic(): ?array

Transaction::__construct()

public function __construct()

Transaction::getNumber()

public function getNumber(): ?string

Transaction::setNumber()

public function setNumber(?string $number): self

Transaction::getDescription()

public function getDescription(): ?string

Transaction::setDescription()

public function setDescription(?string $description): self

Transaction::getClientEmail()

public function getClientEmail(): ?string

Transaction::setClientEmail()

public function setClientEmail(?string $clientEmail): self

Transaction::getClientId()

public function getClientId(): ?string

Transaction::setClientId()

public function setClientId(?string $clientId): self

Transaction::getTotalAmount()

public function getTotalAmount(): int

Transaction::setTotalAmount()

public function setTotalAmount(int $totalAmount): self

Transaction::getCurrencyCode()

public function getCurrencyCode(): ?string

Transaction::setCurrencyCode()

public function setCurrencyCode(?string $currencyCode): self

Transaction::getDetails()

public function getDetails(): array

Transaction::setDetails()

public function setDetails(array $details): self

Transaction::getId()

public function getId()

Transaction::isWaiting()

public function isWaiting()

Transaction::isPaid()

public function isPaid()

Transaction::isRefunded()

public function isRefunded()

Transaction::isCancelled()

public function isCancelled()

Transaction::getState()

public function getState()

Transaction::setState()

public function setState($state): self

Transaction::markAsPaid()

public function markAsPaid()

Transaction::markAsCancelled()

public function markAsCancelled()

Transaction::markAsRefunded()

public function markAsRefunded()

Transaction::getComment()

public function getComment(): ?string

Transaction::setComment()

public function setComment(string $comment): self

Transaction::getWebhook()

public function getWebhook(): ?string

Transaction::setWebhook()

public function setWebhook(?string $webhook): self

Transaction::getCreatedAt()

public function getCreatedAt(): ?\DateTimeInterface

Transaction::getUpdatedAt()

public function getUpdatedAt(): ?\DateTimeInterface

Transaction::getOrder()

public function getOrder(): ?Order

Transaction::setOrder()

public function setOrder(?Order $order): self

Base\Marketplace\Entity\Order\Address

BillingAddress class

class BillingAddress extends Address BillingAddress.php:12

BillingAddress::getOrder()

public function getOrder(): ?Order

BillingAddress::setOrder()

public function setOrder(?Order $order): self

ShippingAddress class

class ShippingAddress extends Address ShippingAddress.php:12

ShippingAddress::getOrder()

public function getOrder(): ?Order

ShippingAddress::setOrder()

public function setOrder(?Order $order): self

Base\Marketplace\Entity\Order\Method

PaymentMethod class

class PaymentMethod implements IconizeInterface PaymentMethod.php:20

PaymentMethod::__toString()

public function __toString()

PaymentMethod::__iconize()

public function __iconize(): ?array

PaymentMethod::__iconizeStatic()

public static function __iconizeStatic(): ?array

PaymentMethod::__construct()

public function __construct()

PaymentMethod::getId()

public function getId()

PaymentMethod::getSlug()

public function getSlug(): ?string

PaymentMethod::setSlug()

public function setSlug(string $slug): self

PaymentMethod::getLabel()

public function getLabel(): ?string

PaymentMethod::setLabel()

public function setLabel(?string $label)

PaymentMethod::getThumbnail()

public function getThumbnail()

PaymentMethod::getThumbnailFile()

public function getThumbnailFile()

PaymentMethod::setThumbnail()

public function setThumbnail($thumbnail)

PaymentMethod::getOrders()

public function getOrders(): Collection

PaymentMethod::addOrder()

public function addOrder(Order $order): self

PaymentMethod::removeOrder()

public function removeOrder(Order $order): self

PaymentMethod::getRefundFee()

public function getRefundFee(): ?Fee

PaymentMethod::setRefundFee()

public function setRefundFee(?Fee $refundFee): self

PaymentMethod::getGatewayFactory()

public function getGatewayFactory(): ?string

PaymentMethod::setGatewayFactory()

public function setGatewayFactory(string $gatewayFactory): self

PaymentMethod::getGatewayConfig()

public function getGatewayConfig(): array

PaymentMethod::getGatewayParameters()

public function getGatewayParameters(): array

The gateway's own settings, from the marketplace.gateways.<slug> parameter.

PaymentMethod::getScopes()

public function getScopes(): Collection

PaymentMethod::addScope()

public function addScope(PaymentMethodScope $scope): self

PaymentMethod::removeScope()

public function removeScope(PaymentMethodScope $scope): self

PaymentMethod::getRules()

public function getRules(): Collection

PaymentMethod::addRule()

public function addRule(PaymentMethodRule $rule): self

PaymentMethod::removeRule()

public function removeRule(PaymentMethodRule $rule): self

ShippingMethod class

class ShippingMethod implements IconizeInterface ShippingMethod.php:21

ShippingMethod::__toString()

public function __toString()

ShippingMethod::__iconize()

public function __iconize(): ?array

ShippingMethod::__iconizeStatic()

public static function __iconizeStatic(): ?array

ShippingMethod::__construct()

public function __construct()

ShippingMethod::getId()

public function getId()

ShippingMethod::getOrders()

public function getOrders(): Collection

ShippingMethod::addOrder()

public function addOrder(Order $order): self

ShippingMethod::removeOrder()

public function removeOrder(Order $order): self

ShippingMethod::getGatewayParameters()

public function getGatewayParameters(): array

ShippingMethod::hasCarrier()

public function hasCarrier(): bool

Whether a carrier takes it: false for a pickup at the shop, the shop's own round.

ShippingMethod::getGatewayName()

public function getGatewayName(): ?string

ShippingMethod::setGatewayName()

public function setGatewayName(?string $gatewayName): self

ShippingMethod::getSlug()

public function getSlug(): ?string

ShippingMethod::setSlug()

public function setSlug(string $slug): self

ShippingMethod::getLabel()

public function getLabel(): ?string

ShippingMethod::setLabel()

public function setLabel(?string $label)

ShippingMethod::getShippingDelay()

public function getShippingDelay(): ?int

ShippingMethod::setShippingDelay()

public function setShippingDelay(?int $shippingDelay): self

ShippingMethod::getDeliveryTime()

public function getDeliveryTime(): ?int

ShippingMethod::setDeliveryTime()

public function setDeliveryTime(?int $deliveryTime): self

ShippingMethod::getThumbnail()

public function getThumbnail()

ShippingMethod::getThumbnailFile()

public function getThumbnailFile()

ShippingMethod::setThumbnail()

public function setThumbnail($thumbnail)

ShippingMethod::getTypeRate()

public function getTypeRate()

ShippingMethod::setTypeRate()

public function setTypeRate($typeRate): self

ShippingMethod::getUnitPrice()

public function getUnitPrice(): ?int

ShippingMethod::setUnitPrice()

public function setUnitPrice(?int $unitPrice): self

ShippingMethod::getCurrency()

public function getCurrency(): ?string

ShippingMethod::setCurrency()

public function setCurrency(string $currency): self

ShippingMethod::getServiceFee()

public function getServiceFee(): ?Fee

ShippingMethod::setServiceFee()

public function setServiceFee(?Fee $serviceFee): self

ShippingMethod::getTrackingUrl()

public function getTrackingUrl(): ?string

ShippingMethod::setTrackingUrl()

public function setTrackingUrl(?string $trackingUrl): self

ShippingMethod::getScopes()

public function getScopes(): Collection

ShippingMethod::addScope()

public function addScope(ShippingMethodScope $scope): self

ShippingMethod::removeScope()

public function removeScope(ShippingMethodScope $scope): self

ShippingMethod::getRules()

public function getRules(): Collection

ShippingMethod::addRule()

public function addRule(ShippingMethodRule $rule): self

ShippingMethod::removeRule()

public function removeRule(ShippingMethodRule $rule): self

Base\Marketplace\Entity\Product

Association class

class Association implements Stringable Association.php:14

One product leading to another on its page: what goes with it (a pairing), what is bought with it (cross-sell), what is better than it (upsell), with a word on why, in each language ("Sur un comté de 24 mois").

Association::__construct()

public function __construct(?Product $product = null, ?Product $target = null, AssociationType $type = AssociationType::PAIRING, array $notes = [])

Association::__toString()

public function __toString(): string

Association::getId()

public function getId(): ?int

Association::getProduct()

public function getProduct(): ?Product

Association::setProduct()

public function setProduct(?Product $product): self

Association::getTarget()

public function getTarget(): ?Product

Association::setTarget()

public function setTarget(?Product $target): self

Association::getType()

public function getType(): AssociationType