Skip to content
Omnisense
Star0 FR

omnisense/omnibase API reference

Floor
Core
Version
3.x
Verified for real
Its README does not say
Licence
MIT
composer require omnisense/omnibase:5.x-dev

You are reading the 3.x series; the current one is 5.x. Read 5.x

Read from the package's own PHP files at the commit dab12e9a30fe: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.

App\Controller

  • DemoController class

    A deliberately flat, style-free tour of a few base-bundle features.

    1 method

Base

Base\ApiPlatform\Metadata\Resource\Factory

Base\Attributes

Base\Attributes\Attribute

  • Iconize class

    Class Iconize package Base\Attributes\Attribute\Iconize

    3 methods

  • IsGranted class

    13 methods

  • Route class

    Attribute class for @Route().

    1 method · 1 constant

  • Sitemap class

    Class Sitemap package Base\Attributes\Attribute\Sitemap

    7 methods

Base\Attributes\Traits

Base\Bridge\Doctrine

  • Configuration class

    What omnibase adds to an entity manager's configuration (plan "omnibase agnostique", C6): the `trash_filter` (soft-deleted rows hidden) and the `vault_filter` (rows of another environment hidden), the DQL functions (RAND, FIELD, JSON_EXTRACT, JSON_SEARCH, JSON_CONTAINS, JSON_ARRAY_POSITION, those whose library is installed), the empty list of tree walkers as the default hint. DoctrineConfigurationPass hands the same lists to DoctrineBundle's configuration service; apply() sets them on a configuration built by hand.

    6 methods · 2 constants

  • Mapping class

    omnibase's Doctrine mapping on an entity manager built by hand - no kernel, no container, no DoctrineBundle (plan "omnibase agnostique", C6):

    3 methods

  • MappingDriver class

    omnibase's mapping driver: the application's driver (attributes, a chain of them under DoctrineBundle), and around it what omnibase's ClassMetadataFactory did on a patched doctrine/orm (plan "omnibase agnostique", C6):

    7 methods

  • MetadataSnapshot class

    What an entity manager made of omnibase's mapping, as plain data that can be compared and written to JSON: for each class its ClassMetadata (every public property - table, inheritance, discriminator map and value, fields and their types, associations, cache, callbacks, repository...; the reflection left out, the id generator by its class), what each enabled SQL filter adds to a query of it, and the completor omnibase's attributes filled for it (aliases, hierarchy); then the DBAL types registered, by name.

    2 methods

  • Registry class

    doctrine/persistence's ManagerRegistry over one entity manager and its connection, both named "default": what omnibase's repositories (Base\Database\Repository\ServiceEntityRepository) and the ClassMetadataManipulator are built from, where DoctrineBundle's `doctrine` service is not there (Base\Bridge\Doctrine\Mapping).

    1 method

  • RepositoryFactory class

    The repositories of an entity manager built by hand (Base\Bridge\Doctrine\ Mapping::getRepository(), or the configuration's repository factory when it is set before the entity manager is built): a repository built from the ManagerRegistry - omnibase's ServiceEntityRepository and the applications' repositories over it, `__construct(ManagerRegistry $registry, ?string $entityName = null)` - is given the registry (and the entity's class when it takes one); any other is built as Doctrine builds it, from the entity manager and the metadata. Under Symfony, DoctrineBundle's ContainerRepositoryFactory hands out the services.

    3 methods

  • Types class

    omnibase's column types, registered with DBAL (plan "omnibase agnostique", C6): what BaseBundle::boot() and the bundle's doctrine.dbal.types did, in one place, for Symfony and for an entity manager built by hand.

    4 methods

Base\Bridge\Symfony

  • AccountScreens class

    The account's screens under Symfony (plan "omnibase agnostique", C5): what the framework-free builder (Base\Screen\Builder\Accounts) cannot know, asked where the templates of before asked it - the viewer and their roles (the Access contract: `app.user`, `is_granted`), an avatar's thumbnail (`|thumbnail`, MediaTwigExtension), the providers one may link (`oauth_available()`), web push and the back-office address of a notification (`push_available()`, `push_vapid_key()`, NotificationTwigExtension), Twig's time zone (the days of the notifications' groups) -, handed to the builder. What the account's controllers and the Twig function `account_profile()` (a host page's) call; a Twig runtime, so that it may read Twig's extensions without a circular service.

    4 methods · 1 constant

  • CsrfTokens class

    The Tokens contract under Symfony (plan "omnibase agnostique", C5): the CSRF token manager's token of an intent - what Twig's `csrf_token()` prints and AbstractController::isCsrfTokenValid() checks.

    2 methods

  • FlysystemFiles class

    Base\Contract\Files under Symfony: omnibase's Flysystem service (its storages from flysystem.yaml) and, for a remote storage, MediaService's image route - what Base\Database\Attribute\Uploader resolves a stored file to: a remote storage's file through the /images route first (no local file to link), a local storage's by its path under public/ (Flysystem::getPublic()); its web address is that path less the public directory, as the editor's uploads give it.

    5 methods

  • LocalizerLocales class

    Base\Contract\Locales under Symfony: omnibase's Localizer (the request's locale, the site's default and fallbacks from base.yaml), its answers in a list.

    4 methods

  • MediaPictures class

    The Pictures contract under Symfony (plan "omnibase agnostique", C5): the answers of omnibase's `|picture` filter itself - a stored image's thumbnail by MediaService, an address or a public path as it is, an asset of the build - so a screen's images are those the templates printed.

    2 methods

  • NotificationMessages class

    The Symfony half of Base\Entity\User\Notification (plan "omnibase agnostique", step C3f): what the entity made with the framework, moved here as it was. The entity keeps what a notification is - its subject, content, importance, channels, recipients, context, templates - and its sending through the notifier; it hands this class what needs Symfony:

    3 methods · 1 constant

  • RouterUrls class

    Base\Contract\Urls under Symfony: the router (omnibase's advanced_router, which generates through the application's) and the asset packages - what Twig's path(), url() and asset() answer, the same strings.

    5 methods

  • ScreenResponder class

    A screen answered under Symfony (plan "omnibase agnostique", C5): what a controller hands back - a template, a view model (Base\Screen\View) - and the frame of the request (the ContextProvider's).

    5 methods

  • SecurityAccess class

    Base\Contract\Access under Symfony: Security's authorization checker (the role hierarchy, the voters - omnibase's on a Thread, a User...) and token storage, the answers of BaseService::isGranted() and of Twig's is_granted() and app.user.

    3 methods

  • SymfonyScreenContext class

    The screens' context under Symfony (plan "omnibase agnostique", C5): what omnibase's kernel.request subscribers and Twig globals gave the templates, asked once for the screen being answered.

    4 methods

  • TranslatorTranslations class

    omnibridge/twig's Translations under Symfony: the application's `translator` (omnibase's chain: the texts rewritten in the back office, then Base\Service\Translator - "@domain.key" references, politeness - then Symfony's, ICU catalogues), what Twig's |trans answers, the same strings.

    2 methods

  • WysiwygTexts class

    The Texts contract under Symfony (plan "omnibase agnostique", C5): the pipeline of omnibase's `|wysiwyg` and `|wysiwyg_toc` filters itself (mentions, links, media, headings, Editor.js's renderer or the HTML of the older editor), so a screen's text is the HTML the templates printed.

    4 methods

Base\Bundle

Base\Cache

Base\Cache\Abstract

  • AbstractLocalCache class

  • AbstractLocalCacheInterface interface

    A service's own cache, warmed by omnibase's cache warmers (Base\Cache\Warmer\*, which call warmUp()). warmUp() is declared here, with the signature of HttpKernel's WarmableInterface, which this interface no longer extends (plan "omnibase agnostique", C6): the AttributeReader and the ClassMetadataManipulator - what an entity manager built by hand reads its mapping through - load nothing of the framework. Symfony asks WarmableInterface of the kernel, its router and its translator only, none of which is one of these.

    7 methods

  • AbstractLocalCacheWarmer class

    3 methods

  • AbstractLocalCacheWarmerInterface interface

    1 method

Base\Cache\Clearer

  • CodeCachesClearer class

    cache:clear is enough: it empties the pools that remember what the code says - the Doctrine mapping's metadata, the DQL's parsed queries, the router's compiled routes. An application keeps them in pools of its own (filesystem, the default clearer, which cache:clear does not call): a column added to an entity read as missing, a route added was "No valid route found", until cache:pool:clear --all.

    2 methods

Base\Cache\Warmer

  • AttributeCacheWarmer class

  • IconCacheWarmer class

    1 method

  • LocalizerCacheWarmer class

  • MetadataCacheWarmer class

    1 method

  • SpreadsheetCacheWarmer class

    3 methods

  • ThemizerCacheWarmer class

  • WebpackCacheWarmer class

    The entries of the application's build and of the core's, and their tags rendered once, kept in the cache - unless a build was being written when the cache was made (the web container restarted while Encore's watcher rebuilds: entrypoints.json absent, or without entries). What was read then is not kept: it used to stay until cache:pool:clear --all, every page without its stylesheets. The renderer reads the builds again on a request that finds none (WebpackTagRenderer::discoverIfNone()).

    2 methods

Base\Console

Base\Console\Command

Base\Contract

  • Access interface

    What the visitor may do: an attribute (a role, "ROLE_ADMIN", or a permission a voter answers, "edit" on a Thread) granted or not, on a subject or none, and who the visitor is.

    2 methods

  • Files interface

    The stored files as an entity sees them: where a file is served from and where PHP can read it, by its path in a storage. Nothing of how it is stored (Flysystem, a disk, a bucket): that stays with the storage.

    4 methods

  • Link class

    A route's address by a router's reference type, through the Urls contract (plan "omnibase agnostique", C3e): what an entity's __toLink() made with BaseTrait's router, `$this->getRouter()->generate($name, $parameters, $referenceType)`, made where there is no framework too.

    1 method · 4 constants

  • Locales interface

    The languages of the site, in omnibase's form: language and country joined by a dash (fr-FR, en-GB, Base\Service\Localizer::SEPARATOR).

    3 methods

  • Pictures interface

    An image's address at the size a page shows it (plan "omnibase agnostique", C5): what omnibase's `|picture` filter answers - a thumbnail of a stored image, an address or a public path as it is, an asset of the build. Null for no image.

    1 method

  • Runtime class

    The registry through which omnibase's framework-free code reaches the contracts of the Fondation (plan "omnibase agnostique", C4): an entity's getter, an attribute, a value object asks Runtime::urls(), ::access()... instead of the services Base\Traits\BaseTrait hands out (the router, the authorization checker, the Localizer, typed with Symfony's classes).

    18 methods

  • SystemClock class

    The clock of the machine, the registry's clock when no framework gave one (Base\Contract\Runtime::clock()). Under Symfony the registry holds the framework's `clock` service instead (symfony/clock, a PSR-20 clock that a test can freeze).

    1 method

  • Texts interface

    A stored text as a page shows it (plan "omnibase agnostique", C5): an Editor.js document or the HTML of an older editor, rendered - mentions, links, media, headings anchored - and its table of contents. What omnibase's `|wysiwyg` and `|wysiwyg_toc` filters answer.

    3 methods

  • Tokens interface

    The token a form carries for an intent, against cross-site requests (plan "omnibase agnostique", C5; decision D4: `csrf_token` enters the view contract): what a page's POST sends back and its action checks. A screen carries it in an action (Base\Screen\Account\Action) where a template called `csrf_token()`.

    1 method

  • Urls interface

    Addresses, as omnibase's framework-free code asks for them: a route by its name, as a path (`path()`) or whole, with the scheme and the host (`url()`, for a mail, a feed, a link shared), and a public file (`asset()`).

Base\Controller

  • DemoController class

    Signing in as a demonstration account in one click: the buttons of the sign-in page's "Demonstration accounts" panel (@Base/demo/_accounts.html.twig).

    1 method · 1 constant

  • ErrorController class

    3 methods

  • LocalizerController class

    3 methods

  • MainController class

    2 methods

  • ProfilerController class

    3 methods

  • RescueController class

    The admin-firewall login ("rescue") entry point. Self-sufficient: it renders the admin extension's login page when base-bundle-admin is installed (@Admin/security/login.html.twig), and otherwise a fully self-contained fallback bundled here that depends on nothing external - no admin package, no third-party admin UI.

    3 methods

  • SecurityController class

    18 methods

  • ShortLinkController class

    2 methods

  • SignatureController class

    A signing provider's callback (glitchr/omnisign: Yousign, DocuSign, DocuSeal...): its signature checked by the gateway, the envelope it names asked again and kept (Base\Service\Signatures::notify()). Without glitchr/omnisign there is nothing to update: 404.

    2 methods

  • SitemapController class

    1 method

  • WidgetController class

    3 methods

Base\Controller\Api

Base\Controller\Backoffice\Crud

Base\Controller\Backoffice\Crud\Layout

Base\Controller\Backoffice\Crud\Layout\Attribute

  • AdapterCrudController class

    Every attribute adapter - the definitions behind scopes, rules, actions and plain attributes ("scope-region", "rule-cart-total", a barcode standard...): their code, icon and label. Each kind is created from its own CRUD, which knows its settings; this list renames and re-icons them, and keeps those attributes still use.

    6 methods

Base\Controller\Backoffice\Crud\Layout\Widget

  • PageCrudController class

    Layout pages served at /page/{slug} (WidgetController::Page).

    4 methods

Base\Controller\Backoffice\Crud\Thread

  • TagCrudController class

    4 methods

  • TaxonCrudController class

    The taxonomy: categories that nest (a parent, children), each with a label, a description and keywords per language. Threads are filed under them.

    4 methods

Base\Controller\Backoffice\Crud\User

Base\Controller\Client

Base\Controller\UX

Base\Database

Base\DatabaseSubscriber

Base\Database\Attribute

  • Alias class

    7 methods · 3 properties

  • Associate class

    9 methods · 1 property

  • Blameable class

    Class Blameable package Base\AttributeReader\Abstract\Blameable

    6 methods

  • Cache class

    Caching to an entity or a collection.

    9 methods · 3 properties · 11 constants

  • Cascade class

    3 methods

  • Countify class

    7 methods · 5 constants

  • DiscriminatorEntry class

    4 methods

  • GenerateUuid class

    Class GenerateUuid package Base\Database\Attribute\GenerateUuid

    5 methods · 10 constants

  • Hashify class

    Class Hashify package Base\Database\Attribute\Hashify

    10 methods · 14 properties

  • Hierarchify class

    Class Hierarchify package Base\Database\Attribute\Hierarchify.

    4 methods · 2 properties

  • OrderColumn class

    6 methods · 2 properties · 2 constants

  • OrphanRemoval class

    3 methods

  • Randomize class

    Class Randomize package Base\Database\Attribute\Randomize

    3 methods

  • Slugify class

    Class Slugify package Base\Database\Attribute\Slugify

    7 methods

  • Timestamp class

    Class Timestamp package Base\Database\Attribute\Timestamp

    8 methods

  • Timezone class

    Class Timezone package Base\Database\Attribute\Timezone

    6 methods · 1 constant

  • Trasheable class

    Marks an entity as soft-deletable: `$em->remove()` stamps the deletion field instead of issuing a DELETE, and TrashFilter hides the row from every read.

    4 methods · 3 properties

  • Uploader class

    Class Uploader package Base\Database\Attribute\Uploader

    25 methods · 1 constant

  • Vault class

    17 methods · 3 properties

  • Versionable class

    Marks a property as worth remembering: every flush that changes it appends the old value to the entity's revision history (see VersionableSubscriber, which writes one Revision per entity per flush - not one per field).

    6 methods · 2 properties

Base\Database\Attribute\Extension

Base\Database\Common\Collections

Base\Database\Entity

Base\Database\Entity\AggregateHydrator

Base\Database\Entity\Extension

Base\Database\Entity\Extension\Type

Base\Database\Event

Base\Database\Filter

  • TrashFilter class

    Hides soft-deleted rows from every read that goes through the ORM.

    1 method

  • VaultFilter class

    3 methods

Base\Database\Function

Base\Database\Mapping

  • ClassMetadataCompletor class

    5 methods

  • ClassMetadataFactory class

    Doctrine's ClassMetadataFactory, as the applications name it in their doctrine.yaml (class_metadata_factory_name), on doctrine/orm as published: it uses nothing Doctrine keeps private (plan "omnibase agnostique", C6).

    3 methods

  • ClassMetadataManipulator class

    69 methods · 1 constant

  • NamingStrategy class

    omnibase's names for tables and columns: App\Entity\Thread\Tag is threadTag, App\Entity\User\Profile userProfile, Thread::$tags the join table thread_tags (thread_id, threadTag_id), a property its own name.

    1 method

Base\Database\Middleware

Base\Database\Repository

  • ServiceEntityParser class

    4 methods · 62 constants

  • ServiceEntityRepository class

    A repository of omnibase: Doctrine's EntityRepository, built from the ManagerRegistry contract (doctrine/persistence) as DoctrineBundle's ServiceEntityRepository is - `__construct(ManagerRegistry $registry, ?string $entityName = null)`, the entity's class guessed from the repository's name when not given - plus the finder language (findByStateAndLocale(), cacheOneBySlug(), countByDomain()...).

    16 methods

Base\Database\Type

  • ArrayType class

    Type that maps a PHP array to a clob SQL type.

    5 methods

  • DateTimeTypeUTC class

    Doctrine's `datetime` (and `datetimetz`) as omnibase overrides them with base.database.use_custom (BaseBundle::boot()): a \DateTime moved to UTC as it is written, read back as UTC.

  • EnumType class

    17 methods

  • SetType class

    4 methods

  • Utc class

    Moments in UTC, for the code around a `utc_datetime_immutable` column: the present, and any date as the same moment in UTC - what a query parameter compared with such a column must be when it is bound without its type.

    3 methods

  • UtcDateTimeImmutableType class

    A moment, written in UTC and read back as UTC (`utc_datetime_immutable`).

    1 constant

  • UtcDateTimeType class

    UtcDateTimeImmutableType's mutable twin (`utc_datetime`): a \DateTime written in UTC and read back as UTC, whatever zone PHP is in.

    1 constant

Base\Database\Walker

Base\Demo

  • DemoAccount class

    A demonstration account, as a bundle or the application declares it (DemoAccountProviderInterface): who signs in, as what, and what that role sees. The fixtures create the accounts from these declarations (DemoAccountFactory); in the `demo` environment the sign-in page offers one button for each (docs/20-architecture/demo.md).

    4 methods · 9 properties

  • DemoAccountFactory class

    The declared demonstration accounts as rows: what the fixtures call instead of writing each account by hand, and what `demo:reset` calls after them so that every declared account exists.

    5 methods

  • DemoAccountProviderInterface interface

    Declares demonstration accounts: implemented by a bundle for the roles of its trade (a practitioner, a secretary, a patient) and by the application for its own. Autoconfigured (tag base.demo_account_provider); the application's declaration replaces a bundle's for the same identifier.

    1 method

  • DemoAccountRegistry class

    Every demonstration account declared by the bundles and the application (DemoAccountProviderInterface), by identifier. The application's declarations come last and replace a bundle's; base.demo.exclude drops the ones a site has no use for.

    11 methods · 1 constant

  • DemoGuard class

    What the `demo` environment refuses to start on (BaseBundle::boot() asks, for a page as for a command):

    3 methods

  • DemoMode class

    Whether the kernel runs the demonstration: the `demo` environment, and no other. There is no switch to turn it on elsewhere - what it lifts (the staff's second factor) and what it offers (signing in as anyone declared) has no place on a production site.

    2 methods · 1 constant

Base\DependencyInjection

Base\DependencyInjection\Compiler

  • AbstractPass class

    AbstractPass for handling tagged services or entities implementing a specific interface.

    6 methods

Base\DependencyInjection\Compiler\Pass

  • AdminUrlGeneratorPass class

    Binds Base\Routing\AdminUrlGeneratorInterface to whatever back-office is installed.

    1 method

  • ApplicationTextsPass class

    Which texts the application wrote itself (its own translations/ directory), for the level of politeness (base.translator.politeness, docs/20-architecture/politeness.md).

    2 methods

  • AttributePass class

    4 methods

  • ContractsPass class

    The locator Base\Contract\Runtime reaches the contracts of the Fondation through (plan "omnibase agnostique", C4), handed to it by BaseBundle::boot(): each contract by its interface's name, the service the container binds to that name - omnibase's adapters (Base\Bridge\Symfony\*, config/services/core.php), the framework's clock, event dispatcher and mailer, or an application's own binding, which wins as any alias does.

    1 method · 2 constants

  • DoctrineConfigurationPass class

    omnibase's Doctrine mapping on DoctrineBundle's entity managers, from the same lists and the same driver an entity manager built by hand gets from Base\Bridge\Doctrine\Mapping (plan "omnibase agnostique", C6):

    1 method

  • DoctrineEnumSubscriberPass class

    1 method

  • EntityExtensionPass class

    4 methods

  • GuardPass class

    Base\Service\FormGuard's default captcha is glitchr/omnishield's (omnishield.challenge.gateway) - a parameter that exists only when omnishield's bundle is registered: read here, once every extension has loaded, rather than named in the service's definition. So is glitchr/ux-google's switch, for the sign-in's captcha (SignInGuard).

    1 method

  • IconProviderPass class

    4 methods

  • ObfuscatorCompressionPass class

    4 methods

  • SharingPass class

    4 methods

  • TagRendererPass class

    4 methods

  • TextOverrideCachePass class

    The rewritten texts (Base\Translation\OverridingTranslator) are cached in the application's shared Redis pool when it declares one (cache.redis): the web, the worker and cron then agree after an edit. Otherwise cache.app.

    1 method

  • TradingPass class

    4 methods

  • TwigComponentPass class

    1 method

  • WebauthnDeprecatedAliasPass class

    WebauthnExtension (web-auth/webauthn-symfony-bundle 5.3) still aliases the deprecated PublicKeyCredentialSourceRepositoryInterface to the configured credential_repository, next to CredentialRecordRepositoryInterface. Nothing in the bundle or here asks for the deprecated name, but the alias forced PasskeyRepository to keep implementing it (an alias to an interface the class lacks fails `lint:container`), and implementing it raises a deprecation on every boot.

    1 method

  • WorkflowPass class

    5 methods

Base\DependencyInjection\Dumper

Base\Entity

Base\EntityDispatcher

Base\EntityDispatcher\Event

Base\EntitySubscriber

  • ConnectionSubscriber class

    6 methods

  • ExtensionSubscriber class

    5 methods

  • SettingSubscriber class

    Invalidates SettingBag's compiled snapshot on any Setting/SettingIntl write, not just ones that went through SettingBag::set(). The admin CRUD (EasyAdmin's SettingCrudController / LayoutSettingListType) persists these entities via a plain flush() and never called SettingBag::set() at all, so without this listener an admin edit (e.g. the site logo) would keep serving the stale cached value until the next unrelated cache:clear.

    4 methods

  • ThreadSubscriber class

    7 methods

  • TrasheableSubscriber class

    Turns `$em->remove()` into a soft delete for every entity carrying `#[Trasheable]` - Thread and, through it, articles, galleries, comments, guestbook messages, calendars and newsletters.

    4 methods

  • UserSubscriber class

    8 methods

  • VersionableSubscriber class

    Records what changed, for every property carrying `#[Versionable]`.

    3 methods

Base\Entity\Analytics

  • PageView class

    One row per (path, HOUR, source) - an hourly rolling aggregate, not a per-request event log. $views is incremented atomically (see PageViewRepository, which buckets any timestamp down to the top of its hour before writing) on every trackable request; time windows ("24h", "7 days", "all time") are just a SUM over however many of these rows fall in range, and a calendar-day figure (dailyBreakdown()) is itself a SUM over that day's up-to-24 hourly rows rather than its own storage grain - this is what lets "today" plot an hour-by-hour curve instead of the single flat point a pure daily rollup could ever produce.

    9 methods · 3 constants

  • PageVisit class

    An HOURLY PRESENCE record per page: at most one row per (hour, path, subjectType, subjectId), inserted on first sight and ignored afterwards - the same mechanism as Visit, with the path added.

    9 methods

  • Visit class

    An HOURLY PRESENCE record, not a per-request event log: at most one row per (hour, subjectType, subjectId) - see VisitRepository, which buckets any timestamp down to the top of its hour before writing - inserted on first sight that hour and ignored on every later request the same hour.

    7 methods · 2 constants

Base\Entity\Extension

  • Revision class

    One entry of an entity's modification history: what changed in a single flush, as `entityData = {"<field>": [old, new]}`.

    8 methods

  • TrashBall class

    4 methods

Base\Entity\Extension\Abstract

Base\Entity\Hours

  • ScopedWeek class

    The usual week of one place, when a site has several: a shop among the shops, a practice among the practices. The place is a scope key - any string its owner chooses ("store:12"), or an entity (Base\Service\OpeningHours::scopeOf()).

    5 methods

  • SpecialDay class

    A day (or a run of days) off the usual week: closed (holidays, a bank holiday), or open at other hours ([["10:00","14:00"]]). Read by Base\Service\OpeningHours everywhere (the day an order is for, the time slots, the footer, a banner, the JSON-LD's specialOpeningHoursSpecification).

    15 methods

  • WeekDayHours class

    The usual hours of one day of the week: [["09:00","13:00"],["16:30","19:00"]], or none (closed). No row at all: the week the site was configured with (base.opening_hours.week), read by Base\Service\OpeningHours. Special days (SpecialDay) override a date.

    5 methods

Base\Entity\Layout

  • Attribute class

    5 methods

  • AttributeIntl class

    6 methods

  • Image class

    23 methods

  • ImageCrop class

    40 methods

  • ImageCropInterface interface

    16 methods

  • ImageInterface interface

    5 methods

  • Redirection class

    An address the site no longer answers, and where it leads now: the pages of a site taken over (/produit/enseigne-lumineuse/ -> /savoir-faire/enseigne), a page renamed. Asked only when a request ends in "not found" (Base\Subscriber\RedirectionSubscriber): a page that exists is never shadowed, and a page that is found costs nothing.

    17 methods · 3 constants

  • Semantic class

    15 methods

  • SemanticIntl class

    4 methods

  • Setting class

    14 methods

  • SettingIntl class

    11 methods

  • ShortLink class

    8 methods

  • ShortLinkIntl class

    4 methods

  • TextOverride class

    A text of the site, as the team rewrote it from the back office: it replaces the one in translations/ for that key, domain and language (Base\Translation\OverridingTranslator), on every page and in every e-mail. Deleting it brings the original back. Same syntax as the original: {placeholders}, ICU plurals. Moved here from the apps' App\Entity\TextOverride (table textOverride there; this one is layoutTextOverride, so an app not moved yet keeps its own).

    12 methods

  • Tooltip class

    14 methods

  • TooltipIntl class

    4 methods

  • Widget class

    17 methods

  • WidgetIntl class

    8 methods

Base\Entity\Layout\Attribute

Base\Entity\Layout\Attribute\Adapter

Base\Entity\Layout\Attribute\Adapter\Common

Base\Entity\Layout\Attribute\Common

Base\Entity\Layout\Widget

Base\Entity\Layout\Widget\Set

Base\Entity\Signature

  • AbstractEnvelope class

    What an envelope keeps (Base\Entity\Signature\Envelope): what it is about - any entity, by its class and id -, the glitchr/omnisign gateway it went through and that gateway's reference, where it stands, its signers, and the signed document and its evidence once kept in the private storage. A mapped superclass: no table of its own; Envelope is an entity only when glitchr/omnisign is installed.

    19 methods · 6 constants

Base\Entity\Thread

  • Comment class

    What a visitor leaves under a thread (a blog post, a sequence, a video) - or, with no thread, in the site's visitors' book: a name, an e-mail (never shown), a site, a text, and for a reply the comment it answers. Signed in, the author is kept too. Moved here from omnibase/blog.

    39 methods · 1 property

  • Like class

    10 methods

  • Mention class

    11 methods

  • Tag class

    17 methods

  • TagIntl class

    6 methods

  • Taxon class

    23 methods

  • TaxonIntl class

    6 methods

Base\Entity\User

  • Address class

    28 methods

  • Complaint class

    A user's complaint about another one (or about something), for the staff to answer.

    35 methods · 4 constants

  • Connection class

    35 methods

  • Group class

    Open to extension the way User is: JOINED inheritance on a `class` discriminator, so an application can add its own group (a leader, a motto, a join mode...) as a subclass in its own table, while roles, permissions, rules, scopes and actions keep working on the base row. An application without a subclass sees no change but the discriminator column.

    36 methods · 1 constant

  • Invitation class

    An e-mail that opens something: whoever follows its link before it runs out gets an account (or signs in with theirs), attached to what it was made for. Only the token's hash is kept; the token itself is sent, never stored (Base\Service\Invitations).

    13 methods

  • Notification class

    A notification: its subject, content, importance, channels, recipients, context and templates, and its sending through omnibase's notifier. Cut in two (plan "omnibase agnostique", step C3f): what needs Symfony - an ExceptionEvent or a FlattenException made content, render()'s Response, the e-mail built on Twig's TemplatedEmail and HttpFoundation's uploaded files - is Base\Bridge\Symfony\NotificationMessages'; this class names nothing of the framework (Symfony's Notifier is a standalone component).

    60 methods · 5 constants

  • Passkey class

    9 methods

  • Penalty class

    A penalty an administrator has defined, NOT one somebody has received.

    21 methods

  • Permission class

    19 methods

  • PushSubscription class

    One browser's Web Push endpoint for one user. A person has one of these per browser they enabled notifications in (phone, laptop, ...), and each one dies on its own when the browser revokes it - the push service then answers 404/410 and WebPushService prunes the row.

    17 methods

  • Sanction class

    One penalty, given to one user, once.

    19 methods

  • Token class

    37 methods · 3 constants

Base\Entity\User\Attribute

  • GroupAction class

    What a group DOES for somebody who qualifies for it.

    5 methods

  • GroupRule class

    A condition a user must satisfy for a group to be open to them.

    5 methods

  • GroupScope class

    Who a group's rules are about in the first place.

    5 methods

Base\Entity\User\Attribute\Action

Base\Entity\User\Attribute\Scope

  • GroupAdapter class

    Narrows something to the members of another group.

    6 methods

  • UserAdapter class

    Narrows something to named people.

    6 methods

Base\Enum

  • Allergen enum

    The fourteen allergens a food business must declare in the European Union (Regulation (EU) No 1169/2011, Annex II), in the Annex's order. A plain string enum: stored as is (a JSON list of values on a dish, a varchar), labelled through the "enums" translation domain (allergen.<value>).

    4 methods · 14 cases

  • CommentState enum

    Where a comment is: waiting for the moderator, online, filed as spam, or taken down. A string enum (not omnibase's EnumType) so the column reads plainly in the database and in the admin's filters.

    1 method · 4 cases

  • ConnectionState class

    2 methods · 4 constants

  • EntityAction class

    2 methods · 3 constants

  • LogLevel class

    2 methods · 4 constants

  • Operation class

    2 methods · 6 constants

  • SpamApi class

    2 methods · 1 constant

  • SpamScore class

    3 methods · 4 constants

  • ThreadState class

    4 methods · 7 constants

  • UploadState class

    2 methods · 3 constants

  • UserGender class

    2 methods · 4 constants

  • UserRole class

    3 methods · 4 constants

  • UserState class

    2 methods · 8 constants

  • WorkflowState class

    2 methods · 6 constants

Base\Enum\Quadrant

Base\Enum\SystemOfUnits

Base\Event

  • SignatureEvent class

    An envelope moved (Base\Service\Signatures): completed, declined, expired, canceled - or a signer signed. The application answers on what it is about: a quote accepted once signed, a lease in force.

    4 methods · 5 constants

  • SitemapEvent class

    Dispatched while /sitemap.xml is being built, once the routes carrying a Sitemap attribute have been registered.

    3 methods · 1 constant

Base\Exception

Base\Field

Base\Field\Option

Base\Field\Type

Base\Form

  • FormFactory class

    3 methods

  • FormFactoryInterface interface

  • FormProcessor class

    25 methods · 2 properties

  • FormProcessorInterface interface

    12 methods

  • FormProxy class

    The forms of a request, by name. Reset between two requests (kernel.reset): a kernel that serves several - a test client's, a worker's - kept the sign-in form under "form:login", and the sign-up page, which asks for a processor of that name, rendered the sign-in form.

    14 methods

  • FormProxyInterface interface

    11 methods

Base\Form\Common

Base\Form\Extension

Base\Form\Model

  • CommentModel class

    What the comment form (Base\Form\Type\CommentType) edits - not the entity (omnibase's FormFactory refuses an entity as form data): the name, the e-mail, the site, the text. It implements SpamProtectionInterface so omnibase's FormTypeSpamExtension sends it to Akismet; the score lands here, and toComment() carries it onto the Comment to save.

    6 methods · 6 properties

  • ContactModel class

    What the contact form (Base\Form\Type\ContactType) sends: a name, an e-mail, a message, and as the form is set up a phone, a subject, attachments. `website` is the trap: left empty by people, filled by the robots that fill every field (isRobot()).

    3 methods · 7 properties

  • SecurityLoginModel class

    2 properties

  • SecurityLoginTokenModel class

    1 property

  • SecurityRegistrationModel class

    3 properties

  • SettingModel class

    1 property

  • ThreadSearchModel class

    5 properties

  • UserEditModel class

    3 properties

  • UserProfileModel class

    3 properties

  • UserSearchModel class

    1 property

Base\Form\Traits

Base\Form\Transformer

Base\Form\Type

Base\Imagine

Base\Imagine\Filter

Base\Imagine\Filter\Advanced

Base\Imagine\Filter\Basic

Base\Imagine\Filter\Basic\Definition

Base\Imagine\Filter\Format

Base\Imagine\Svg

Base\Inspector

Base\Mailer

  • MailTrap class

    A hold-everything switch for outgoing mail, meant for the minutes after a hotfix when you are not yet sure the site is sending the right things to the right people.

    12 methods

Base\Notifier

  • NotificationLinkerInterface interface

    Turns a notification's target (class + id, see Notification::setTarget()) into a back-office URL. base-bundle ships a null implementation; the admin bundle replaces it with one that knows its CRUD routes, so a notification opened from the back-office lands on the record's edit page while the same notification on the front-end keeps its public URL.

    1 method

  • Notifier class

    11 methods

  • NotifierInterface interface

    1 method

  • NullNotificationLinker class

    No back-office installed: there is no admin page to link to.

    1 method

Base\Notifier\Abstract

Base\Notifier\Channel

  • BrowserPlusChannel class

    3 methods

  • EmailPlusChannel class

  • InAppChannel class

    The "inapp" channel: keeps a copy of the notification in the recipient's notification list (userNotification), which is what the bell in the toolbar and the back-office reads. Nothing else in the notifier persists a Notification - it is built, sent over its channels and dropped - so this channel is the one place a notification becomes a row.

    4 methods

  • PushChannel class

    The "push" channel: a Web Push message to every browser the recipient enabled notifications in. Silent when VAPID keys are not configured or the recipient is not a user, so a policy can list it unconditionally.

    3 methods

Base\Notifier\Recipient

Base\Repository

Base\Repository\Analytics

Base\Repository\Extension

Base\Repository\Extension\Abstract

Base\Repository\Hours

Base\Repository\Layout

Base\Repository\Layout\Attribute

Base\Repository\Layout\Attribute\Adapter

Base\Repository\Layout\Attribute\Adapter\Common

Base\Repository\Layout\Attribute\Common

Base\Repository\Layout\Widget

Base\Repository\Layout\Widget\Set

Base\Repository\Thread

Base\Repository\User

Base\Repository\User\Attribute

Base\Repository\User\Attribute\Action

Base\Repository\User\Attribute\Scope

Base\Response

  • PdfResponse class

    An HTML page answered as a PDF, rendered by dompdf/dompdf - a suggested package: `composer require dompdf/dompdf`.

    5 methods

  • XmlResponse class

    3 methods

Base\Routing

Base\Routing\Generator

Base\Routing\Loader

  • RouteTranslationsResourceLoader class

    Registers config/routes_paths.yaml as a tracked resource so Symfony's config-cache rebuilds routes when it changes. Base\Attributes\Attribute\Route reads that file directly (not through Symfony's routing loaders), so without this, editing it alone — without touching any controller file — would leave the compiled route cache stale: AttributeClassLoader's freshness tracking is per-controller-class, not aware of this file at all.

    2 methods · 1 constant

Base\Routing\Matcher

Base\Screen

  • Author class

    Who wrote a story, a comment, a reply (lesringostars' authors): a name, the address of their page (a profile, a comment's website), an avatar's address; `staff` where a screen marks the site's own people (the blog's "author" pill), left out of the props where it does not.

    3 methods · 4 properties

  • Card class

    A story on a list (lesringostars' BlogPage::card()): its slug, title, excerpt, date, reading time, authors and tags, its address. `likes`, `likeUrl` and `comments` are null where the screen counts none (never 0: "none counted" and "zero" stay apart). Added for omnibase's blog: the line under the title (`headline`), the cover's address at the width the screen shows it, the taxa, and `recent` - published lately, by the screen's clock (a template compares no moment: it reads this).

    3 methods · 16 properties

  • Comment class

    A comment (lesringostars' comments): its id or uuid (at least one: a front end keys and anchors on the uuid, else the id), slug, date, authors, text (as written: a template breaks its lines), the address to follow it, its replies, and whether it is recent by the screen's clock.

    3 methods · 9 properties

  • Confidential interface

    A screen carrying secrets of its viewer's session (plan "omnibase agnostique", C5): the tokens of its forms (Base\Screen\Account\Action), the token of its requests. Whoever answers it keeps it out of every cache - under Symfony, ScreenResponder gives `Cache-Control: private, no-store` and `Vary: Cookie`, the HTML as the JSON.

  • ContextProvider interface

    What a screen needs of the request it answers (plan "omnibase agnostique", C5): the frame around the page, the visitor signed in, the messages left for the page. Under Symfony Base\Bridge\Symfony\SymfonyScreenContext; a site decorates it to add its own frame fields; another framework fills it the same.

    3 methods

  • Discussion class

    The comments of a page and whether one may write (lesringostars' page `comments` and `hasMoreComments`, here `comments` and `hasMore`): one model, because the block is shown on pages that are no story too (a visitors' book, a host's home). `open`: a comment may be written here (the site's settings, the story's, the visitor); `canReply`: an answer to one may; `signIn`: the address of the sign-in page, for whoever may not; `flashes`: the messages left for this page, already read.

    3 methods · 6 properties

  • Frame class

    What every page shows around its screen (lesringostars' App\Screen\Frame): the page's language, the site, the addresses of the menus, the visitor signed in and the colour scheme, and what a site adds of its own (`extra`: lesringostars' destination, destinations, last article, tags, map), merged in its props between `site` and `links`. Given per request by a ContextProvider.

    4 methods · 7 properties · 1 constant

  • Link class

    Another story, as a page points to it (the one before, after, to read as well; a member's latest on their profile): its title, address and state; `publishedAt` where a page shows the date, left out of the props where it shows none.

    3 methods · 4 properties

  • Reply class

    An answer to a comment (lesringostars' replies): its id or uuid (at least one: a front end keys and anchors on the uuid, else the id), date, authors, text, whether it was deleted, and whether it is recent by the screen's clock.

    3 methods · 7 properties

  • Screen interface

    A view model (plan 0, rule 13; plan "omnibase agnostique", C5): what a screen shows, as plain data a view bridge renders - Twig reads the object's public properties, a front end (React) reads toArray() as its props. No entity, no service, no class of a framework inside: scalars, ISO 8601 moments, lists and other screens.

    1 method

  • Site class

    The site around every page: its name, its slogan, its logo's address, the year, its description (lesringostars' frame `site`).

    3 methods · 5 properties

  • Story class

    A story on its own page (lesringostars' StoryPage `article`): what its card says, with its id, its text (StoryText's html, editor and toc, flattened as there), its sounds' addresses, whether it takes comments, and its state.

    7 methods · 20 properties

  • StoryText class

    A story's text as its page shows it (lesringostars' StoryText::render()): the HTML rendered, whether it was an Editor.js document, and its table of contents (each heading's tag, anchor and title, in the text's order).

    3 methods · 3 properties

  • Tag class

    A tag, a taxon (lesringostars' tags): its slug, label, colour, icon and the address that lists what carries it; `count` in a cloud of tags, `current` in a navigation by tag (the one shown), each left out of the props where a screen has none.

    3 methods · 7 properties

  • View class

    What a controller hands back (plan 0, rule 13): the template that draws the screen, the screen itself, the name of the component a front end draws it with (omnibridge/react's Page), and the status of the answer. The view bridge renders it: Twig with `frame` and `screen`, React with the frame's and the screen's props together.

    1 method · 4 properties

  • Viewer class

    The visitor signed in, as a page may show them: an id, a name, an avatar's address. Nothing else (no roles: what a screen needs of the visitor, its builder decides - may they reply, is the form open).

    3 methods · 3 properties

Base\Screen\Account

  • AccountSummary class

    An account's security at a glance, on its profile, for its owner or an administrator: whether it has a second factor (null where two-factor is not available on the site), how many passkeys (null where passkeys are not - never 0 for "not counted"), the provider it signs in with (`google`), its language and time zone.

    3 methods · 5 properties

  • Action class

    A POST a page sends (plan "omnibase agnostique", C5): the address it goes to and the token of its intent (Base\Contract\Tokens), which the action checks. Only on a confidential screen (Base\Screen\Confidential): its answers are stored by no cache.

    3 methods · 2 properties

  • Member class

    A member as their profile shows them, to anyone who opens it: their number and name, their avatar - the stored one's address at 128 px, or the application's own rendering (`avatarHtml`: its User's getFormattedAvatar(), HTML) -, their roles (the names, which a template translates), whether they are online or were active lately (the account's own answers, by base.user.online_delay and active_delay), when they registered and were last seen, how many threads they own and likes they gave (counted).

    3 methods · 11 properties

  • Notification class

    A notification in the member's list: the bell's item (NotificationController::serialize(): id, title - else the subject -, text without its tags - null when it has none -, address, back-office address, importance, read or not, when it was sent) and its `group` - `today`, `yesterday`, `week` or `earlier`, by the screen's clock in the page's time zone, so that no template compares a moment.

    3 methods · 9 properties · 1 constant

  • NotificationsPage class

    The member's notifications (/notifications): the latest with something to show (newest first; the unread ones alone when asked), how many are unread (counted), whether the page shows the unread ones alone and the address of all of them, the token every request of the page carries and the addresses of those requests (read, latest, delete, push subscribe and unsubscribe), whether push can be offered and its public key. Its token: confidential.

    3 methods · 12 properties

  • Passkey class

    A passkey of the account: its number, its label (null for none), when it was added and last used, the actions renaming and removing it.

    3 methods · 6 properties

  • ProfilePage class

    A member's profile (/profile/{id}): the member, whether the viewer is that member, their five latest published threads (newest first, each dated by its publication, else its creation), the account's summary - only for its owner or an administrator, null for anyone else -, and the addresses its owner (or an administrator, for the edit) follows from there.

    3 methods · 7 properties

  • Provider class

    A provider one may sign in with (`google`, "Google"): whether the account signs in with it, the address linking it (while it does not).

    3 methods · 4 properties

  • Session class

    One of the account's sessions (a connection): its number, the browser's own string and a readable label ("Safari - macOS"), the addresses it came from, when it was last seen, whether it is still open, and the action signing it out (while it is).

    3 methods · 7 properties

  • SettingsPage class

    The account's settings (/settings): its name (null for nobody signed in: the page shows its title alone), whether it is a demonstration account (changing nothing of its credentials), its second factor (null where two-factor is not available), its passkeys (null where passkeys are not) and the identifier a new one registers, the sign-in providers shown (those available, and the account's own), its latest sessions, its language (its locale, `language`: the frame owns `locale`) and time zone. Its actions carry their tokens: confidential.

    3 methods · 9 properties

  • TwoFactor class

    An account's second factor on its settings page, as the security policy lets its owner change it: whether the administrator requires one (and the account still lacks it), the authenticator app - on or off, the address to switch it on (when it may be), the action switching it off (when it may be: on without it is locked by the administrator) -, the code by e-mail - on or off, locked (on, the only factor left, and required), the action toggling it (when not locked and the account may change its credentials) -, the backup codes left (null while the app is off).

    3 methods · 9 properties

Base\Screen\Builder

  • Accounts class

    The account's pages as view models (plan "omnibase agnostique", C5): a member's profile, the account's settings, the member's notifications, from omnibase's entities (a User, its threads and passkeys, its connections, its notifications) and the site's security policy. Framework-free: the addresses through the Urls contract, the forms' tokens through Tokens (the ones given, else Runtime's), "now" from a PSR-20 clock; what only the framework knows (an avatar's thumbnail, the providers available, web push) the caller passes in.

    9 methods · 2 constants

  • Stories class

    omnibase's threads as view models (plan "omnibase agnostique", C5): a thread on a list (Card), on its own page (Story), pointed to (Link), its text (StoryText), its tags, taxa and owners, the comments left on it.

    9 methods

Base\Security

  • AccessTokenHandler class

    2 methods

  • CookieAnswer class

    The visitor's answer about cookies, read on the server: the page's script (@glitchr/flowjs/cookie, which omnibase/consent configures) keeps it in the cookie "cookie-consent" - {"c": {"USER": 1, "LOCATION": 0}, ...}, one yes or no per category. For the few cookies the server writes itself: the script lets nothing be written under a refused category, and neither does the server.

    2 methods · 1 constant

  • LoginFormAuthenticator class

    6 methods · 3 constants

  • LoginRestrictionInterface interface

  • RescueFormAuthenticator class

    2 constants

  • SignInGuard class

    The sign-in's captcha, after a few failures. Symfony's login_throttling is the first line (five tries a minute, per identifier and address); this one counts the failures from an address - whatever identifiers they tried - and from base.guard.sign_in_after of them on, the sign-in form carries the captcha (SecurityController::Login) and a sign-in without a valid token is refused before its password is even checked. A success forgets the count.

    7 methods · 2 constants

  • UserChecker class

    3 methods

  • UserProvider class

    6 methods

  • UserTracker class

    5 methods · 1 constant

  • WebauthnUserEntityRepository class

    3 methods

Base\Security\Session

Base\Security\Voter

  • AccessVoter class

    1 method · 6 constants

  • AdminVoter class

    1 method · 1 constant

  • ComplaintVoter class

    Who reads and answers a complaint (Base\Entity\User\Complaint).

    1 method · 2 constants

  • PermissionVoter class

    Custom fine-grained permission names, backed by Base\Entity\User\Permission and granted through group membership (or directly on the user). This is the "customizable by base or app classes" extensibility a plain ROLE_* hierarchy can't offer: base-bundle-admin's own SecurityVoter already delegates every permission string through isGranted(), so registering this voter is all that's needed for Actions::setPermission()/ Crud::setEntityPermission()/MenuItem::setPermission() to accept a custom tag like "ARTICLE.PUBLISH" alongside a plain ROLE_* string - no changes to base-bundle-admin required.

Base\Serializer

  • Aco class

    7 methods · 9 constants

  • Excel class

    5 methods · 5 constants

Base\Serializer\Encoder

Base\Service

  • Analytics class

    Single entry point for this app's traffic counters: page views (a raw hit count per path) plus two independent unique-subject counters - anonymous "visitors" (cookie-identified, see the consent note on trackVisitor()) and authenticated "users" (Base\Entity\User ids) - both sliceable by the same time windows (today/24h, 7 days, 30 days, all time) because they're built on the exact same underlying mechanism (Base\Entity\Analytics\Visit's daily presence rows), just keyed differently. Storage/aggregation strategy lives in the two repositories; this class is the only thing application code (a request subscriber, an admin sidebar widget, ...) needs to know about.

    13 methods

  • ArrayParameterBag class

    The application's parameters given as an array, by their full names ("base.attributes.use_custom" => true), read by a dotted path as Base\Service\ParameterBag reads the container's: omnibase's ParameterBagInterface where there is no container (an entity manager built by hand, Base\Bridge\Doctrine\Mapping). A path names a value or the values under it ("base.attributes" is ['use_custom' => true, ...]).

    5 methods

  • BaseService class

    54 methods

  • Breadgrinder class

    3 methods

  • BreadgrinderInterface interface

    1 method

  • ColorExtractor class

    2 methods

  • CommentGuard class

    The comment forms' face of Base\Service\FormGuard, kept for the bundles that ask it (omnibase/blog, omnibase/video): the trap filled, a form sent faster than a person types, a second comment from the same address within the flood interval (base.comments.min_delay, base.comments.flood_interval).

    2 methods · 3 constants

  • DownloadLinks class

    Signed download links: a route's absolute URL, signed by Symfony's UriSigner and valid for a while (base.download_links.ttl seconds unless told otherwise). Whoever holds one within that time gets the file - who may was checked when it was handed out (a licence, an entitlement, a voter). The one place for it: omnibase/forge's artifacts and omnibase/classroom's resources sign theirs here.

    4 methods

  • EditorEnhancer class

    8 methods

  • EditorEnhancerInterface interface

  • Embeds class

    An address (a video, a song, a board, a slideshow) turned into what a page can frame - the Twig function embed_url():

    3 methods · 1 constant

  • FileService class

    19 methods · 1 constant

  • FileServiceInterface interface

    7 methods

  • Flysystem class

    23 methods

  • FlysystemInterface interface

    20 methods

  • FormGuard class

    What stands between a form and a robot, in the order it is asked (docs/20-architecture/guard.md):

    21 methods · 17 constants

  • GroupManager class

    The one service that turns a score into an actual capability.

    4 methods

  • HotParameterBag class

    6 methods · 1 constant

  • HotParameterBagInterface interface

    5 methods

  • IconProvider class

    8 methods

  • Invitations class

    Invitation by token: nobody signs up, someone is invited. The token is random, sent once and never stored - only its SHA-256 is kept, so a leaked table opens nothing. Following the link creates the account (the link proved the address) or attaches the one that exists.

    9 methods · 1 constant

  • Launcher class

    5 methods

  • LauncherInterface interface

    4 methods

  • LocalBusiness class

    schema.org's LocalBusiness for the page's JSON-LD: who the business is, where, how to reach it, when it is open. Search engines read the address, the phone and the hours (the days off too) from there.

    3 methods · 1 constant

  • Localizer class

    41 methods · 3 constants

  • LocalizerInterface interface

    28 methods

  • MaintenanceProvider class

    7 methods

  • MaintenanceProviderInterface interface

    6 methods

  • MediaService class

    26 methods

  • MediaServiceInterface interface

    8 methods

  • Obfuscator class

    9 methods

  • ObfuscatorInterface interface

    2 methods · 2 constants

  • OpeningHours class

    When the place is open - one service for the footer, a banner, the time slots a customer may wish for, the day an order is for and the page's JSON-LD.

    20 methods

  • Paginator class

    2 methods

  • PaginatorInterface interface

    1 method

  • ParameterBag class

    The Symfony adapter of omnibase's Base\Service\ParameterBagInterface: the container's parameters (it decorates `parameter_bag`), read by a dotted path, and DependencyInjection's ParameterBagInterface as well (through ContainerBag) for the code that types that one.

    4 methods

  • ParameterBagInterface interface

    The parameters of the application, read by a dotted path ("base.uploader.storage"), as omnibase's code asks for them: the core's contract, with no class of the framework (plan "omnibase agnostique", step C3c).

    4 methods

  • Redirections class

    Where an address that is not found leads now (Base\Entity\Layout\Redirection).

    3 methods

  • Referrer class

    8 methods

  • ReferrerInterface interface

    4 methods

  • SecurityPolicy class

    The site-wide account-security policy an administrator sets, and the single place that decides what a *user* is then allowed to change about their own account.

    16 methods · 8 constants

  • SettingBag class

    31 methods

  • SettingBagInterface interface

    6 methods

  • SettingSnapshotValue class

    Opaque per-locale value holder used inside a compiled SettingBag snapshot tree, standing in for the live Setting entity that same tree position holds in SettingBag::normalize()'s entity-tree shape. Kept as an object (not a plain array) so array_map_recursive() treats it as a leaf and does not recurse into the per-locale map itself.

    1 method · 1 property

  • Sharing class

    5 methods

  • SharingInterface interface

    1 method

  • Signatures class

    Documents signed through glitchr/omnisign, for any entity of the application: an envelope sent (send()), signed by e-mail or in the site's page (signingUrl()), followed (refresh(), or the provider's webhook: notify()), and once completed its signed document and evidence kept in the private storage (base.signatures.storage: the uploads', out of public/). Each move is a SignatureEvent; the application answers on what the envelope is about.

    13 methods

  • Sitemapper class

    10 methods

  • SitemapperInterface interface

    6 methods

  • SpamChecker class

    Is what a visitor wrote spam? The classifier of glitchr/omnishield behind omnibase's SpamCheckerInterface (check, score), which the forms (spam_protection), the comments and omnibase/faq's questions ask:

    9 methods

  • SpamCheckerInterface interface

    2 methods

  • SpeculativeRequest class

    Tells a speculative request - one a client made ahead of any user action, hoping to have the answer ready - from a real one.

    1 method

  • SystemOfUnits class

    1 method

  • Themizer class

    16 methods

  • ThemizerInterface interface

    12 methods

  • TimeMachine class

    32 methods · 1 constant

  • TimeMachineInterface interface

    5 methods

  • TimelineEventProviderInterface interface

    A source of "worth marking on a timeline" events (a deploy, a campaign launch, ...), collected by base-bundle-admin's TimelineEventRegistry and rendered as annotations on the analytics dashboard chart. Lives here (not base-bundle-admin) for the same reason Analytics does: it's a domain concept, not an admin-UI-specific one - a future non-admin consumer (a public changelog widget, a CLI report) could reuse it without depending on the admin package.

    1 method

  • Trading class

    20 methods

  • TradingInterface interface

    13 methods

  • Translator class

    21 methods · 21 constants

  • TranslatorInterface interface

    12 methods · 3 constants

  • TrashManager class

    Reads and empties what TrasheableSubscriber put aside.

    8 methods · 1 constant

  • VersionManager class

    Reads back what VersionableSubscriber wrote.

    4 methods

  • WidgetProvider class

    7 methods

  • WidgetProviderInterface interface

    4 methods

  • WysiwygEnhancer class

    9 methods

  • WysiwygEnhancerInterface interface

    8 methods

Base\Service\Analytics

  • UserAgentClassifier class

    Buckets a request's User-Agent into one of three Base\Entity\Analytics\ PageView::SOURCE_* values. AI checks run first and take priority over the generic crawler-detect pass: several AI crawlers (GPTBot, ClaudeBot, ...) also match generic bot heuristics, but they deserve their own bucket (SOURCE_AI) rather than falling into the catch-all SOURCE_BOT one - that split is the whole point of this class over just jaybizzle/crawler-detect's plain isCrawler() boolean.

    2 methods

Base\Service\Calendar

  • CalendarEntry class

    One date as a calendar sees it, whatever it was in the site: a concert (omnibase/agenda's Event), an appointment, a class, a pick-up. What Ics and GoogleCalendarLink write from - a bundle maps its own entity to one (see omnibase/agenda's Event::toCalendarEntry()).

    3 methods · 13 properties · 1 constant

  • GoogleCalendarLink class

    The "add to Google Calendar" link of a date: Google's own template page, filled in. Hours go in UTC with the date's timezone beside them (ctz), whole days as dates, the last one excluded as Google wants it.

    1 method · 1 constant

  • Ics class

    Dates as an iCalendar file (RFC 5545), written by hand: a calendar a phone subscribes to, or one date to add. Lines end with CRLF and are folded at 75 octets, texts are escaped, an hour is given in the date's timezone (with the VTIMEZONE that defines it) or in UTC, a date of whole days as dates. Moved here from omnibase/agenda, on CalendarEntry.

    5 methods · 1 constant

Base\Service\Collab

  • CollabRoomResolver class

    This class supplies room-key logic and version-hash logic for the real-time collaboration feature. EditorType uses this class.

    5 methods

  • CollabTicketFactory class

    This class creates a short-lived, signed ticket. A browser presents this ticket to the collab relay (relay/src/server.js in editorjs-yjs), to join a room's WebSocket connection. The relay checks the signature by itself.

    5 methods

Base\Service\Model

  • Autocomplete class

    3 methods

  • AutocompleteInterface interface

    2 methods

  • Autovalidate class

    2 methods

  • AutovalidateInterface interface

  • Breadcrumb class

    38 methods

  • BreadcrumbInterface interface

  • CacheableInterface interface

    3 methods

  • ClassAliases class

    omnibase's class convention, without the bundle: App\Entity\X is Base\Entity\X when the application declares no App\Entity\X of its own - and so for App\Repository, App\Enum, App\Tests, App\Notifier, App\Form. Under Symfony, BaseBundle::warmUp() declares these aliases from its pool and AbstractBaseBundle's last-resort autoloader answers by the same convention (it asks base()); an entity manager built by hand (Base\Bridge\Doctrine\ Mapping) registers the convention as an autoloader of its own - an association names its target App\Entity\User\Notification.

    2 methods · 1 constant

  • ClassFinder class

    The classes a folder of PHP files declares, read from the files: each file's namespace and its name, the interfaces (*Interface.php) and the empty files left out - what Base\Bundle\AbstractBaseBundle::getAllClasses() answers, without loading the bundle (and with it the framework) to ask.

    1 method

  • ColorizeInterface interface

    2 methods

  • GraphInterface interface

    3 methods

  • HtmlizeInterface interface

    1 method

  • IconizeInterface interface

    2 methods

  • IntlDateTime class

    3 methods

  • LinkableInterface interface

    A thing with an address. $referenceType is one of Symfony's UrlGeneratorInterface reference types, by their values (Base\Contract\Link's constants, so that the interface names nothing of the routing component); Link::to() makes the address through the Urls contract.

    2 methods

  • LocaleNormalizer class

    omnibase's locale form, xx-XX, without the framework (plan "omnibase agnostique", C3e): the rule Base\Service\Localizer::normalizeLocale() and __toLocaleLang() apply, taken out of the Localizer (a Symfony service, its statics filled at its warm-up), which now asks it with its own default and fallback locales - the same strings, by construction.

    4 methods · 1 constant

  • Pagination class

    27 methods

  • PaginationInterface interface

    8 methods

  • SaltInterface interface

    1 method

  • SelectInterface interface

    4 methods

  • SitemapEntry class

    15 methods

  • SpamProtectionInterface interface

    4 methods

  • WorkflowInterface interface

    4 methods

Base\Service\Model\Color

Base\Service\Model\Color\Intl

  • Colors class

    8 methods · 1 constant

Base\Service\Model\Currency

Base\Service\Model\Currency\Api

Base\Service\Model\IconProvider

Base\Service\Model\IconProvider\Adapter

Base\Service\Model\Obfuscator

Base\Service\Model\Obfuscator\Compression

Base\Service\Model\Sharing

Base\Service\Model\Sharing\Adapter

Base\Service\Model\Wysiwyg

Base\Service\Push

  • WebPushService class

    Web Push delivery (RFC 8030 + VAPID) to the browsers a user enabled notifications in. The service is a no-op until VAPID keys are configured (VAPID_PUBLIC_KEY / VAPID_PRIVATE_KEY / VAPID_SUBJECT), so the rest of the notification center works without it - the in-app list, the badge - and push simply switches on the day the keys land in .env.local.

    9 methods

Base\Service\Qr

  • QrCode class

    A QR code for an address (or any text), drawn by endroid/qr-code: as SVG - sharp at any print size, the default - or PNG. Used by QrSheet for its pages, and directly for a poster or a ticket:

    2 methods

  • QrSheet class

    QR codes laid out on A4 pages to print: one big code per page (a poster for a counter, a door, a table), or a sheet of Avery labels - each label a code and a caption, at the label's place on the sheet, in millimetres.

    4 methods · 1 constant

Base\Subscriber

  • AnalyticsSubscriber class

    4 methods

  • DemoBackOfficeSubscriber class

    The back office in a demonstration (registered in the `demo` environment only): open to nobody with a password everyone knows. Two tiers, a secret each:

    4 methods

  • DemoSubscriber class

    Two of the demonstration's safeguards (registered in the `demo` environment only, config/services/demo.php):

    4 methods

  • EntityDispatcherFlushSubscriber class

    Flushes what the entity dispatchers' listeners changed (a thread published by its "publishable" event, a user's welcome state...), once the flush that raised those events is completely over: when the response goes out, when a command ends, after each message a worker handles. See AbstractEventDispatcher::$flushPending for why not from postFlush.

    4 methods

  • FlashBagSubscriber class

    2 methods

  • HotParameterBagSubscriber class

    3 methods

  • IntegritySubscriber class

    10 methods · 1 constant

  • IsGrantedSubscriber class

    3 methods

  • LocalizerSubscriber class

    5 methods · 4 constants

  • MailTrapSubscriber class

    Stops mail at the last possible moment when the trap is armed.

    3 methods

  • NewDeviceSubscriber class

    Reacts to an account being signed into from a browser it has not been signed into before: tells the user by email (administrator's switch), and on an account with no second factor, flags the session so the next page offers - once, optionally - to set up a one-time code (SecurityEnrolmentSubscriber, UserSettingsController::Enrolment).

    3 methods

  • NotifierSubscriber class

    3 methods

  • PageViewSubscriber class

    Records one Base\Service\Analytics::track() call per trackable request.

    3 methods

  • PasswordChangeSubscriber class

    An account made with a password it did not choose (user:create) carries a "change-password" token: until its owner has chosen one, every page sends them to security_changePassword.

    3 methods · 1 constant

  • ProfilerSubscriber class

    4 methods

  • RedirectionSubscriber class

    A page that is not found is looked up in the redirections (Base\Entity\Layout\Redirection) before the 404 is answered: the old addresses of a site taken over lead to its new pages.

    3 methods

  • ReferrerSubscriber class

    Where a visitor comes back to after signing in: the last page they read.

    7 methods

  • RequestScopedStateSubscriber class

    Clears static state that is really request-scoped, for processes that outlive a request: FrankenPHP worker mode and messenger consumers.

    3 methods · 1 constant

  • RouterSubscriber class

    4 methods

  • SecondLevelCacheConsoleSubscriber class

    Doctrine's second-level cache emptied after a command that rewrites the database behind the ORM's back: doctrine:fixtures:load purges the tables with DELETE / TRUNCATE and numbers the new rows from 1 again, so the cache went on answering yesterday's entity for today's id (a product under another one's name, a deleted page still shown) until it expired.

    4 methods · 1 constant

  • SecurityEnrolmentSubscriber class

    Sends a signed-in user to the enrolment prompt once, when a second factor is mandatory for this account - the administrator made it so for everyone, or the application requires it of one of the account's roles (base.security.two_factor.required_roles) - and the account has none.

    3 methods

  • SecuritySubscriber class

    10 methods

  • TemplatedEmailSubjectSubscriber class

    A TemplatedEmail's subject written in its template:

    3 methods

  • TwigSubscriber class

    5 methods · 1 constant

  • ValidCacheSubscriber class

    Marks the bundle cache as valid early in the request cycle. Sole survivor of the former EagerSubscriber: its eager-construction duty is obsolete now that AttributeReader's constructor is metadata-free (the heavy precompute moved to AttributeCacheWarmer) and BaseTrait statics resolve lazily through the base.runtime locator.

    2 methods

Base\Traits

  • BagTrait trait

    2 methods

  • BaseCommonTrait trait

    25 methods

  • BaseTrait trait

    Static service accessors usable from anywhere (entities, attributes, subscribers, ...). Backed by BaseService's static properties, which are populated EITHER eagerly by BaseService's constructor (when something actually injects it) OR lazily, one service at a time, through the `base.runtime` ServiceLocator seeded in BaseBundle::boot() — see BaseCommonTrait::runtimeGet(). Nothing here forces BaseService's full dependency graph to be built anymore.

    33 methods

  • CacheClearTrait trait

  • CacheableTrait trait

    3 methods

  • ProxyTrait trait

    4 methods

  • SimpleCacheTrait trait

    9 methods

  • SingletonTrait trait

    6 methods

  • UserInfoTrait trait

    7 methods · 2 constants

Base\Translation

  • OverridingTranslator class

    The site's texts as the team rewrote them in the back office (Base\Entity\Layout\TextOverride, omnibase/admin's "Textes du site"): a rewritten key, in that language, wins over translations/. Between omnibase's translator (which resolves "@messages.key" and falls back between languages) and Symfony's: it sees a plain key and domain, and only answers when it has something.

    11 methods · 1 constant

  • TextOverrideCacheListener class

    A rewritten text saved or deleted: the next page reads them all again.

    5 methods

Base\Twig

  • AppVariable class

    7 methods · 10 properties

  • AssetPackage class

    This defines a Symfony Asset named package that groups all the assets provided by EasyAdmin. This is needed because EasyAdmin uses asset versioning, so the full absolute URLs of assets isn't known (the URL contain changing hashes).

    5 methods · 1 constant

  • Environment class

    11 methods

  • Globals class

    2 methods

Base\Twig\Extension

  • AccountTwigExtension class

    account_profile(user): a member's profile as its view model (Base\Screen\Account\ProfilePage), as the visitor asking sees it - what a host page gives the core's profile template when it renders it with the user alone (lesringostars' /profile/of/{username}: `@Base/client/user/profile_show.html.twig` with `{user}`), so that the template reads its screen whoever renders it (plan "omnibase agnostique", C5). Answered by the AccountScreens runtime.

    1 method

  • AnalyticsTwigExtension class

    Thin Twig-side wrapper around Base\Service\Analytics - lets any template (the admin sidebar widget, a future public "N readers this week" badge, ...) reach the counters directly, without every consumer needing its own controller/Twig-global plumbing just to display a number.

    8 methods

  • BreadgrinderTwigExtension class

    4 methods

  • ClassTwigExtension class

    3 methods

  • ClipboardTwigExtension class

    4 methods

  • CommonsTwigExtension class

    The shared bricks, in a template (docs/40-commons):

    4 methods

  • DemoTwigExtension class

    The demonstration in a template (docs/20-architecture/demo.md): {% if demo_mode() %}...{% endif %} the `demo` environment, and no other {% for account in demo_accounts() %} the declared accounts a visitor may sign in as @Base/demo/_banner.html.twig and @Base/demo/_accounts.html.twig are what a layout and a sign-in page include; both print nothing outside `demo`. The banner names the first of these accounts to a visitor who is not signed in.

    3 methods

  • DeployVersionExtension class

    A value that changes on every real deploy and stays stable otherwise - meant to be fed into a client-side cache key (e.g.

    3 methods

  • FormTwigExtension class

    6 methods

  • FunctionTwigExtension class

    omnibase's Twig functions and filters. html_attributes, mb_ucfirst, second, join_if_exists and less_than are omnibridge/twig's HelperExtension's (registered beside this one, the same results); str_shorten, highlight and datetime stay here, they do more than its copies (str_shorten's SHORTEN_BACK_SHRINK/EXTEND, highlight's excerpt, datetime's patterns lists, intervals and formats), and win over them.

    44 methods

  • HtmlTwigExtension class

    10 methods

  • LocalBusinessTwigExtension class

    schema.org's LocalBusiness in a template (docs/40-commons/local-business.md):

    2 methods

  • LocalizerTwigExtension class

    8 methods

  • MathTwigExtension class

    4 methods

  • MediaTwigExtension class

    17 methods

  • NotificationTwigExtension class

    What a toolbar needs to draw the bell: the unread count (the red dot), the latest entries (the dropdown), and the two things its script needs - the CSRF token every mutation carries and whether push can be offered at all.

    8 methods

  • OAuthTwigExtension class

    oauth_available('google'): whether a "continue with ..." button can lead anywhere - the provider is declared in hwi_oauth.resource_owners of some firewall AND has a client id. A site that leaves the id empty (a sandbox, a provider not set up yet) keeps the declaration without showing a button that ends on the provider's error page.

    3 methods

  • PaginatorTwigExtension class

    17 methods

  • SecurityPolicyTwigExtension class

    Exposes the administrator's account-security policy to every template as `security_policy`.

    2 methods

  • SemanticTwigExtension class

    3 methods

  • SharingFilter class

    5 methods

  • ThemizerTwigExtension class

    7 methods

  • TradingTwigExtension class

    5 methods

  • TranslatorTwigExtension class

    3 methods

  • WebpackTwigExtension class

    1 method

  • WidgetTwigExtension class

    4 methods

Base\Twig\Loader

Base\Twig\Renderer

Base\Twig\Renderer\Adapter

Base\Twig\Variable

Base\Validator

Base\Validator\Constraints

App\Controller

DemoController class

class DemoController extends AbstractController DemoController.php:18

A deliberately flat, style-free tour of a few base-bundle features.

Every section runs in isolation so a failing feature reports its error instead of breaking the whole page.

DemoController::index()

public function index(SettingBagInterface $settings, ObfuscatorInterface $obfuscator, TranslatorInterface $translator, EntityManagerInterface $em): Response

Base

BaseBundle class

class BaseBundle extends AbstractBaseBundle BaseBundle.php:31

const VERSION = '1.0.0'

BaseBundle::__construct()

public function __construct()

BaseBundle::getCacheDir()

public function getCacheDir(): string

BaseBundle::getPublicDir()

public function getPublicDir(): string

BaseBundle::getSourceDir()

public function getSourceDir(): string

BaseBundle::getEnvironment()

public function getEnvironment(): string

BaseBundle::isBooted()

public function isBooted()

BaseBundle::isDoctrineReady()

public function isDoctrineReady(): bool

BaseBundle::isInvalid()

public function isInvalid(): bool

BaseBundle::markCacheAsValid()

public function markCacheAsValid(): void

BaseBundle::warmUp()

public function warmUp()

BaseBundle::boot()

public function boot(): void

BaseBundle::shutdown()

public function shutdown(): void

A kernel that shuts down handles no request any more. get_url() reads the main request first, through BaseService's static stack, which outlives the kernel: a request left on it (a test that pushed one and never popped it) was the current address of every call made after the kernel was gone, instead of PHP's globals.

BaseBundle::isBuilt()

public function isBuilt()

BaseBundle::build()

public function build(ContainerBuilder $container): void

Base\ApiPlatform\Metadata\Resource\Factory

OverriddenResourceNameCollectionFactory class

final class OverriddenResourceNameCollectionFactory implements ResourceNameCollectionFactoryInterface OverriddenResourceNameCollectionFactory.php:31

Keeps one API resource per class the application actually uses.

API Platform scans every bundle's Entity directory, so base-bundle's own resources (Base\Entity\User, Base\Entity\Thread) are collected next to the application's, and two things make the same resource show up twice:

  • An App\ override: App\Entity\User mirrors Base\Entity\User and extends it. Both declare the same operations under the same names.
  • A class alias: where the application has no override, App\Entity\X is an alias of Base\Entity\X. PHP lists an alias among the declared classes - lowercased ("app\entity\thread") - so the scan finds the same class under a second name.

API Platform used to let the second declaration silently replace the first; since 4.3.18 it refuses, and the router - so the whole kernel - fails.

So entries naming the same class collapse into one, under its real name, and a Base\ resource that an App\ class extends gives way to it: the override is the resource the application means. A Base\ resource only extended under another name (App\Entity\Article extends Base\Entity\Thread) stays, since their operations do not collide.

OverriddenResourceNameCollectionFactory::__construct()

public function __construct(readonly ResourceNameCollectionFactoryInterface $decorated)

OverriddenResourceNameCollectionFactory::create()

public function create(): ResourceNameCollection

Base\Attributes

AbstractAttribute class

abstract class AbstractAttribute implements AttributeInterface AbstractAttribute.php:34

AbstractAttribute::getAttributeReader()

public static function getAttributeReader(): ?AttributeReader

AbstractAttribute::getEnvironment()

public static function getEnvironment(): string

AbstractAttribute::getProjectDir()

public static function getProjectDir(): string

AbstractAttribute::getParameterBag()

public static function getParameterBag(): ParameterBagInterface

AbstractAttribute::getEntityManager()

public static function getEntityManager(): ?EntityManager

AbstractAttribute::getEntityHydrator()

public static function getEntityHydrator(): EntityHydratorInterface

AbstractAttribute::getTypeOfField()

public static function getTypeOfField($className, string $property)
Throws

Exception

AbstractAttribute::getClassMetadata()

public static function getClassMetadata($objectOrClass): ?ClassMetadata

AbstractAttribute::getClassMetadataManipulator()

public static function getClassMetadataManipulator(): ?ClassMetadataManipulator

AbstractAttribute::getClassMetadataCompletor()

public static function getClassMetadataCompletor(mixed $entityOrClassOrMetadata): ?ClassMetadataCompletor

AbstractAttribute::getFlysystem()

public static function getFlysystem(): FlysystemInterface

AbstractAttribute::getImpersonator()

public static function getImpersonator(): ?User

AbstractAttribute::getUser()

public static function getUser(): ?User

AbstractAttribute::getRepository()

public static function getRepository($className): EntityRepository|ObjectRepository

AbstractAttribute::getAsset()

public static function getAsset($url): string

AbstractAttribute::resolveAttributes()

public static function resolveAttributes($entityOrClassNameOrMetadataOrRefl, string $mappingPath, ?string $attributeClass = null): array

Resolve the attribute instances mapped at $mappingPath for an entity/class (optionally filtered to $attributeClass). Named resolveAttributes rather than getAttributes: several #[Attribute] subclasses (e.g. IsGranted) have their own unrelated instance-level getAttributes()/setAttributes() pair, which a same-named static method here would collide with (incompatible static/instance override).

Throws

Exception

AbstractAttribute::getAttribute()

public static function getAttribute($entityOrClassNameOrMetadataOrRefl, string $mapping, string $attributeClass): mixed

AbstractAttribute::hasAttribute()

public static function hasAttribute($entityOrClassNameOrMetadataOrRefl, string $mapping, string $attributeClass): bool

AbstractAttribute::getUnitOfWork()

public static function getUnitOfWork(): UnitOfWork

Minimize the use unit of work to very specific context.. (doctrine internal use only) Please use getNativeEntity() to get back the

AbstractAttribute::getEntityChangeSet()

public static function getEntityChangeSet($entity): array|PersistentCollection

AbstractAttribute::getSerializer()

public static function getSerializer(): ?Serializer

AbstractAttribute::isSerializable()

public static function isSerializable(AbstractAttribute $attribute): bool

AbstractAttribute::getPropertyOwnerRepository()

public function getPropertyOwnerRepository($entity, string $property): EntityRepository
Returns

the repository of the class declaring $property (an omnibase repository, Base\Database\Repository\ServiceEntityRepository, or any other)

Throws

NotSupported

AbstractAttribute::getEntityFromData()

public static function getEntityFromData($classname, $data): ?object

AbstractAttribute::getOriginalEntity()

public static function getOriginalEntity($entity): ?object
Throws

MappingException

AbstractAttribute::getOriginalEntityData()

public static function getOriginalEntityData($entity): ?array
Throws

MappingException

AbstractAttribute::getOldEntity()

public static function getOldEntity($entity): ?object

AbstractAttribute::getOldEntityData()

public static function getOldEntityData($entity): ?array

AbstractAttribute::hasField()

public static function hasField($entity, string $property): bool

AbstractAttribute::getFieldValue()

public static function getFieldValue($entity, string $property)
Throws

Exception

AbstractAttribute::setFieldValue()

public static function setFieldValue($entity, string $property, $value): false|ClassMetadataManipulator

AbstractAttribute::hasProperty()

public static function hasProperty($entity, string $property): bool

AbstractAttribute::getPropertyValue()

public static function getPropertyValue($entity, string $property)

AbstractAttribute::setPropertyValue()

public static function setPropertyValue($entity, string $property, $value): ClassMetadataManipulator

AbstractAttribute::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

AbstractAttribute::resolveDiscriminator()

public function resolveDiscriminator(ResolveDiscriminatorEventArgs $args): void

AbstractAttribute::preQuery()

public function preQuery(DoctrineQueryEventArgs $args): void

AbstractAttribute::onQuery()

public function onQuery(DoctrineQueryEventArgs $args): void

AbstractAttribute::postQuery()

public function postQuery(DoctrineQueryEventArgs $args): void

AbstractAttribute::preFlush()

public function preFlush(PreFlushEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

AbstractAttribute::onFlush()

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

AbstractAttribute::postFlush()

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

AbstractAttribute::prePersist()

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

AbstractAttribute::preUpdate()

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

AbstractAttribute::preRemove()

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

AbstractAttribute::postLoad()

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

AbstractAttribute::postPersist()

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

AbstractAttribute::postUpdate()

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

AbstractAttribute::postRemove()

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

AttributeInterface interface

interface AttributeInterface AttributeInterface.php:13

AttributeInterface::supports()

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

AttributeInterface::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null)

AttributeInterface::resolveDiscriminator()

public function resolveDiscriminator(ResolveDiscriminatorEventArgs $args): void

AttributeInterface::preQuery()

public function preQuery(DoctrineQueryEventArgs $args): void

AttributeInterface::onQuery()

public function onQuery(DoctrineQueryEventArgs $args): void

AttributeInterface::postQuery()

public function postQuery(DoctrineQueryEventArgs $args): void

AttributeInterface::preFlush()

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

AttributeInterface::onFlush()

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

AttributeInterface::postFlush()

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

AttributeInterface::prePersist()

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

AttributeInterface::preUpdate()

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

AttributeInterface::preRemove()

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

AttributeInterface::postPersist()

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

AttributeInterface::postUpdate()

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

AttributeInterface::postRemove()

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

AttributeReader class

class AttributeReader extends AbstractLocalCache AttributeReader.php:30

const TARGET_CLASS = "class"
const TARGET_METHOD = "method"
const TARGET_PROPERTY = "property"
const ALL_TARGETS = [self::TARGET_CLASS, self::TARGET_METHOD, self::TARGET_PROPERTY]

AttributeReader::addAttribute()

public function addAttribute($attributes): self

AttributeReader::getEntityManager()

public function getEntityManager()

AttributeReader::getRepository()

public function getRepository($entity)
Throws

NotSupported

AttributeReader::isEntity()

public function isEntity(mixed $entity): bool

AttributeReader::getEntityHydrator()

public function getEntityHydrator(): EntityHydratorInterface

AttributeReader::getClassMetadataManipulator()

public function getClassMetadataManipulator(): ClassMetadataManipulator

AttributeReader::getFlysystem()

public function getFlysystem(): ?FlysystemInterface

AttributeReader::getParameterBag()

public function getParameterBag(): ParameterBagInterface

AttributeReader::__construct()

public function __construct(?EventDispatcherInterface $eventDispatcher, ?AdvancedRouterInterface $router, EntityManager $entityManager, ParameterBagInterface $parameterBag, ?FlysystemInterface $flysystem, ?RequestStack $requestStack, ?TokenStorageInterface $tokenStorage, EntityHydrator $entityHydrator, ClassMetadataManipulator $classMetadataManipulator, string $projectDir, string $environment, string $cacheDir)

The event dispatcher, the router, the filesystem, the request stack and the token storage are the framework's, and may be null: an entity manager built by hand (Base\Bridge\Doctrine\Mapping) reads the attributes of its entities with none of them - what needs one (an asset's base path, the user signed in, the routes' attributes) answers without it.

AttributeReader::getEnvironment()

public function getEnvironment()

AttributeReader::getProjectDir()

public function getProjectDir()

AttributeReader::getPaths()

public function getPaths(): array

AttributeReader::addPath()

public function addPath(string $path): self

AttributeReader::configuredPaths()

public static function configuredPaths(ParameterBagInterface $parameterBag): array

The folders base.attributes.paths names. The configuration's list is in the bag whole (base.attributes.paths) and item by item (base.attributes.paths.0, .1...: omnibase's flattened parameters, and what Base\Bridge\Doctrine\Mapping gives an entity manager built by hand); the pattern that read them wanted a dot after the number (paths.0.), which no key has, so none was ever read.

AttributeReader::getAsset()

public function getAsset(string $url): string

AttributeReader::getUser()

public function getUser(): ?UserInterface

AttributeReader::getImpersonator()

public function getImpersonator(): ?User

AttributeReader::getAttributeNames()

public function getAttributeNames(): array

AttributeReader::addAttributeName()

public function addAttributeName(string $attributeName)

AttributeReader::removeAttributeName()

public function removeAttributeName(string $attributeName)

AttributeReader::getAttributeTargets()

public function getAttributeTargets(object|string $className): array

AttributeReader::getParent()

public function getParent(string $className): ?string

Everything related to hierarchy

AttributeReader::getAncestor()

public function getAncestor($className): ?string

AttributeReader::getAncestorAttributes()

public function getAncestorAttributes($className, $attributeNames = null, $attributeTargets = [])
Throws

Exception

AttributeReader::getParentAttributes()

public function getParentAttributes($className, $attributeNames = null, $attributeTargets = [])
Throws

Exception

AttributeReader::getChildren()

public function getChildren($className)

AttributeReader::getChildrenAttributes()

public function getChildrenAttributes($className, $attributeNames = null, $attributeTargets = [])
Throws

Exception

AttributeReader::getClassAttributes()

public function getClassAttributes(mixed $classNameOrMetadataOrRefl, mixed $attributeNames = null, array $attributeTargets = []): array

AttributeReader::getMethodAttributes()

public function getMethodAttributes(mixed $classNameOrMetadataOrRefl, mixed $attributeNames = null, array $attributeTargets = []): array

AttributeReader::getPropertyAttributes()

public function getPropertyAttributes(mixed $classNameOrMetadataOrRefl, mixed $attributeNames = null, array $attributeTargets = []): array

AttributeReader::getReflClass()

public function getReflClass($classNameOrMetadataOrRefl)

AttributeReader::normalizeNames()

public function normalizeNames(mixed $attributeNames, bool $fallbackAttributeNames = true): ?array

AttributeReader::normalizeTargets()

public function normalizeTargets($attributeTargets, $attributeNames)
Throws

Exception

AttributeReader::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

AttributeReader::precompute()

public function precompute(): void

Precompute attributes for every entity class and every routed controller. Iterating the ROUTE COLLECTION makes ApiPlatform load entity metadata, so this must NEVER run from a runtime constructor — only from the cache warmer (cache:clear / cache:warmup), where no Doctrine event dispatch is in flight. Idempotent per cache lifetime via executeOnce.

AttributeReader::getAttributes()

public function getAttributes($classNameOrMetadataOrRefl, $attributeNames = null, array $attributeTargets = []): array
Throws

Exception

Base\Attributes\Attribute

Iconize class

class Iconize extends AbstractAttribute Iconize.php:13

Class Iconize package Base\Attributes\Attribute\Iconize

Iconize::__construct()

public function __construct(array|string $icons = [])

Iconize::supports()

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

Iconize::getIcons()

public function getIcons()

IsGranted class

class IsGranted extends AbstractAttribute IsGranted.php:12

IsGranted::__construct()

public function __construct(array|string|Expression $attributes, array|string|Expression|null $subject = null, ?string $message = null, ?int $statusCode = null)

IsGranted::supports()

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

IsGranted::setAttributes()

public function setAttributes($attributes)

IsGranted::getAttributes()

public function getAttributes()

IsGranted::setSubject()

public function setSubject($subject)

IsGranted::getSubject()

public function getSubject()

IsGranted::getMessage()

public function getMessage()

IsGranted::setMessage()

public function setMessage($message)

IsGranted::getStatusCode()

public function getStatusCode()

IsGranted::setStatusCode()

public function setStatusCode($statusCode)

IsGranted::setValue()

public function setValue($value)

IsGranted::getAliasName()

public function getAliasName()

IsGranted::allowArray()

public function allowArray()

Route class

class Route extends Route Route.php:14

Attribute class for @Route().

const TRANSLATIONS_FILE = "/config/routes_paths.yaml"

Path relative to the project directory of the central route path dictionary consulted when $path is a bare key (see __construct()).

Route::__construct()

public function __construct(string|array|null $path = null, ?string $name = null, array $requirements = [], array $options = [], array $defaults = [], ?string $host = null, ?string $domain = null, ?string $subdomain = null, ?string $machine = null, ?int $port = null, array|string $methods = [], array|string $schemes = [], ?string $condition = null, ?int $priority = null, ?string $locale = null, ?string $format = null, ?bool $utf8 = null, ?bool $stateless = null, ?string $env = null)

Sitemap class

class Sitemap extends AbstractAttribute Sitemap.php:21

Class Sitemap package Base\Attributes\Attribute\Sitemap

Sitemap::__construct()

public function __construct(?string $group = null, float $priority = 0.5, string $changefreq = "daily", ?string $lastmod = null)

Sitemap::getUrls()

public static function getUrls()

Sitemap::getGroup()

public function getGroup()

Sitemap::getLastMod()

public function getLastMod()

Sitemap::getChangeFreq()

public function getChangeFreq()

Sitemap::getPriority()

public function getPriority()

Sitemap::supports()

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

Base\Attributes\Traits

HierarchifyTrait trait

trait HierarchifyTrait HierarchifyTrait.php:7

HierarchifyTrait::getHierarchy()

public function getHierarchy($id = -1, ?string $separator = null)
Throws

Exception

HierarchifyTrait::getHierarchyDepth()

public function getHierarchyDepth(?string $separator = null)
Throws

Exception

HierarchifyTrait::getHierarchyTree()

public function getHierarchyTree(?string $separator = null)
Throws

Exception

Base\Bridge\Doctrine

Configuration class

final class Configuration Configuration.php:25

What omnibase adds to an entity manager's configuration (plan "omnibase agnostique", C6): the trash_filter (soft-deleted rows hidden) and the vault_filter (rows of another environment hidden), the DQL functions (RAND, FIELD, JSON_EXTRACT, JSON_SEARCH, JSON_CONTAINS, JSON_ARRAY_POSITION, those whose library is installed), the empty list of tree walkers as the default hint. DoctrineConfigurationPass hands the same lists to DoctrineBundle's configuration service; apply() sets them on a configuration built by hand.

const TRASH_FILTER = 'trash_filter'
const VAULT_FILTER = 'vault_filter'

Configuration::filters()

public static function filters(): array

Configuration::numericFunctions()

public static function numericFunctions(): array

Configuration::stringFunctions()

public static function stringFunctions(): array

Configuration::defaultQueryHints()

public static function defaultQueryHints(): array

Configuration::apply()

public static function apply(OrmConfiguration $configuration): void

Configuration::enableFilters()

public static function enableFilters(EntityManagerInterface $entityManager, string $environment): void

The two filters on, the vault's for the environment given: what BaseBundle::boot() does.

Mapping class

final class Mapping Mapping.php:72

omnibase's Doctrine mapping on an entity manager built by hand - no kernel, no container, no DoctrineBundle (plan "omnibase agnostique", C6):

$entityManager = Omnibridge\Doctrine\EntityManagers::create($connection, $paths, configure: Base\Bridge\Doctrine\Mapping::configure(...)); Base\Bridge\Doctrine\Mapping::register($entityManager, ['project_dir' => ..., 'environment' => 'prod']);

before the first metadata is read. It does what DoctrineBundle and the bundle do under Symfony:

  • the class convention (Base\Service\Model\ClassAliases: App\Entity\X is Base\Entity\X where the application has none);
  • the column types (Base\Bridge\Doctrine\Types): the core's, the enumerations of the core and of the project (src/Enum), those given;
  • the configuration: omnibase's naming strategy, the filters and the DQL functions (Base\Bridge\Doctrine\Configuration), the mapping driver wrapped (Base\Bridge\Doctrine\MappingDriver: the discriminator maps, the resolveDiscriminator event);
  • the repositories built from a registry (Base\Bridge\Doctrine\Registry, RepositoryFactory): configure() sets the factory on the configuration before the entity manager exists (omnibridge/doctrine's configure:), and the entity manager's own getRepository() hands them out;
  • the services the mapping reads through: the ClassMetadataManipulator (the completors: aliases, hierarchies), the AttributeReader (#[Alias], #[DiscriminatorEntry], #[Hierarchify], #[Cache], #[OrderColumn]...) with the parameters given and none of the framework's services;
  • the listeners, in the order DoctrineBundle gives them: AttributeSubscriber and IntlSubscriber (the translations' mapping, their discriminators, the walker of a translatable's query), the targets resolved, the entity listeners attached, the tracking policy, the extensions' index, then the soft deletion, the revisions and the inverse collections' cache on flush;
  • the trash and vault filters enabled, the vault for the environment.

Options: project_dir (the project's src/Enum and src/Attribute; the current directory by default), environment ("prod"), cache_dir (the reader's and the manipulator's caches; a folder of the system's temporary one by default), parameters (the application's, by full name: base.attributes.use_custom, base.extension.max_revisions...), types (by name, a bundle's enumerations), enumerations (more folders of enumerations), attribute_paths (more folders of attributes: a bundle's src/Attribute), resolve_target_entities (interface => class), entity_listeners (entity class => list of {event, class, method}: what a bundle tags doctrine.orm.entity_listener), localizer (a LocalizerInterface, none by default), filters (true: enabled).

Mapping::register()

public static function register(EntityManagerInterface $entityManager, array $options = []): self

Mapping::configure()

public static function configure(\Doctrine\ORM\Configuration $configuration): void

What an entity manager built by hand needs set before it exists: the repository factory (Doctrine keeps the one its configuration had at new EntityManager). Given to omnibridge/doctrine's EntityManagers::create() as its configure: closure; then the entity manager's getRepository() builds omnibase's ServiceEntityRepository and the applications' over it from the registry, as the bundle would.

Mapping::getRepository()

public function getRepository(string $className): EntityRepository

since step C6's follow-up: build the entity manager with configure() (omnibridge/doctrine's `configure:`) and ask its own getRepository() - the same repository. Kept for an entity manager built without it, whose own factory is Doctrine's default.

The repository of an entity as the bundle would hand it out: omnibase's ServiceEntityRepository and the applications' over it are built from the ManagerRegistry (Base\Bridge\Doctrine\Registry).

MappingDriver class

final class MappingDriver implements PersistenceMappingDriver MappingDriver.php:38

omnibase's mapping driver: the application's driver (attributes, a chain of them under DoctrineBundle), and around it what omnibase's ClassMetadataFactory did on a patched doctrine/orm (plan "omnibase agnostique", C6):

  • before the driver, the resolveDiscriminator event (Base\Database\Events): IntlSubscriber gives a translation class the inheritance and the discriminator map of its translatable; then the discriminator value of a concrete class is looked up in its map, as the factory did;
  • the table names checked: two entity classes may not take the same one;
  • after the driver, the discriminator map of a root entity that declares an inheritance and no map is generated: the class and every subclass the driver knows, each under its own class name. Doctrine would generate it itself, under the classes' short names - which collide here (App\Entity\ Thread\Tag, Base\Entity\Thread\Tag) - and its getShortName() is private: glitchr/base-plugin made it protected so that the factory could answer the class name. The map is now there before Doctrine looks, its keys those the factory gave, and #[DiscriminatorEntry] (AttributeSubscriber, loadClassMetadata) renames them as before.

Under Symfony the bundle wraps every entity manager's driver with it (DoctrineConfigurationPass); Base\Bridge\Doctrine\Mapping::register() does it for an entity manager built by hand. Doctrine's own ClassMetadataFactory is then enough: nothing here needs a member Doctrine keeps private.

MappingDriver::__construct()

public function __construct(readonly PersistenceMappingDriver $driver, EntityManagerInterface|\Closure|null $entityManager = null)

MappingDriver::getDriver()

public function getDriver(): PersistenceMappingDriver

MappingDriver::setEntityManager()

public function setEntityManager(EntityManagerInterface $entityManager): void

MappingDriver::loadMetadataForClass()

public function loadMetadataForClass(string $className, PersistenceClassMetadata $metadata): void

MappingDriver::getAllClassNames()

public function getAllClassNames(): array

The driver's classes, without the aliases: an attribute driver lists the classes PHP declared from its folders, and PHP lists a class_alias() among them, lower-cased (app\entity\thread\tag for App\Entity\ Thread\Tag, Base\Entity\Thread\Tag's alias). DoctrineBundle's chain dropped them by its namespaces' case; one attribute driver over every folder (an entity manager built by hand) did not.

MappingDriver::isTransient()

public function isTransient(string $className): bool

MappingDriver::__call()

public function __call(string $method, array $arguments): mixed

What else the application's driver answers (MappingDriverChain::getDrivers()...).

MetadataSnapshot class

final class MetadataSnapshot MetadataSnapshot.php:28

What an entity manager made of omnibase's mapping, as plain data that can be compared and written to JSON: for each class its ClassMetadata (every public property - table, inheritance, discriminator map and value, fields and their types, associations, cache, callbacks, repository...; the reflection left out, the id generator by its class), what each enabled SQL filter adds to a query of it, and the completor omnibase's attributes filled for it (aliases, hierarchy); then the DBAL types registered, by name.

A mapping object's properties left null or false are left out (read back from the metadata cache, a field's nullable, unique and index are null where a mapping just built says false); the discriminator map is sorted by its keys, the subclasses by name and the property accessors by property - in a map Doctrine generates, the classes come in the order PHP declared them, which two processes need not share. Two entity managers over the same entities and database - DoctrineBundle's, and one built by hand with Base\Bridge\Doctrine\Mapping - give the same snapshot (tests/Bridge/Doctrine/HandBuiltEntityManagerTest).

MetadataSnapshot::of()

public static function of(EntityManagerInterface $entityManager, ?array $classNames = null): array
$classNames

the classes, those the mapping driver knows when null

MetadataSnapshot::classMetadata()

public static function classMetadata(ClassMetadata $classMetadata, EntityManagerInterface $entityManager): array

Registry class

final class Registry extends AbstractManagerRegistry Registry.php:16

doctrine/persistence's ManagerRegistry over one entity manager and its connection, both named "default": what omnibase's repositories (Base\Database\Repository\ServiceEntityRepository) and the ClassMetadataManipulator are built from, where DoctrineBundle's doctrine service is not there (Base\Bridge\Doctrine\Mapping).

Registry::__construct()

public function __construct(readonly EntityManagerInterface $entityManager)

RepositoryFactory class

final class RepositoryFactory implements RepositoryFactoryInterface RepositoryFactory.php:21

The repositories of an entity manager built by hand (Base\Bridge\Doctrine\ Mapping::getRepository(), or the configuration's repository factory when it is set before the entity manager is built): a repository built from the ManagerRegistry - omnibase's ServiceEntityRepository and the applications' repositories over it, __construct(ManagerRegistry $registry, ?string $entityName = null) - is given the registry (and the entity's class when it takes one); any other is built as Doctrine builds it, from the entity manager and the metadata. Under Symfony, DoctrineBundle's ContainerRepositoryFactory hands out the services.

RepositoryFactory::__construct()

public function __construct(readonly ?ManagerRegistry $registry = null)

The registry the repositories are built from; none: one over the entity manager asking (Base\Bridge\Doctrine\Registry) - the factory is then set on a configuration before its entity manager exists (Mapping::configure()).

RepositoryFactory::registryFor()

public function registryFor(EntityManagerInterface $entityManager): ManagerRegistry

The registry a repository of this entity manager is built from.

RepositoryFactory::getRepository()

public function getRepository(EntityManagerInterface $entityManager, string $entityName): EntityRepository

Types class

final class Types Types.php:27

omnibase's column types, registered with DBAL (plan "omnibase agnostique", C6): what BaseBundle::boot() and the bundle's doctrine.dbal.types did, in one place, for Symfony and for an entity manager built by hand.

  • datetime and datetimetz are Base\Database\Type\DateTimeTypeUTC (the moment kept in UTC whatever zone PHP was put in), array the core's ArrayType (the serialized arrays of before DBAL 4), utc_datetime and utc_datetime_immutable the core's UTC types;
  • every enumeration (Base\Database\Type\EnumType, SetType) of the folders given, under its getStaticName(), when no type has that name yet;
  • the types given by name (a bundle's enumerations), replacing a type of the same name, as DoctrineBundle registers its configured types.

Types::core()

public static function core(): array
Returns

the core's types, by name

Types::enumerations()

public static function enumerations(array $directories): array
Returns

the enumerations the folders hold, by their names

Types::register()

public static function register(array $types = [], array $enumerationDirectories = []): void
$types

the types to register by name, over any of that name

$enumerationDirectories

the folders whose enumerations are registered, under names not taken

Types::coreEnumerationDirectory()

public static function coreEnumerationDirectory(): string

The core's own enumerations (src/Enum).

Base\Bridge\Symfony

AccountScreens class

class AccountScreens AccountScreens.php:31

The account's screens under Symfony (plan "omnibase agnostique", C5): what the framework-free builder (Base\Screen\Builder\Accounts) cannot know, asked where the templates of before asked it - the viewer and their roles (the Access contract: app.user, is_granted), an avatar's thumbnail (|thumbnail, MediaTwigExtension), the providers one may link (oauth_available()), web push and the back-office address of a notification (push_available(), push_vapid_key(), NotificationTwigExtension), Twig's time zone (the days of the notifications' groups) -, handed to the builder. What the account's controllers and the Twig function account_profile() (a host page's) call; a Twig runtime, so that it may read Twig's extensions without a circular service.

const AVATAR = 128

The width and height of a profile's avatar.

AccountScreens::__construct()

public function __construct(readonly Accounts $accounts, readonly Environment $twig, readonly ?Access $access = null)

AccountScreens::profile()

public function profile(User $user): ProfilePage

A member's profile, as the visitor asking sees it.

AccountScreens::settings()

public function settings(?User $user, iterable $sessions = []): SettingsPage

AccountScreens::notifications()

public function notifications(iterable $notifications, int $unread, bool $unreadOnly = false): NotificationsPage

CsrfTokens class

final class CsrfTokens implements Tokens CsrfTokens.php:13

The Tokens contract under Symfony (plan "omnibase agnostique", C5): the CSRF token manager's token of an intent - what Twig's csrf_token() prints and AbstractController::isCsrfTokenValid() checks.

CsrfTokens::__construct()

public function __construct(readonly CsrfTokenManagerInterface $manager)

CsrfTokens::csrf()

public function csrf(string $intent): string

FlysystemFiles class

final class FlysystemFiles implements Files FlysystemFiles.php:18

Base\Contract\Files under Symfony: omnibase's Flysystem service (its storages from flysystem.yaml) and, for a remote storage, MediaService's image route - what Base\Database\Attribute\Uploader resolves a stored file to: a remote storage's file through the /images route first (no local file to link), a local storage's by its path under public/ (Flysystem::getPublic()); its web address is that path less the public directory, as the editor's uploads give it.

FlysystemFiles::__construct()

public function __construct(readonly FlysystemInterface $flysystem, readonly ?MediaServiceInterface $media = null)

FlysystemFiles::publicPath()

public function publicPath(string $path, ?string $storage = null): ?string

FlysystemFiles::publicUrl()

public function publicUrl(string $path, ?string $storage = null): ?string

FlysystemFiles::localPath()

public function localPath(string $path, ?string $storage = null): ?string

FlysystemFiles::isRemote()

public function isRemote(?string $storage = null): bool

LocalizerLocales class

final class LocalizerLocales implements Locales LocalizerLocales.php:13

Base\Contract\Locales under Symfony: omnibase's Localizer (the request's locale, the site's default and fallbacks from base.yaml), its answers in a list.

LocalizerLocales::__construct()

public function __construct(readonly LocalizerInterface $localizer)

LocalizerLocales::getLocale()

public function getLocale(): string

LocalizerLocales::getDefaultLocale()

public function getDefaultLocale(): string

LocalizerLocales::getAvailableLocales()

public function getAvailableLocales(): array

MediaPictures class

final class MediaPictures implements Pictures MediaPictures.php:14

The Pictures contract under Symfony (plan "omnibase agnostique", C5): the answers of omnibase's |picture filter itself - a stored image's thumbnail by MediaService, an address or a public path as it is, an asset of the build - so a screen's images are those the templates printed.

MediaPictures::__construct()

public function __construct(readonly CommonsTwigExtension $commons)

MediaPictures::picture()

public function picture(?string $image, ?int $width = null, ?int $height = null): ?string

NotificationMessages class

final class NotificationMessages NotificationMessages.php:40

The Symfony half of Base\Entity\User\Notification (plan "omnibase agnostique", step C3f): what the entity made with the framework, moved here as it was. The entity keeps what a notification is - its subject, content, importance, channels, recipients, context, templates - and its sending through the notifier; it hands this class what needs Symfony:

  • throwable(): the error an ExceptionEvent (HttpKernel) carries, or a FlattenException (ErrorHandler), made the notification's content;
  • response(): render()'s HttpFoundation Response;
  • email(): asEmailMessage(), the NotificationEmail of Symfony's Twig bridge (TemplatedEmail, WrappedTemplatedEmail), its attachments (HttpFoundation's UploadedFile), its HTML through Twig.

Same names for what the sites use: they keep calling the entity's methods, which answer what they answered.

const FRAME = "@Base/notifier/email.html.twig"

The e-mail frame: the HTML of a notification whose template is missing or not found.

NotificationMessages::throwable()

public static function throwable(mixed $content): Throwable|FlattenException|null

The error to describe, when the notification's content is one: an ExceptionEvent's throwable, a FlattenException, a Throwable; null for anything else.

NotificationMessages::response()

public static function response(string $html): Response

NotificationMessages::email()

public static function email(Notification $notification, EmailRecipientInterface $recipient, BaseNotifierInterface $notifier, Environment $twig, string $projectDir): EmailMessage

RouterUrls class

final class RouterUrls implements Urls RouterUrls.php:14

Base\Contract\Urls under Symfony: the router (omnibase's advanced_router, which generates through the application's) and the asset packages - what Twig's path(), url() and asset() answer, the same strings.

RouterUrls::__construct()

public function __construct(readonly UrlGeneratorInterface $router, readonly ?Packages $packages = null)

RouterUrls::path()

public function path(string $name, array $parameters = []): string

RouterUrls::url()

public function url(string $name, array $parameters = []): string

RouterUrls::asset()

public function asset(string $path): string

RouterUrls::generate()

public function generate(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string

Any of the router's reference types, beyond the contract (which has an absolute path and URL only): Base\Contract\Link::to() asks it for a relative or a network path, which the router made before C3e.

ScreenResponder class

class ScreenResponder ScreenResponder.php:44

A screen answered under Symfony (plan "omnibase agnostique", C5): what a controller hands back - a template, a view model (Base\Screen\View) - and the frame of the request (the ContextProvider's).

  • A visit within a front end (omnibridge/react's protocol: the request header X-Omnibridge, when omnibridge/react is installed): the page in JSON - the View's component, the frame's and the screen's props together, the address, the front end's version (base.screens.version) -; a front end of another version gets 409 and the address to reload.
  • Without omnibridge/react, a request asking JSON alone (Accept: application/json, no text/html): the props in JSON. React does not rely on it.
  • Otherwise the HTML: Twig renders the View's template with frame and screen (and, for the templates a site overrides, the variables the page had before - $legacy, deprecated, gone in 4.0).

Every answer varies on what chooses between them (X-Omnibridge, Accept); a JSON answer carrying a visitor (the frame's viewer) is private to them and varies on the session's cookie: no cache serves one person's name to another. A screen carrying its viewer's secrets (Base\Screen\Confidential: its forms' tokens) is stored by no cache at all: private, no-store and Vary: Cookie, the HTML as the JSON.

A screen's props never take a key of the frame's (Frame::RESERVED: locale, site, links, viewer, theme): the frame's would win and the screen's be lost without a word, so such a screen is refused, in every answer.

ScreenResponder::__construct()

public function __construct(readonly Environment $twig, readonly ContextProvider $context, readonly ?string $version = null, readonly ?bool $omnibridge = null)

ScreenResponder::respond()

public function respond(Request $request, View $view, array $legacy = [], ?Frame $frame = null): Response
$legacy

the variables of before, for a site's own template

ScreenResponder::legacy()

public function legacy(string $template, \Closure $variables, ?string $own = null): array

The variables a page had before its view model, given only to a template a site overrides (its templates/ folder, templates/bundles/...): one read from $own (the core's templates by default) reads its screen alone, and the variables - their queries - are not made at all.

ScreenResponder::props()

public function props(Frame $frame, View $view): array
Returns

the frame's props and the screen's, as a front end reads them

ScreenResponder::guard()

public static function guard(Screen $screen): void

A screen whose props would take a key of the frame's is refused: its own would be lost in the JSON.

SecurityAccess class

final class SecurityAccess implements Access SecurityAccess.php:15

Base\Contract\Access under Symfony: Security's authorization checker (the role hierarchy, the voters - omnibase's on a Thread, a User...) and token storage, the answers of BaseService::isGranted() and of Twig's is_granted() and app.user.

SecurityAccess::__construct()

public function __construct(readonly AuthorizationCheckerInterface $authorizationChecker, readonly TokenStorageInterface $tokenStorage)

SecurityAccess::isGranted()

public function isGranted(mixed $attribute, mixed $subject = null): bool

SecurityAccess::getUser()

public function getUser(): ?object

SymfonyScreenContext class

class SymfonyScreenContext implements ContextProvider SymfonyScreenContext.php:36

The screens' context under Symfony (plan "omnibase agnostique", C5): what omnibase's kernel.request subscribers and Twig globals gave the templates, asked once for the screen being answered.

  • the locale: the request's (what |trans speaks, app.request.locale);
  • the host: the scheme, host and base path the page was asked at;
  • the site: the host application's Twig global site (its name, slogan, description: the sites' App\Site\Identity) when it has one, else omnibase's settings (base.settings.title, slogan, logo, meta.description);
  • the links: home (app_index, else "/"), login, register, logout, and each language's address (_switch_locale), those whose route exists;
  • the viewer: the Access contract's user (the token storage's);
  • the theme: the Themizer's colour scheme;
  • the flashes: Twig's app.flashes() itself (read, and so taken).

A site decorates this service (Base\Screen\ContextProvider) to add its own frame fields.

SymfonyScreenContext::__construct()

public function __construct(readonly RequestStack $requests, readonly ?Urls $urls = null, readonly ?Access $access = null, readonly ?Locales $locales = null, readonly ?SettingBagInterface $settings = null, readonly ?ThemizerInterface $themizer = null, readonly ?Environment $twig = null, readonly ?object $app = null)

SymfonyScreenContext::frame()

public function frame(array $extra = []): Frame

SymfonyScreenContext::viewer()

public function viewer(): ?Viewer

SymfonyScreenContext::flashes()

public function flashes(string $type): array

TranslatorTranslations class

final class TranslatorTranslations implements Translations TranslatorTranslations.php:14

omnibridge/twig's Translations under Symfony: the application's translator (omnibase's chain: the texts rewritten in the back office, then Base\Service\Translator - "@domain.key" references, politeness - then Symfony's, ICU catalogues), what Twig's |trans answers, the same strings.

TranslatorTranslations::__construct()

public function __construct(readonly TranslatorInterface $translator)

TranslatorTranslations::trans()

public function trans(string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string

WysiwygTexts class

final class WysiwygTexts implements Texts WysiwygTexts.php:15

The Texts contract under Symfony (plan "omnibase agnostique", C5): the pipeline of omnibase's |wysiwyg and |wysiwyg_toc filters itself (mentions, links, media, headings, Editor.js's renderer or the HTML of the older editor), so a screen's text is the HTML the templates printed.

WysiwygTexts::__construct()

public function __construct(readonly HtmlTwigExtension $html, readonly EditorEnhancerInterface $editor)

WysiwygTexts::isEditor()

public function isEditor(?string $text): bool

WysiwygTexts::render()

public function render(?string $text, array $options = []): string

WysiwygTexts::toc()

public function toc(?string $text, ?int $maxLevel = null): array

Base\Bundle

AbstractBaseBundle class

abstract class AbstractBaseBundle extends Bundle AbstractBaseBundle.php:14

AbstractBaseBundle::__construct()

public function __construct()

AbstractBaseBundle::getBundleDir()

public static function getBundleDir()

AbstractBaseBundle::getProjectDir()

public static function getProjectDir(): string

AbstractBaseBundle::getBundles()

public function getBundles()

AbstractBaseBundle::hasBundle()

public function hasBundle(string $bundleName)

AbstractBaseBundle::getDeclaredClasses()

public function getDeclaredClasses(string $namespace = "", int $level = -1)

AbstractBaseBundle::getDeclaredNamespaces()

public function getDeclaredNamespaces(string $namespace = "", int $level = 1)

AbstractBaseBundle::setMapping()

public function setMapping(string $path, string $inputNamespace = "", string $outputNamespace = "")

AbstractBaseBundle::generateStub()

public function generateStub(string $path, string $inputNamespace = "", string $outputNamespace = ""): void

AbstractBaseBundle::registerAliasAutoloader()

public static function registerAliasAutoloader(): void

A last-resort autoloader for the App\* aliases.

The aliases are declared once per process, from the pool that BaseBundle::warmUp() reads (or the scan that rebuilds it). A pool that is stale or incomplete - a concurrent rebuild, cache:clear moving the cache dir under a process - used to leave one alias out, and whatever first needed it died: Class "App\Repository\Thread\MentionRepository" not found from the container, which instantiates the service by that name (config/services/media.php).

It also covers the window before warmUp() has run at all: see the constructor. Composer is asked first; this only runs for a class nobody else could load. It answers from the known alias lists, then from the convention itself (App\Entity\X is Base\Entity\X, ...), and declares the alias. An alias the lists declare whose Base class is missing is a LogicException.

AbstractBaseBundle::getAlias()

public function getAlias($arrayOrObjectOrClass)

AbstractBaseBundle::hasAlias()

public function hasAlias(mixed $objectOrClass): bool

AbstractBaseBundle::getAliasRepository()

public function getAliasRepository($aliasRepository)

AbstractBaseBundle::getUnloadableClasses()

public static function getUnloadableClasses(): array

AbstractBaseBundle::declareAlias()

public static function declareAlias(string $class, string $alias): bool

Declares $alias as $class unless something already answers to $alias: a class loaded, or one an autoloader finds a file for - the application's own App\Enum\X, not loaded yet, is never replaced by Base\Enum\X. The stubs glitchr/base-plugin writes for the classes an application does not define are no definition of its own. True when the alias is declared (or already was, to that class).

AbstractBaseBundle::classLoads()

public static function classLoads(string $class): bool

AbstractBaseBundle::isRepositoryService()

public static function isRepositoryService(string $class): bool

Whether $class is registered as a Doctrine repository service (tagged doctrine.repository_service, built with doctrine): a class whose name ends with "Repository", that can be instantiated and that is a service repository: omnibase's Base\Database\Repository\ServiceEntityRepository (built on doctrine/orm's EntityRepository since step C3b of the plan "omnibase agnostique") or DoctrineBundle's ServiceEntityRepositoryInterface.

Every class of a bundle's src/Repository named so used to be registered, an abstract base repository included - and the container then had a service it could not build. Abstract classes, interfaces and traits are aliased like any class of the bundle, never registered.

AbstractBaseBundle::setAlias()

public function setAlias(array $classes)

AbstractBaseBundle::setAliasEntity()

public function setAliasEntity($class)

AbstractBaseBundle::getAllClasses()

public static function getAllClasses(string $path, string $prefix = "", int $level = -1): array

AbstractBaseBundle::getAllNamespaces()

public function getAllNamespaces(string $path, string $prefix = "", int $level = -1): array

AbstractBaseBundle::getAllNamespacesAndClasses()

public function getAllNamespacesAndClasses(string $path, string $prefix = "", int $level = -1): array

AbstractBaseBundle::getClassname()

public static function getClassname(string $filename)

AbstractBaseBundle::getFullNamespace()

public static function getFullNamespace(string $filename, string $prefix = "")

AbstractBaseBundle::getFiles()

public static function getFiles(string $path, int $level = -1)

AbstractBaseBundle::getDirectories()

public function getDirectories(string $path, int $level = -1)

AbstractBaseConfiguration class

abstract class AbstractBaseConfiguration implements ConfigurationInterface AbstractBaseConfiguration.php:8

AbstractBaseConfiguration::getTreeBuilder()

public function getTreeBuilder(?string $treeName = null): TreeBuilder

AbstractBaseExtension class

abstract class AbstractBaseExtension extends Extension AbstractBaseExtension.php:8

AbstractBaseExtension::setConfiguration()

public function setConfiguration(ContainerBuilder $container, array $config, $globalKey = '')

AbstractBaseExtension::getBaseNamespace()

public function getBaseNamespace()

AbstractBaseExtension::setConfigurationAliases()

public function setConfigurationAliases(ContainerBuilder $container)

Base\Cache

SimpleCache class

final class SimpleCache extends AbstractLocalCache implements SimpleCacheInterface SimpleCache.php:8

SimpleCache::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

SimpleCache::useSimpleCacheVersion3()

public static function useSimpleCacheVersion3(): bool

SimpleCache::get()

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

SimpleCache::set()

public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool

SimpleCache::delete()

public function delete(string $key): bool

SimpleCache::clear()

public function clear(): bool

SimpleCache::getMultiple()

public function getMultiple(iterable $keys, mixed $default = null): iterable

SimpleCache::setMultiple()

public function setMultiple(iterable $keys, null|int|\DateInterval $ttl = null): bool

SimpleCache::deleteMultiple()

public function deleteMultiple(iterable $keys): bool

SimpleCache::has()

public function has(string $key): bool

SimpleCacheInterface interface

interface SimpleCacheInterface extends AbstractLocalCacheInterface, CacheInterface SimpleCacheInterface.php:8

Base\Cache\Abstract

AbstractLocalCache class

abstract class AbstractLocalCache implements AbstractLocalCacheInterface AbstractLocalCache.php:8

AbstractLocalCacheInterface interface

interface AbstractLocalCacheInterface AbstractLocalCacheInterface.php:17

A service's own cache, warmed by omnibase's cache warmers (Base\Cache\Warmer\*, which call warmUp()). warmUp() is declared here, with the signature of HttpKernel's WarmableInterface, which this interface no longer extends (plan "omnibase agnostique", C6): the AttributeReader and the ClassMetadataManipulator - what an entity manager built by hand reads its mapping through - load nothing of the framework. Symfony asks WarmableInterface of the kernel, its router and its translator only, none of which is one of these.

AbstractLocalCacheInterface::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

Warms up the cache.

Returns

A list of classes or files to preload

AbstractLocalCacheInterface::hasCache()

public function hasCache(string $key): bool

AbstractLocalCacheInterface::deleteCache()

public function deleteCache(?string $key = null): bool

AbstractLocalCacheInterface::getCache()

public function getCache(?string $key = null, mixed $fallback = null, int|\DateInterval|null $ttl = null, $deferred = false): mixed

AbstractLocalCacheInterface::setCache()

public function setCache(CacheItemPoolInterface|string $cacheOrKey, mixed $value = null, int|\DateInterval|null $ttl = null, bool $deferred = false)

AbstractLocalCacheInterface::executeOnce()

public function executeOnce(callable $fn, int|\DateInterval|null $ttl = null)

AbstractLocalCacheInterface::commitCache()

public function commitCache()

AbstractLocalCacheWarmer class

abstract class AbstractLocalCacheWarmer extends AbstractPhpFileCacheWarmer implements AbstractLocalCacheWarmerInterface AbstractLocalCacheWarmer.php:9

AbstractLocalCacheWarmer::__construct()

public function __construct(AbstractLocalCacheInterface $simpleCache, string $cacheDir)

AbstractLocalCacheWarmer::getCache()

public function getCache(): ArrayAdapter

AbstractLocalCacheWarmer::isOptional()

public function isOptional(): bool

AbstractLocalCacheWarmerInterface interface

interface AbstractLocalCacheWarmerInterface AbstractLocalCacheWarmerInterface.php:7

AbstractLocalCacheWarmerInterface::getCache()

public function getCache(): ArrayAdapter

Base\Cache\Clearer

CodeCachesClearer class

final class CodeCachesClearer implements CacheClearerInterface CodeCachesClearer.php:16

cache:clear is enough: it empties the pools that remember what the code says - the Doctrine mapping's metadata, the DQL's parsed queries, the router's compiled routes. An application keeps them in pools of its own (filesystem, the default clearer, which cache:clear does not call): a column added to an entity read as missing, a route added was "No valid route found", until cache:pool:clear --all.

CodeCachesClearer::__construct()

public function __construct(readonly iterable $pools)

CodeCachesClearer::clear()

public function clear(string $cacheDir): void

Base\Cache\Warmer

AttributeCacheWarmer class

class AttributeCacheWarmer extends AbstractLocalCacheWarmer AttributeCacheWarmer.php:9

IconCacheWarmer class

class IconCacheWarmer extends AbstractLocalCacheWarmer IconCacheWarmer.php:10

IconCacheWarmer::__construct()

public function __construct(IconProvider $iconProvider, string $cacheDir)

LocalizerCacheWarmer class

class LocalizerCacheWarmer extends AbstractLocalCacheWarmer LocalizerCacheWarmer.php:7

MetadataCacheWarmer class

class MetadataCacheWarmer extends AbstractLocalCacheWarmer MetadataCacheWarmer.php:12

MetadataCacheWarmer::__construct()

public function __construct(AbstractLocalCacheInterface $simpleCache, AttributeReader $attributeReader, string $cacheDir)

SpreadsheetCacheWarmer class

class SpreadsheetCacheWarmer implements CacheWarmerInterface SpreadsheetCacheWarmer.php:10

SpreadsheetCacheWarmer::__construct()

public function __construct(string $cacheDir)

SpreadsheetCacheWarmer::isOptional()

public function isOptional(): bool

SpreadsheetCacheWarmer::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

ThemizerCacheWarmer class

class ThemizerCacheWarmer extends AbstractLocalCacheWarmer ThemizerCacheWarmer.php:7

WebpackCacheWarmer class

class WebpackCacheWarmer extends AbstractLocalCacheWarmer WebpackCacheWarmer.php:21

The entries of the application's build and of the core's, and their tags rendered once, kept in the cache - unless a build was being written when the cache was made (the web container restarted while Encore's watcher rebuilds: entrypoints.json absent, or without entries). What was read then is not kept: it used to stay until cache:pool:clear --all, every page without its stylesheets. The renderer reads the builds again on a request that finds none (WebpackTagRenderer::discoverIfNone()).

WebpackCacheWarmer::__construct()

public function __construct(ParameterBagInterface $parameterBag, WebpackTagRenderer $webpackTagRenderer, ?EntrypointLookupInterface $entrypointLookup, string $cacheDir, string $publicDir)

WebpackCacheWarmer::isComplete()

public function isComplete(): bool

Base\Console

Application class

class Application extends Application Application.php:7

Command class

class Command extends SymfonyCommand Command.php:19

Command::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag)

Command::run()

public function run(InputInterface $input, OutputInterface $output): int

Console class

class Console implements ConsoleInterface Console.php:12

Console::__construct()

public function __construct(KernelInterface $kernel, int $verbosity = Output::VERBOSITY_NORMAL)

Console::verbosity()

public function verbosity(int $verbosity)

Console::exec()

public function exec(string $command, array $parameters = []): ?string

ConsoleInterface interface

interface ConsoleInterface ConsoleInterface.php:5

ConsoleInterface::exec()

public function exec(string $command, array $parameters = []): ?string

Base\Console\Command

AutocompleteEntitiesCommand class

class AutocompleteEntitiesCommand extends Command AutocompleteEntitiesCommand.php:23

AutocompleteEntitiesCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, ClassMetadataManipulator $classMetadataManipulator)

BaseMappingCommand class

class BaseMappingCommand extends Command BaseMappingCommand.php:13

CacheClearCommand class

class CacheClearCommand extends Command CacheClearCommand.php:21

public static string $testFile

CacheClearCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, SymfonyCommand $cacheClearCommand, SymfonyCommand $cacheClearSessionsCommand, Flysystem $flysystem, Notifier $notifier, AdvancedRouterInterface $router, string $projectDir, string $cacheDir)

CacheClearCommand::getTestFile()

public static function getTestFile(): string

CacheClearCommand::markAsFirstClear()

public static function markAsFirstClear(bool $first = true)

CacheClearCommand::applicationNotStarted()

public static function applicationNotStarted(): bool

CacheClearCommand::isFirstClear()

public static function isFirstClear(): bool

CacheClearCommand::getNClears()

public static function getNClears(): int

CacheClearSessionsCommand class

class CacheClearSessionsCommand extends Command CacheClearSessionsCommand.php:15

CacheClearSessionsCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, string $projectDir)

DemoResetCommand class

class DemoResetCommand extends Command DemoResetCommand.php:44

The demonstration back to what the fixtures say: what the cron container runs every night in the demo environment, and nowhere else.

1. refuses outside demo, and on what DemoGuard refuses (debug, the production database); 2. under a lock (symfony/lock): two resets never overlap; 3. empties the directories of base.demo.reset.purge - the files the visitors sent to a storage of the application's own; 4. reloads the fixtures (doctrine:fixtures:load, the groups of base.demo.reset.groups when some are named), then creates the declared demonstration accounts they left out; 5. deletes the uploaded files no row names any more (uploader:entities --delete-orphans, unless base.demo.reset.orphans is off); 6. empties the caches that would go on answering yesterday's rows: every cache pool, Doctrine's second-level cache.

Each step is logged; the exit code is not 0 when one failed.

const LOCK = 'base-demo-reset'

DemoResetCommand::__construct()

public function __construct(readonly DemoMode $mode, readonly DemoGuard $guard, readonly DemoAccountFactory $accounts, readonly ?ManagerRegistry $doctrine = null, readonly ?LockFactory $lockFactory = null, readonly ?SecondLevelCacheConsoleSubscriber $secondLevelCache = null, readonly ?LoggerInterface $logger = null, readonly array $purge = [], readonly bool $orphans = true, readonly array $groups = [], readonly ?DemoAccountRegistry $registry = null)
$purge

directories emptied before the fixtures are loaded (base.demo.reset.purge)

$groups

the fixture groups loaded (base.demo.reset.groups); none: every fixture

DoctrineArrayUpgradeCommand class

class DoctrineArrayUpgradeCommand extends Command DoctrineArrayUpgradeCommand.php:17

DoctrineArrayUpgradeCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag)

DoctrineDatabaseImportCommand class

class DoctrineDatabaseImportCommand extends Command DoctrineDatabaseImportCommand.php:38

const OFFSET = 2
const UNKNOWN_STATE = -1
const VALID_ENTITY = 0
const FIELD_REQUIRED = 1
const PARENT_NOT_FOUND = 2
const ALREADY_IN_DATABASE = 3

DoctrineDatabaseImportCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, EntityHydrator $entityHydrator, ClassMetadataManipulator $classMetadataManipulator, Notifier $notifier)

DoctrineDatabaseImportCommand::normalize()

public function normalize($entityName, $entityData)
Throws

Exception

DoctrineSchemaCharsetCommand class

class DoctrineSchemaCharsetCommand extends Command DoctrineSchemaCharsetCommand.php:12

EntityDiscriminatorCommand class

class EntityDiscriminatorCommand extends Command EntityDiscriminatorCommand.php:17

EntityDiscriminatorCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, ClassMetadataManipulator $classMetadataManipulator)

IconControllersCommand class

class IconControllersCommand extends Command IconControllersCommand.php:15

IconCrudCommand class

class IconCrudCommand extends Command IconCrudCommand.php:16

IconEntitiesCommand class

class IconEntitiesCommand extends Command IconEntitiesCommand.php:22

IconEntitiesCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, ClassMetadataManipulator $classMetadataManipulator)

IconEnumsCommand class

class IconEnumsCommand extends Command IconEnumsCommand.php:15

MailTrapCommand class

class MailTrapCommand extends Command MailTrapCommand.php:30

Hold outgoing mail during an incident, look at what was held, then throw away the wrong ones and let the rest go.

base:mailer:trap on --reason="hotfix newsletter" nothing leaves from now on base:mailer:trap list who each held mail was for base:mailer:trap show <id> one message in full base:mailer:trap purge <id> | --all delete, never sent base:mailer:trap release <id> | --all send it after all base:mailer:trap off back to normal

on takes effect for mail that is ALREADY queued too, because the trap sits at send time rather than at queue time - so arming it mid-incident still catches whatever the worker had not got to yet.

MailTrapCommand::setMailTrap()

public function setMailTrap(MailTrap $trap): static

MailTrapCommand::setMailerTransport()

public function setMailerTransport(TransportInterface $transport): static

NotifierCommand class

class NotifierCommand extends Command NotifierCommand.php:13

NotifierMailTestCommand class

class NotifierMailTestCommand extends Command NotifierMailTestCommand.php:15

NotifierMailTestCommand::__construct()

public function __construct(...$args)

ThreadPublishableCommand class

class ThreadPublishableCommand extends Command ThreadPublishableCommand.php:16

TimeMachineSnapshotBackupCommand class

class TimeMachineSnapshotBackupCommand extends TimeMachineSnapshotCommand TimeMachineSnapshotBackupCommand.php:12

TimeMachineSnapshotBackupCommand::execute()

public function execute(InputInterface $input, OutputInterface $output): int

TimeMachineSnapshotCommand class

class TimeMachineSnapshotCommand extends Command TimeMachineSnapshotCommand.php:19

TimeMachineSnapshotCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, TimeMachineInterface $timeMachine, FlysystemInterface $flysystem)

TimeMachineSnapshotCommand::execute()

public function execute(InputInterface $input, OutputInterface $output): int

TimeMachineSnapshotRestoreCommand class

class TimeMachineSnapshotRestoreCommand extends TimeMachineSnapshotCommand TimeMachineSnapshotRestoreCommand.php:13

TimeMachineSnapshotRestoreCommand::execute()

public function execute(InputInterface $input, OutputInterface $output): int

TimeMachineStorageCommand class

class TimeMachineStorageCommand extends Command TimeMachineStorageCommand.php:18

TimeMachineStorageCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, TimeMachineInterface $timeMachine, FlysystemInterface $flysystem)

TimeMachineStorageCommand::execute()

public function execute(InputInterface $input, OutputInterface $output): int

TranslationControllersCommand class

class TranslationControllersCommand extends Command TranslationControllersCommand.php:13

TranslationCrudCommand class

class TranslationCrudCommand extends Command TranslationCrudCommand.php:16

TranslationEntitiesCommand class

class TranslationEntitiesCommand extends Command TranslationEntitiesCommand.php:17

TranslationEnumsCommand class

class TranslationEnumsCommand extends Command TranslationEnumsCommand.php:16

TranslationSettingsCommand class

class TranslationSettingsCommand extends Command TranslationSettingsCommand.php:18

TranslationSettingsCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, SettingBagInterface $settingBag)

TrashPurgeCommand class

class TrashPurgeCommand extends Command TrashPurgeCommand.php:21

Empties the trash of everything past its grace period (base.extension.empty_trash, "+7 days" by default).

Meant for cron. Defaults to a dry run: this is the only thing in the stack that destroys content beyond recovery, so it says what it would do unless told --force.

TrashPurgeCommand::setTrashManager()

public function setTrashManager(TrashManager $trashManager): self

UploaderEntitiesCommand class

class UploaderEntitiesCommand extends Command UploaderEntitiesCommand.php:17

UploaderEntitiesCommand::getEntries()

public function getEntries($class)

UploaderEntitiesCommand::getOrphanFiles()

public function getOrphanFiles(string $class, string $field, Uploader $attribute)
Throws

Exception

UploaderEntitiesCommand::deleteOrphanFiles()

public function deleteOrphanFiles(Uploader $attribute, array $fileList)

UploaderEntitiesCommand::preProcess()

public function preProcess(mixed $class, string $field, Uploader $attribute)

UploaderEntitiesCommand::postProcess()

public function postProcess(mixed $class, string $field, Uploader $attribute, array $fileList)

UploaderImagesCommand class

class UploaderImagesCommand extends UploaderEntitiesCommand UploaderImagesCommand.php:18

UploaderImagesCommand::__construct()

public function __construct(LocalizerInterface $localizer, TranslatorInterface $translator, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, MediaServiceInterface $mediaService, MediaController $mediaController)

UploaderImagesCommand::isCached()

public function isCached($data)

UploaderImagesCommand::postProcess()

public function postProcess(mixed $class, string $field, Uploader $attribute, array $fileList)

UploaderImagesCropCommand class

class UploaderImagesCropCommand extends UploaderImagesCommand UploaderImagesCropCommand.php:21

UploaderImagesCropCommand::postProcess()

public function postProcess(mixed $class, string $field, Uploader $attribute, array $fileList)

UploaderImagesCropCommand::isCached()

public function isCached($data, $imageCrop = null)

UserCreateCommand class

class UserCreateCommand extends Command UserCreateCommand.php:27

An account made from the command line - someone's own to test a site, a colleague's -, verified and approved, with a password it did not choose: generated and shown once (or given with --password), to be changed at its first sign-in (a "change-password" token, PasswordChangeSubscriber) unless --keep-password; e-mailed its username and password unless --no-email. A plain Symfony command (not Base\Console\Command, which wants a ConsoleOutput): it runs from scripts and tests too.

UserCreateCommand::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly NotifierInterface $notifier)

UserNotificationCommand class

class UserNotificationCommand extends Command UserNotificationCommand.php:15

Base\Contract

Access interface

interface Access Access.php:15

What the visitor may do: an attribute (a role, "ROLE_ADMIN", or a permission a voter answers, "edit" on a Thread) granted or not, on a subject or none, and who the visitor is.

The Fondation's own contract (plan "omnibase agnostique", C4, D8): an entity's getter asks it instead of the framework's authorization checker. Under Symfony, Base\Bridge\Symfony\SecurityAccess: Security's authorization checker and token storage, the answers of BaseService::isGranted().

Access::isGranted()

public function isGranted(mixed $attribute, mixed $subject = null): bool

Whether the visitor holds the attribute, on the subject when one is given; false for nobody signed in unless the attribute is granted to anyone.

Access::getUser()

public function getUser(): ?object

The visitor signed in (an application's user entity), null for nobody.

Files interface

interface Files Files.php:18

The stored files as an entity sees them: where a file is served from and where PHP can read it, by its path in a storage. Nothing of how it is stored (Flysystem, a disk, a bucket): that stays with the storage.

The Fondation's own contract (plan "omnibase agnostique", C4): what Base\Database\Attribute\Uploader and the entities' file getters need of the storages, without the Flysystem service. A storage is named as in omnibase's configuration ("local.cache", "local.public", "s3.private"...), null for the default one. Under Symfony, Base\Bridge\Symfony\FlysystemFiles: the answers of Base\Service\Flysystem (and of MediaService's image route for a remote storage, as the uploader resolves them).

Files::publicPath()

public function publicPath(string $path, ?string $storage = null): ?string

What the uploader hands an entity for a stored file: its path under the public directory, which the web server serves (a local storage linked there: /srv/app/public/uploads/...), or for a remote storage the address of the image route; null when it has neither (a missing file, a private storage).

Files::publicUrl()

public function publicUrl(string $path, ?string $storage = null): ?string

The web address of a stored file: its public path less the public directory (/uploads/...), or the image route's; null as publicPath().

Files::localPath()

public function localPath(string $path, ?string $storage = null): ?string

The file's path on this machine (a local storage, its root prefixed), null where there is no local file behind it (a remote storage).

Files::isRemote()

public function isRemote(?string $storage = null): bool

Whether the storage is remote: no file on this machine behind its paths.

final class Link Link.php:21

A route's address by a router's reference type, through the Urls contract (plan "omnibase agnostique", C3e): what an entity's __toLink() made with BaseTrait's router, $this->getRouter()->generate($name, $parameters, $referenceType), made where there is no framework too.

Not a contract: a helper over Runtime::urls(). The entities' __toLink() take Symfony's reference types (UrlGeneratorInterface's constants); their values are named here, so that a link is made without the routing component. An absolute path is Urls::path(), an absolute URL Urls::url(): the two the core, its bundles and the sites ask for. A relative path and a network path have no equivalent in the contract; they are asked of the Urls implementation's own generate($name, $parameters, $referenceType) when it has one (Base\Bridge\Symfony\RouterUrls: the router, as before), and refused otherwise.

Symfony's UrlGeneratorInterface::ABSOLUTE_URL: scheme, host and path

Symfony's UrlGeneratorInterface::ABSOLUTE_PATH: the path from the root

Symfony's UrlGeneratorInterface::RELATIVE_PATH

Symfony's UrlGeneratorInterface::NETWORK_PATH: "//host/path"

public static function to(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string

Locales interface

interface Locales Locales.php:15

The languages of the site, in omnibase's form: language and country joined by a dash (fr-FR, en-GB, Base\Service\Localizer::SEPARATOR).

The Fondation's own contract (plan "omnibase agnostique", C4): the translatable entities and their getters ask it instead of the Localizer service. Named in the plural, as omnibridge/twig's Urls and Translations, and so as not to shadow PHP's \Locale where it is imported. Under Symfony, Base\Bridge\Symfony\LocalizerLocales: the Localizer's answers.

Locales::getLocale()

public function getLocale(): string

The locale of the request being answered (or of the command), fr-FR.

Locales::getDefaultLocale()

public function getDefaultLocale(): string

The site's default locale, the language its texts are written in first.

Locales::getAvailableLocales()

public function getAvailableLocales(): array

Every locale the site speaks, the default first.

Pictures interface

interface Pictures Pictures.php:15

An image's address at the size a page shows it (plan "omnibase agnostique", C5): what omnibase's |picture filter answers - a thumbnail of a stored image, an address or a public path as it is, an asset of the build. Null for no image.

The Fondation's own contract, reached by Runtime::pictures() or given to a screen's builder. Under Symfony, Base\Bridge\Symfony\MediaPictures: the filter's own answers (MediaService's thumbnails).

Pictures::picture()

public function picture(?string $image, ?int $width = null, ?int $height = null): ?string

Runtime class

final class Runtime Runtime.php:46

The registry through which omnibase's framework-free code reaches the contracts of the Fondation (plan "omnibase agnostique", C4): an entity's getter, an attribute, a value object asks Runtime::urls(), ::access()... instead of the services Base\Traits\BaseTrait hands out (the router, the authorization checker, the Localizer, typed with Symfony's classes).

Each contract is asked by its interface's name. A framework fills the registry once, at boot:

  • with a PSR-11 container whose ids are those names (setContainer()): under Symfony, omnibase's bundle hands its base.contracts locator in BaseBundle::boot() (Base\DependencyInjection\Compiler\Pass\ContractsPass: only the contracts whose service exists, nothing built before it is asked); under Laravel, the application itself, its bindings named by the same interfaces;
  • or one service at a time (set()), which wins over the container's.

The contracts: Urls (path, url, asset), omnibridge/twig's Translations (trans, ICU), Access (isGranted, the user), Locales (current, default, available), Files (public URL, local path of a stored file), Pictures (an image's address at a size), Texts (a stored text rendered, its table of contents) and Tokens (a form's token for an intent) for the screens (C5), PSR-20's clock, PSR-14's event dispatcher, symfony/mailer's MailerInterface (a standalone component, allowed in the Fondation by D1; Laravel's own mail is built on it). A contract asked and not filled throws MissingContractException, except the clock, which is the machine's (SystemClock) when none was given; find() answers null instead, for a caller that can do without.

A different container means a different kernel: what was resolved from the previous one is forgotten (as BaseCommonTrait::setRuntime() does), the services set by hand are kept.

Runtime::setContainer()

public static function setContainer(?ContainerInterface $container): void

Runtime::getContainer()

public static function getContainer(): ?ContainerInterface

Runtime::set()

public static function set(string $contract, ?object $service): void

One contract's service, ahead of the container's; null takes it back.

Runtime::has()

public static function has(string $contract): bool

Runtime::find()

public static function find(string $contract): ?object

Runtime::get()

public static function get(string $contract): object

Runtime::reset()

public static function reset(): void

Everything forgotten: no container, nothing set (a test's tearDown).

Runtime::urls()

public static function urls(): Urls

Runtime::translations()

public static function translations(): Translations

Runtime::access()

public static function access(): Access

Runtime::locales()

public static function locales(): Locales

Runtime::files()

public static function files(): Files

Runtime::pictures()

public static function pictures(): Pictures

Runtime::texts()

public static function texts(): Texts

Runtime::tokens()

public static function tokens(): Tokens

Runtime::clock()

public static function clock(): ClockInterface

The framework's clock, or the machine's when none was given.

Runtime::events()

public static function events(): EventDispatcherInterface

Runtime::mailer()

public static function mailer(): MailerInterface

SystemClock class

final class SystemClock implements ClockInterface SystemClock.php:13

The clock of the machine, the registry's clock when no framework gave one (Base\Contract\Runtime::clock()). Under Symfony the registry holds the framework's clock service instead (symfony/clock, a PSR-20 clock that a test can freeze).

SystemClock::now()

public function now(): \DateTimeImmutable

Texts interface

interface Texts Texts.php:15

A stored text as a page shows it (plan "omnibase agnostique", C5): an Editor.js document or the HTML of an older editor, rendered - mentions, links, media, headings anchored - and its table of contents. What omnibase's |wysiwyg and |wysiwyg_toc filters answer.

The Fondation's own contract, reached by Runtime::texts() or given to a screen's builder. Under Symfony, Base\Bridge\Symfony\WysiwygTexts: the filters' own pipeline, so a screen's HTML is the page's of before.

Texts::isEditor()

public function isEditor(?string $text): bool

Whether the text is an Editor.js document (rather than HTML).

Texts::render()

public function render(?string $text, array $options = []): string

The text rendered, '' for none (null).

$options

those of |wysiwyg (headings, media, semantics...)

Texts::toc()

public function toc(?string $text, ?int $maxLevel = null): array

The text's headings, in its order.

Tokens interface

interface Tokens Tokens.php:19

The token a form carries for an intent, against cross-site requests (plan "omnibase agnostique", C5; decision D4: csrf_token enters the view contract): what a page's POST sends back and its action checks. A screen carries it in an action (Base\Screen\Account\Action) where a template called csrf_token().

The Fondation's own contract, reached by Runtime::tokens() or given to a screen's builder. Under Symfony, Base\Bridge\Symfony\CsrfTokens: the CSRF token manager, so a token is the one Twig's csrf_token() printed and the controller's isCsrfTokenValid() accepts. Laravel has one session token for every intent: an action pointing at a Symfony route, rendered by Laravel, would carry a token Symfony refuses (docs/20-architecture/contracts.md).

Tokens::csrf()

public function csrf(string $intent): string

The token of that intent ("2fa_disable", "passkey_delete_12"...) for the visitor's session.

Urls interface

interface Urls extends ViewUrls Urls.php:22

Addresses, as omnibase's framework-free code asks for them: a route by its name, as a path (path()) or whole, with the scheme and the host (url(), for a mail, a feed, a link shared), and a public file (asset()).

It is omnibridge/twig's Urls under omnibase's name: a page rendered by any framework asks the same contract, so one object answers both (plan "omnibase agnostique", C4, D8). omnibridge/twig has had url() since d786505; this interface declared it on its own side before, and now only extends it. Under Symfony, Base\Bridge\Symfony\RouterUrls: the router and the asset packages, the same strings as Twig's path(), url() and asset().

Base\Contract\Link::to() reaches it with a router's reference type, as the entities' __toLink() take one.

Base\Controller

DemoController class

class DemoController extends AbstractController DemoController.php:27

Signing in as a demonstration account in one click: the buttons of the sign-in page's "Demonstration accounts" panel (@Base/demo/_accounts.html.twig).

The route exists in the demo environment only. It is a POST carrying a CSRF token - never a link: a GET that signs in is followed by a prefetch, a crawler, a preview. Only a declared account is signed in, and never one that opens the back office (base.demo.admin_roles) or whose roles reach ROLE_SUPERADMIN: those sign in with their secret (DemoBackOfficeSubscriber).

const CSRF = 'demo_login'

DemoController::Login()

public function Login(Request $request, DemoMode $demo, DemoAccountRegistry $accounts, UserRepository $users, UserAuthenticatorInterface $userAuthenticator, LoginFormAuthenticator $authenticator): Response

ErrorController class

class ErrorController extends AbstractController ErrorController.php:21

ErrorController::__construct()

public function __construct(HtmlErrorRenderer $htmlErrorRenderer, AdvancedRouterInterface $router, BaseService $baseService, RequestStack $requestStack, ?Profiler $profiler = null)

ErrorController::Main()

public function Main(Throwable $exception)
Throws

Exception

ErrorController::Rescue()

public function Rescue(Throwable $exception): Response

The debug page of an error, under the error's own status: 403 for a refusal, 422 for a payload that does not validate, 404 for a page that does not exist, 500 for anything that is not an HTTP error.

It answered 404 whatever the error. A response that is already a client error is kept as it is by the kernel, so in debug (dev, and the tests) every refusal and every validation failure of a signed-in user read as "not found" - while production, whose page is rendered with a 200 the kernel then replaces, gave the right one.

LocalizerController class

class LocalizerController extends AbstractController LocalizerController.php:18

LocalizerController::__construct()

public function __construct(LocalizerInterface $localizer, EntityManagerInterface $entityManager, AdvancedRouterInterface $router, ReferrerInterface $referrer, TranslatorInterface $translator)

LocalizerController::Locale()

public function Locale(Request $request, ReferrerInterface $referrer, ?string $_locale = null)

The visitor's choice of language: remembered (LANG, and a member's own locale), then the page they came from, in that language when it has an address of its own. Without one ("/locale"), the choice is forgotten.

LocalizerController::Timezone()

public function Timezone(Request $request, ReferrerInterface $referrer, ?string $_locale = null)

MainController class

class MainController extends AbstractController MainController.php:16

MainController::__construct()

public function __construct(BaseService $service, SettingBag $settingBag)

MainController::Index()

public function Index(): Response

Controller example

ProfilerController class

class ProfilerController extends AbstractController ProfilerController.php:12

ProfilerController::__construct()

public function __construct(NotifierInterface $notifier, UserRepository $userRepository)

ProfilerController::Email()

public function Email(): Response

ProfilerController::SendEmail()

public function SendEmail(): Response

RescueController class

class RescueController extends AbstractController RescueController.php:27

The admin-firewall login ("rescue") entry point. Self-sufficient: it renders the admin extension's login page when base-bundle-admin is installed (@Admin/security/login.html.twig), and otherwise a fully self-contained fallback bundled here that depends on nothing external - no admin package, no third-party admin UI.

RescueController::__construct()

public function __construct(protected RouterInterface $router, protected SettingBagInterface $settingBag, protected Environment $twig, protected TranslatorInterface $translator, protected FormProxyInterface $formProxy)

RescueController::LoginRescue()

public function LoginRescue(Request $request, ReferrerInterface $referrer, AuthenticationUtils $authenticationUtils): Response

Link to this controller to start the "connect" process

RescueController::index()

public function index(): Response

SecurityController class

class SecurityController extends AbstractController SecurityController.php:53

SecurityController::__construct()

public function __construct(NotifierInterface $notifier, EntityManagerInterface $entityManager, TokenRepository $tokenRepository, UserRepository $userRepository, AdvancedRouterInterface $router, FormProxy $formProxy, TokenStorageInterface $tokenStorage, TranslatorInterface $translator, ParameterBagInterface $parameterBag)

SecurityController::Login()

public function Login(Request $request, ReferrerInterface $referrer, AuthenticationUtils $authenticationUtils, ?SignInGuard $signInGuard = null): Response

SecurityController::Logout()

public function Logout(Request $request, ReferrerInterface $referrer)

SecurityController::LogoutRequest()

public function LogoutRequest()

SecurityController::LoginTokenRequest()

public function LoginTokenRequest(Request $request, ReferrerInterface $referrer, AuthenticationUtils $authenticationUtils, LoginFormAuthenticator $authenticator, UserAuthenticatorInterface $userAuthenticator, ?string $token = null): Response

SecurityController::Register()

public function Register(Request $request, LoginFormAuthenticator $authenticator, UserAuthenticatorInterface $userAuthenticator): Response

SecurityController::VerifyEmailRequest()

public function VerifyEmailRequest()

SecurityController::VerifyEmailResponse()

public function VerifyEmailResponse(Request $request, UserAuthenticatorInterface $userAuthenticator, LoginFormAuthenticator $authenticator, string $token): Response

SecurityController::AdminApprovalRequest()

public function AdminApprovalRequest(Request $request)

SecurityController::DisableAccountRequest()

public function DisableAccountRequest(Request $request, SecurityPolicy $securityPolicy)

SecurityController::EnableAccountRequest()

public function EnableAccountRequest(Request $request, LoginFormAuthenticator $authenticator, UserAuthenticatorInterface $userAuthenticator, ?string $token = null): Response

SecurityController::ResetPasswordRequest()

public function ResetPasswordRequest(Request $request, SecurityPolicy $securityPolicy): Response

Display & process form to request a password reset.

SecurityController::ResetPasswordResponse()

public function ResetPasswordResponse(Request $request, LoginFormAuthenticator $authenticator, UserAuthenticatorInterface $userAuthenticator, SecurityPolicy $securityPolicy, ?string $token = null): Response

Validates and process the reset URL that the user clicked in their email.

SecurityController::ChangePassword()

public function ChangePassword(Request $request, LoginFormAuthenticator $authenticator, UserAuthenticatorInterface $userAuthenticator): Response

A password to choose, before anything else: the account was made with one its owner did not choose (user:create, a "change-password" token; PasswordChangeSubscriber brings them here).

SecurityController::Maintenance()

public function Maintenance(MaintenanceProviderInterface $maintenanceProvider): Response

Link to this controller to start the maintenance

SecurityController::Launch()

public function Launch(LauncherInterface $launcher): Response

SecurityController::Pending()

public function Pending(): Response

SecurityController::PendingForApproval()

public function PendingForApproval(): Response

ShortLinkController class

class ShortLinkController extends AbstractController ShortLinkController.php:11

ShortLinkController::__construct()

public function __construct(AdvancedRouterInterface $router, ShortLinkRepository $shlinkRepository)

ShortLinkController::Main()

public function Main(string $slug): Response

SignatureController class

final class SignatureController SignatureController.php:16

A signing provider's callback (glitchr/omnisign: Yousign, DocuSign, DocuSeal...): its signature checked by the gateway, the envelope it names asked again and kept (Base\Service\Signatures::notify()). Without glitchr/omnisign there is nothing to update: 404.

SignatureController::__construct()

public function __construct(readonly ?Signatures $signatures = null)

SignatureController::webhook()

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

SitemapController class

class SitemapController extends AbstractController SitemapController.php:15

SitemapController::Main()

public function Main(string $extension, Request $request, SitemapperInterface $sitemap, EventDispatcherInterface $dispatcher): Response

WidgetController class

class WidgetController extends AbstractController WidgetController.php:15

WidgetController::__construct()

public function __construct(PageRepository $pageRepository, AttachmentRepository $attachmentRepository)

WidgetController::Page()

public function Page($slug): Response

WidgetController::Attachment()

public function Attachment($slug): BinaryFileResponse

Base\Controller\Api

ThreadController class

class ThreadController extends AbstractController ThreadController.php:21

ThreadController::__construct()

public function __construct(EntityManagerInterface $entityManager, TranslatorInterface $translator, ThreadRepository $threadRepository, LikeRepository $likeRepository)

ThreadController::Publish()

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

ThreadController::Hide()

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

ThreadController::Follow()

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

ThreadController::Unfollow()

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

ThreadController::Like()

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

ThreadController::Unlike()

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

Base\Controller\Backoffice\Crud

UserCrudController class

class UserCrudController extends AbstractCrudController UserCrudController.php:18

UserCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

UserCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

UserCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

UserCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Backoffice\Crud\Layout

ImageCrudController class

class ImageCrudController extends AbstractCrudController ImageCrudController.php:11

ImageCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ImageCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ImageCrudController::configureFields()

public function configureFields(string $pageName): iterable

SettingCrudController class

class SettingCrudController extends AbstractCrudController SettingCrudController.php:14

SettingCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

SettingCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

SettingCrudController::createEntity()

public function createEntity(string $entityFqcn): object

SettingCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

SettingCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Backoffice\Crud\Layout\Attribute

AdapterCrudController class

class AdapterCrudController extends AbstractCrudController AdapterCrudController.php:22

Every attribute adapter - the definitions behind scopes, rules, actions and plain attributes ("scope-region", "rule-cart-total", a barcode standard...): their code, icon and label. Each kind is created from its own CRUD, which knows its settings; this list renames and re-icons them, and keeps those attributes still use.

AdapterCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

AdapterCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

AdapterCrudController::configureActions()

public function configureActions(Actions $actions): Actions

Nothing is created here: each kind has its own CRUD, which knows its settings.

AdapterCrudController::isDeletable()

public function isDeletable(object $entity): bool

AdapterCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

AdapterCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Backoffice\Crud\Layout\Widget

PageCrudController class

class PageCrudController extends AbstractCrudController PageCrudController.php:23

Layout pages served at /page/{slug} (WidgetController::Page).

Also what makes that page render for administrators at all: its template links to this CRUD through crudify(), which had no controller to resolve for a Page and handed null to AdminUrlGenerator::setController().

The content is HTML (WysiwygType), like the pages already stored.

PageCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

PageCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

PageCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

PageCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Backoffice\Crud\Thread

TagCrudController class

class TagCrudController extends AbstractCrudController TagCrudController.php:14

TagCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

TagCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

TagCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

TagCrudController::configureFields()

public function configureFields(string $pageName): iterable

TaxonCrudController class

class TaxonCrudController extends AbstractCrudController TaxonCrudController.php:18

The taxonomy: categories that nest (a parent, children), each with a label, a description and keywords per language. Threads are filed under them.

TaxonCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

TaxonCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

TaxonCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

TaxonCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Backoffice\Crud\User

ConnectionCrudController class

class ConnectionCrudController extends AbstractCrudController ConnectionCrudController.php:24

Read-only login audit log (who signed in/failed to, from where, when) - an admin never creates or edits a Connection by hand, entries are written automatically by ConnectionSubscriber on every login attempt.

ConnectionCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

ConnectionCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

ConnectionCrudController::configureActions()

public function configureActions(Actions $actions): Actions

ConnectionCrudController::configureFilters()

public function configureFilters(Filters $filters): Filters

ConnectionCrudController::configureFields()

public function configureFields(string $pageName): iterable

GroupCrudController class

class GroupCrudController extends AbstractCrudController GroupCrudController.php:16

GroupCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

GroupCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

GroupCrudController::createEntity()

public function createEntity(string $entityFqcn): object

GroupCrudController::configureFields()

public function configureFields(string $pageName): iterable

PermissionCrudController class

class PermissionCrudController extends AbstractCrudController PermissionCrudController.php:14

PermissionCrudController::getEntityFqcn()

public static function getEntityFqcn(): string

PermissionCrudController::getPreferredIcon()

public static function getPreferredIcon(): ?string

PermissionCrudController::configureFields()

public function configureFields(string $pageName): iterable

Base\Controller\Client

ContactController class

class ContactController extends AbstractController ContactController.php:16

ContactController::__construct()

public function __construct(FormProxy $formProxy, Notifier $notifier)

ContactController::Contact()

public function Contact(Request $request, array $options = []): Response

NotificationController class

class NotificationController extends AbstractController NotificationController.php:29

The notification center's HTTP surface: the list page, the read marks the bell uses, the push subscription registry, and the service worker itself.

Every mutation is a JSON POST carrying the "notifications" CSRF token in its body (the toolbar renders it as data-csrf), same-origin only. They answer JSON rather than redirecting because the bell updates in place.

const CSRF = "notifications"

NotificationController::__construct()

public function __construct(protected readonly EntityManagerInterface $entityManager, protected readonly NotificationRepository $notificationRepository, protected readonly WebPushService $webPush, protected readonly CsrfTokenManagerInterface $csrfTokenManager, protected readonly ?NotificationLinkerInterface $linker = null)

NotificationController::Index()

public function Index(Request $request, ScreenResponder $responder, AccountScreens $screens): Response

The list: its template and its view model (Base\Screen\Account\NotificationsPage, plan "omnibase agnostique", C5) to omnibase's ScreenResponder - the days' groups by the screen's clock, the token in it, the answers stored by no cache; a template the site overrides gets notifications, unread and unreadOnly as well (deprecated, gone in 4.0).

NotificationController::Latest()

public function Latest(Request $request): JsonResponse

The bell's payload: unread count + latest entries, for a tab that has been open a while (the server-rendered dropdown is only as fresh as the page). Cheap enough to poll on focus, not meant for a timer.

NotificationController::MarkRead()

public function MarkRead(Request $request): JsonResponse

Body: {token, id?, read?} - one notification, or every unread one when id is absent. read defaults to true; false puts one back to unread.

NotificationController::Delete()

public function Delete(Request $request): JsonResponse

Body: {token, id?} - deletes one notification, or every READ one when id is absent.

NotificationController::PushConfig()

public function PushConfig(): JsonResponse

What the browser needs before it can subscribe: the VAPID public key, or null when push is off.

NotificationController::PushSubscribe()

public function PushSubscribe(Request $request): JsonResponse

Body: {token, subscription: PushSubscriptionJSON}

NotificationController::PushUnsubscribe()

public function PushUnsubscribe(Request $request): JsonResponse

Body: {token, endpoint}

NotificationController::ServiceWorker()

public function ServiceWorker(): Response

The service worker. Served from the origin root because a worker's scope cannot exceed its own path: registered from /sw.js it covers the whole site, admin included. Served by PHP rather than as a static file so the bundle owns it - the app's public/ never has to carry a copy. no-cache so a new version is picked up on the next check.

NotificationController::serialize()

public function serialize(Notification $n): array

ThreadSearchController class

class ThreadSearchController extends AbstractController ThreadSearchController.php:16

ThreadSearchController::__construct()

public function __construct(FormProxyInterface $formProxy, EntityManagerInterface $entityManager)

ThreadSearchController::Main()

public function Main(Request $request)

UserProfileController class

class UserProfileController extends AbstractController UserProfileController.php:21

UserProfileController::__construct()

public function __construct(EntityManagerInterface $entityManager, FormProxyInterface $formProxy)

UserProfileController::Edit()

public function Edit(Request $request, int $id = -1)

UserProfileController::Show()

public function Show(Request $request, ScreenResponder $responder, AccountScreens $screens, int $id = -1)

A member's profile: its template and its view model (Base\Screen\Account\ProfilePage, plan "omnibase agnostique", C5) to omnibase's ScreenResponder - the core's template reads the screen alone, a front end gets it in JSON; a template the site overrides gets user as well (deprecated, gone in 4.0).

UserSearchController class

class UserSearchController extends AbstractController UserSearchController.php:17

UserSearchController::__construct()

public function __construct(FormProxyInterface $formProxy, EntityManagerInterface $entityManager)

UserSearchController::Main()

public function Main(Request $request, ?FormInterface $formSearch = null)

UserSettingsController class

class UserSettingsController extends AbstractController UserSettingsController.php:38

UserSettingsController::__construct()

public function __construct(BaseService $baseService, UserRepository $userRepository, SecurityPolicy $securityPolicy, TranslatorInterface $translator)

UserSettingsController::displayTotpQrCode()

public function displayTotpQrCode(TotpAuthenticatorInterface $totpAuthenticator): Response

UserSettingsController::Settings()

public function Settings(Request $request, ConnectionRepository $connectionRepository, ScreenResponder $responder, AccountScreens $screens)

The account's settings: its template and its view model (Base\Screen\Account\SettingsPage, plan "omnibase agnostique", C5) to omnibase's ScreenResponder - each small form an action with its token, the answers stored by no cache; a template the site overrides gets user, sessions and policy as well (deprecated, gone in 4.0).

UserSettingsController::Enrolment()

public function Enrolment(Request $request)

The one-off "your account needs a second factor" prompt.

Reached only by being redirected here (see SecurityEnrolmentSubscriber), and only while the administrator requires a second factor this account does not have. It offers the same three methods the settings page does, plus a way out: the skip is deliberate, so nobody is trapped mid-task by a policy that changed under them. While enrolment is mandatory that answer lives in the session and the prompt returns on the next sign-in; SecurityPolicy::canPostponeEnrolmentPermanently() is what decides.

UserSettingsController::EnrolmentSkip()

public function EnrolmentSkip(Request $request)

UserSettingsController::RenamePasskey()

public function RenamePasskey(int $id, Request $request, PasskeyRepository $passkeyRepository, EntityManagerInterface $entityManager)

UserSettingsController::DeletePasskey()

public function DeletePasskey(int $id, Request $request, PasskeyRepository $passkeyRepository, EntityManagerInterface $entityManager)

UserSettingsController::LogoutSession()

public function LogoutSession(int $id, Request $request, ConnectionRepository $connectionRepository, EntityManagerInterface $entityManager)

UserSettingsController::TwoFactorAuthentification()

public function TwoFactorAuthentification(Request $request, EntityManagerInterface $entityManager, TotpAuthenticatorInterface $totpAuthenticator)

UserSettingsController::TwoFactorAuthentification_Disable()

public function TwoFactorAuthentification_Disable(Request $request, EntityManagerInterface $entityManager, UserPasswordHasherInterface $passwordHasher)

UserSettingsController::TwoFactorAuthentification_ToggleEmail()

public function TwoFactorAuthentification_ToggleEmail(Request $request, EntityManagerInterface $entityManager)

UserSettingsController::TwoFactorAuthentification_QrCode()

public function TwoFactorAuthentification_QrCode(Request $request, TotpAuthenticatorInterface $totpAuthenticator)

Base\Controller\UX

AutocompleteController class

class AutocompleteController extends AbstractController AutocompleteController.php:26

AutocompleteController::__construct()

public function __construct(ObfuscatorInterface $obfuscator, RequestStack $requestStack, TradingInterface $tradingMarket, TranslatorInterface $translator, EntityManagerInterface $entityManager, PaginatorInterface $paginator, ClassMetadataManipulator $classMetadataManipulator, ?MediaServiceInterface $mediaService = null, ?Profiler $profiler = null, ?ManagerRegistry $doctrine = null)

AutocompleteController::Main()

public function Main(Request $request, string $data): Response

AutocompleteController::Forex()

public function Forex(Request $request, string $source, string $target, string $data, ?Profiler $profiler = null): Response

AutocompleteController::Icons()

public function Icons(Request $request, string $provider, int $pageSize, string $data, ?Profiler $profiler = null): Response

AutovalidateController class

class AutovalidateController extends AbstractController AutovalidateController.php:16

AutovalidateController::__construct()

public function __construct(TranslatorInterface $translator, EntityManagerInterface $entityManager)

AutovalidateController::encode()

public function encode(array $array): string

AutovalidateController::decode()

public function decode(string $hash): array

AutovalidateController::Main()

public function Main(Request $request, string $hashid): Response

DropzoneController class

class DropzoneController extends AbstractController DropzoneController.php:19

const CACHE_DURATION = 24 * 3600
const STATUS_OK = "OK"
const STATUS_BAD = "BAD"
const STATUS_NOTOKEN = "NO_TOKEN"

DropzoneController::__construct()

public function __construct(TranslatorInterface $translator, CacheInterface $cache, ObfuscatorInterface $obfuscator, string $cacheDir)

DropzoneController::getCacheDir()

public function getCacheDir()

DropzoneController::Main()

public function Main(Request $request, $data = null): Response

Controller example

DropzoneController::Preview()

public function Preview(string $data, string $uuid): Response

DropzoneController::Delete()

public function Delete(string $data, string $uuid): Response

EditorController class

class EditorController extends AbstractController EditorController.php:34

const STATUS_OK = 1
const STATUS_BAD = 0
const STATUS_NOTOKEN = -1

EditorController::__construct()

public function __construct(ParameterBagInterface $parameterBag, SluggerInterface $slugger, MediaServiceInterface $mediaService, FlysystemInterface $flysystem, TranslatorInterface $translator, RequestStack $requestStack, PaginatorInterface $paginator, ObfuscatorInterface $obfuscator, UserRepository $userRepository, ThreadRepository $threadRepository, TagRepository $tagRepository, CollabRoomResolver $roomResolver, CollabTicketFactory $ticketFactory, ?Profiler $profiler = null)

EditorController::EndpointByUser()

public function EndpointByUser(Request $request, $data = null, array $fields = [], $page = 1): Response

EditorController::EndpointByKeyword()

public function EndpointByKeyword(Request $request, $data = null, array $fields = ["slug"], $page = 1): Response

EditorController::EndpointByThread()

public function EndpointByThread(Request $request, $data = null, array $fields = [], $page = 1): Response

EditorController::UploadByFile()

public function UploadByFile(Request $request, $data = null): Response

EditorController::UploadByUrl()

public function UploadByUrl(Request $request, $data = null): Response

EditorController::CollabTicket()

public function CollabTicket(Request $request): JsonResponse

This action creates a short-lived, signed ticket. A browser presents this ticket to the collab relay. Refer to the relay/ directory of the editorjs-yjs repository for the relay code. This ticket lets a client join a room's WebSocket connection, for the collab_live option. This action uses the same CSRF check and session check as the other actions in this controller. Refer to the Autosave() method below for the reason: this action adds no separate per-room check.

EditorController::Autosave()

public function Autosave(Request $request): JsonResponse

This action is an optional, debounced autosave method. This action serves EditorType fields with the collab_autosave option. This action also serves regular fields with the collab option. This action saves one field's value outside a full form submission. This action uses an optimistic-concurrency version hash. Because of this hash, a stale client never overwrites a newer saved value silently.

This action, by itself, with no WebSocket relay, is the complete "plain autosave" mode. In "live" collaboration mode, the relay calls this same action. In "live" mode, the browser does not call this action directly.

This action has no separate per-entity permission check, by design. A user can reach this action only through a form or a route that already allowed that user in, through this app's normal firewall and session system. This action also needs the same per-action CSRF token as the other actions in this controller. This action creates no new trust boundary.

This action accepts two callers, through two authentication paths. A browser sends the usual session-scoped "token" value, for CSRF protection. A browser uses this path in plain collab_autosave mode. A browser also uses this path as the fallback path in collab_live mode. The collab relay itself uses a different path. The relay saves a collab_live room's content on its own debounced schedule. The relay has no Symfony session for that call. Because of this, the relay sends a "serviceToken" value and a "room" value instead. This action checks these two values through CollabTicketFactory::verifyServiceToken(). This method uses the same shared secret as ticket creation.

MediaController class

class MediaController extends AbstractController MediaController.php:24

MediaController::__construct()

public function __construct(RequestStack $requestStack, Flysystem $flysystem, MediaService $mediaService, ImageCropRepository $imageCropRepository, ?Profiler $profiler = null, ?bool $localCache = null)

MediaController::redirectToRoute()

public function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse

Returns a RedirectResponse to the given route with the given parameters.

MediaController::Serve()

public function Serve($data): Response

MediaController::ImageCropCacheless()

public function ImageCropCacheless($data, string $identifier, ?string $extension = null): Response

MediaController::ImageCrop()

public function ImageCrop($data, string $identifier, ?string $extension = null): Response

MediaController::ImageWebpCacheless()

public function ImageWebpCacheless($data): Response

MediaController::ImageDebug()

public function ImageDebug($data, ?string $extension = null): Response

MediaController::ImageCacheless()

public function ImageCacheless($data, ?string $extension = null): Response

MediaController::ImageWebp()

public function ImageWebp($data): Response

MediaController::ImageSvg()

public function ImageSvg($data): Response

MediaController::Image()

public function Image($data, ?string $extension = null, bool $debug = false): Response

Base\Database

Events class

final class Events Events.php:5

const resolveDiscriminator = 'resolveDiscriminator'
const preQuery = 'preQuery'
const onQuery = 'onQuery'
const postQuery = 'postQuery'

Base\DatabaseSubscriber

AttributeSubscriber class

class AttributeSubscriber AttributeSubscriber.php:18

AttributeSubscriber::__construct()

public function __construct(EntityManagerInterface $entityManager, ClassMetadataManipulator $classMetadataManipulator, AttributeReader $attributeReader)

AttributeSubscriber::loadClassMetadata()

public function loadClassMetadata(LoadClassMetadataEventArgs $event)

AttributeSubscriber::resolveDiscriminator()

public function resolveDiscriminator(ResolveDiscriminatorEventArgs $event)

AttributeSubscriber::preQuery()

public function preQuery(DoctrineQueryEventArgs $event): void

AttributeSubscriber::onQuery()

public function onQuery(DoctrineQueryEventArgs $event)

AttributeSubscriber::postQuery()

public function postQuery(DoctrineQueryEventArgs $event)

AttributeSubscriber::preFlush()

public function preFlush(PreFlushEventArgs $event)

AttributeSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $event)

AttributeSubscriber::postFlush()

public function postFlush(PostFlushEventArgs $event)

AttributeSubscriber::prePersist()

public function prePersist(LifecycleEventArgs $event)

AttributeSubscriber::preUpdate()

public function preUpdate(LifecycleEventArgs $event)

AttributeSubscriber::preRemove()

public function preRemove(LifecycleEventArgs $event)

AttributeSubscriber::postLoad()

public function postLoad(LifecycleEventArgs $event)

AttributeSubscriber::postPersist()

public function postPersist(LifecycleEventArgs $event)

AttributeSubscriber::postUpdate()

public function postUpdate(LifecycleEventArgs $event)

AttributeSubscriber::postRemove()

public function postRemove(LifecycleEventArgs $event)

DemoAccountLockSubscriber class

class DemoAccountLockSubscriber DemoAccountLockSubscriber.php:31

A demonstration account stays what its declaration says, whoever asks and through whichever form (registered in the demo environment only): its identifier, its address, its password, its second factor are put back before anything is written, it is not disabled, it is not deleted.

The pages of omnibase that change these refuse first, with a message (SecurityPolicy::isDemoAccount()); this is what holds for the others - the application's own "my account" page, the back office's users. A visitor signed in as "docteur" who could change that password would lock the next one out until the night's reset.

Only during a request: the fixtures and demo:reset write these accounts from the console.

DemoAccountLockSubscriber::__construct()

public function __construct(readonly DemoAccountRegistry $accounts, readonly RequestStack $requestStack, readonly PasswordHasherFactoryInterface $hashers, readonly ?TranslatorInterface $translator = null)

DemoAccountLockSubscriber::preFlush()

public function preFlush(PreFlushEventArgs $event): void

DemoAccountLockSubscriber::reset()

public function reset(): void

One message a request: the service lives across requests in a worker.

EnumSubscriber class

class EnumSubscriber implements EventSubscriber EnumSubscriber.php:11

EnumSubscriber::getSubscribedEvents()

public function getSubscribedEvents(): array

EnumSubscriber::postGenerateSchema()

public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs)

IntlSubscriber class

class IntlSubscriber IntlSubscriber.php:26

IntlSubscriber::getLocalizer()

public function getLocalizer()

IntlSubscriber::__construct()

public function __construct(EntityManagerInterface $entityManager, ?LocalizerInterface $localizer = null)

The localizer is the framework's service; an entity manager built by hand maps the translations without it.

IntlSubscriber::onQuery()

public function onQuery(DoctrineQueryEventArgs $args)

IntlSubscriber::resolveDiscriminator()

public function resolveDiscriminator(ResolveDiscriminatorEventArgs $resolveDiscriminatorEventArgs)

IntlSubscriber::postLoad()

public function postLoad(LifecycleEventArgs $args)

IntlSubscriber::upgradeIntl()

public function upgradeIntl($intl)
Throws

Exception

IntlSubscriber::prePersist()

public function prePersist(PrePersistEventArgs $args)

The same as preFlush(), for an entity the flush itself finds new through a cascade (it was in no scheduled insertion before).

IntlSubscriber::preFlush()

public function preFlush(PreFlushEventArgs $args)

A translation translate() handed out for a locale the entity had none in is held aside until written in (TranslatableTrait): the written ones join their entity's collection here, before the unit of work computes what to insert, so $entity->translate('de')->setTitle(...) then flush() persists the German title as it always did.

IntlSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $args)

IntlSubscriber::loadClassMetadata()

public function loadClassMetadata(LoadClassMetadataEventArgs $loadClassMetadataEventArgs): void

Adds mapping to the translatable and translations.

InverseCollectionCacheSubscriber class

class InverseCollectionCacheSubscriber InverseCollectionCacheSubscriber.php:27

Keeps the second-level cache's INVERSE collections true.

Doctrine refreshes the cached collection of the side that owns an association and leaves the other side's cached collection as it was: a product that drops a feature still shows in Feature::$products (the tag's threads) until the cache expires, so a "still in use" check or a listing reads a relation the database no longer has. On each flush, the inverse collection of every entity that joined or left an owning side - a many-to-many collection, or a many-to-one/one-to-one reference - is evicted, and reloads from the database on next read.

The whole region of that association goes, not the one entry: Doctrine's own Cache::evictCollection() builds its key without the SQL-filter hash its persisters add, so with a filter enabled it evicts nothing, and each set of enabled filters (front, back office) caches its own copy anyway.

InverseCollectionCacheSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $args): void

TrackingPolicySubscriber class

class TrackingPolicySubscriber TrackingPolicySubscriber.php:11

TrackingPolicySubscriber::__construct()

public function __construct(ClassMetadataManipulator $classMetadataManipulator)

TrackingPolicySubscriber::loadClassMetadata()

public function loadClassMetadata(LoadClassMetadataEventArgs $args)

Base\Database\Attribute

Alias class

class Alias extends AbstractAttribute implements ExtensionOptionInterface Alias.php:15

public string $alias
public string $column
public ?string $type

Alias::__construct()

public function __construct(string $column = "", string $alias = "", ?string $type = null)

Alias::supports()

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

Alias::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Alias::bind()

public function bind($entity, $column, $alias)

Alias::postLoad()

public function postLoad(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Alias::prePersist()

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

Alias::preUpdate()

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

Associate class

class Associate extends AbstractAttribute implements ExtensionOptionInterface Associate.php:20

public string $metadata

Associate::__construct()

public function __construct(string $metadata)

Associate::supports()

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

Associate::preUpdate()

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

Associate::prePersist()

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

Associate::postUpdate()

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

Associate::postPersist()

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

Associate::postLoad()

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

Associate::preLifecycleEvent()

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

Associate::postLifecycleEvent()

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

Blameable class

class Blameable extends AbstractAttribute implements ExtensionOptionInterface Blameable.php:15

Class Blameable package Base\AttributeReader\Abstract\Blameable

Blameable::__construct()

public function __construct(string|array $on = [], array $fields = [], bool $impersonator = false)

Blameable::getContext()

public function getContext(): array

Blameable::getFields()

public function getFields(): array

Blameable::supports()

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

Blameable::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Blameable::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Cache class

class Cache extends AbstractAttribute implements ExtensionOptionInterface Cache.php:16

Caching to an entity or a collection.

public string $usage = self::READ_ONLY
const READ_ONLY = "READ_ONLY"
const NONSTRICT_READ_WRITE = "NONSTRICT_READ_WRITE"
const READ_WRITE = "READ_WRITE"
public ?string $region
public int $associations = 0
const ONE_TO_ONE = "ONE_TO_ONE"
const MANY_TO_ONE = "MANY_TO_ONE"
const ONE_TO_MANY = "ONE_TO_MANY"
const MANY_TO_MANY = "ONE_TO_ONE"
const TO_ONE = "TO_ONE"
const TO_MANY = "TO_MANY"
const ALL = "ALL"
const NONE = "NONE"

Cache::__construct()

public function __construct(string $usage = 'READ_ONLY', ?string $region = null, ?string $associations = null)

Cache::supports()

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

Cache::getRegion()

public function getRegion(ClassMetadata $classMetadata)

Cache::getRegionProperty()

public function getRegionProperty(ClassMetadata $classMetadata, string $property)

Cache::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Cache::payload()

public function payload(BaseLifecycleEventArgs $event, ClassMetadata $classMetadata, mixed $target, ?string $targetValue = null)

Cache::prePersist()

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

Cache::preUpdate()

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

Cache::preRemove()

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

Cascade class

class Cascade extends AbstractAttribute implements ExtensionOptionInterface Cascade.php:11

Cascade::__construct()

public function __construct(string $column = "", array $value = [])

Cascade::supports()

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

Cascade::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Countify class

class Countify extends AbstractAttribute implements ExtensionOptionInterface Countify.php:12

const COUNT_CHARS = "chars"
const COUNT_LETTERS = "letters"
const COUNT_WORDS = "words"
const COUNT_SENTENCES = "sentences"
const COUNT_BLOCKS = "blocks"

Countify::__construct()

public function __construct(?string $reference = null, string $type = "")

Countify::getReferenceColumn()

public function getReferenceColumn()

Countify::supports()

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

Countify::getCount()

public function getCount($entity): int
Throws

Exception

Countify::postLoad()

public function postLoad(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

Countify::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

Countify::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

DiscriminatorEntry class

class DiscriminatorEntry extends AbstractAttribute implements ExtensionOptionInterface DiscriminatorEntry.php:11

DiscriminatorEntry::__construct()

public function __construct(?string $value = null)

DiscriminatorEntry::getValue()

public function getValue(object|string $object_or_class): string

DiscriminatorEntry::supports()

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

Exception

DiscriminatorEntry::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

GenerateUuid class

class GenerateUuid extends AbstractAttribute implements ExtensionOptionInterface GenerateUuid.php:19

Class GenerateUuid package Base\Database\Attribute\GenerateUuid

const V1_MAC = 1
const V2_DCE = 2
const V3_MD5 = 3
const V4_RANDOM = 4
const V5_SHA1 = 5
const V6_SORTABLE = 6
const UUID_NS_DNS = "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
const UUID_NS_URL = "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
const UUID_NS_OID = "6ba7b812-9dad-11d1-80b4-00c04fd430c8"
const UUID_NS_X500 = "6ba7b814-9dad-11d1-80b4-00c04fd430c8"

GenerateUuid::__construct()

public function __construct(int $version = self::V4_RANDOM, ?string $namespace = null)

GenerateUuid::getVersion()

public function getVersion()

GenerateUuid::getUuid()

public function getUuid($entity): string

GenerateUuid::supports()

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

GenerateUuid::onFlush()

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

Exception

Hashify class

class Hashify extends AbstractAttribute implements ExtensionOptionInterface Hashify.php:24

Class Hashify package Base\Database\Attribute\Hashify

public ?string $referenceColumn
public bool $random
public string $algorithm
public string $hashAlgorithm
public string $plain
public bool $nullable
public array $migrateFrom
public int $keyLength
public bool $ignoreCase
public bool $encodeAsBase64
public int $iterations
public ?int $cost
public ?int $memoryCost
public ?int $timeCost

Hashify::__construct()

public function __construct(?string $reference = null, bool $random = false, string $algorithm = "auto", string $hash_algorithm = "sha512", bool $nullable = false, array $migrateFrom = [], int $key_length = 40, bool $ignore_case = false, bool $encore_as_base64 = true, int $iterations = 5000, ?int $cost = null, ?int $memory_cost = null, ?int $time_cost = null)

Hashify::getHashify()

public static function getHashify($className, $property)
Throws

Exception

Hashify::getMessageHasher()

public function getMessageHasher($entity)

Hashify::needsRehash()

public function needsRehash($entity, string $hashedMessage): bool

Hashify::isValid()

public static function isValid($entity, $property, $hashedMessage): bool
Throws

Exception

Hashify::supports()

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

Hashify::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Hashify::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Hashify::postPersist()

public function postPersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

Hashify::postUpdate()

public function postUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

Hierarchify class

class Hierarchify extends AbstractAttribute implements ExtensionOptionInterface Hierarchify.php:16

Class Hierarchify package Base\Database\Attribute\Hierarchify.

public array|string $hierarchy
public ?string $separator

Hierarchify::__construct()

public function __construct(string|array|null $hierarchy = null, ?string $separator = "/")

Hierarchify::supports()

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

Hierarchify::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Hierarchify::parent_method_exists()

public function parent_method_exists($object, $method)

OrderColumn class

class OrderColumn extends AbstractAttribute implements ExtensionInlineInterface OrderColumn.php:21

const ASC = "ASC"
const DESC = "DESC"
public ?string $orderBy
public string $type

OrderColumn::__construct()

public function __construct(?string $orderBy = null, string $type = self::ASC)

OrderColumn::supports()

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

Exception

OrderColumn::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

OrderColumn::prePersist()

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

OrderColumn::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

OrderColumn::postLoad()

public function postLoad(LifecycleEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

OrphanRemoval class

class OrphanRemoval extends AbstractAttribute implements ExtensionOptionInterface OrphanRemoval.php:19

OrphanRemoval::__construct()

public function __construct(string $column = "", bool $value = true)

OrphanRemoval::supports()

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

OrphanRemoval::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Randomize class

class Randomize extends AbstractAttribute implements ExtensionOptionInterface Randomize.php:17

Class Randomize package Base\Database\Attribute\Randomize

Randomize::__construct()

public function __construct(?int $length = null, ?string $chars = null)

Randomize::supports()

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

Randomize::onFlush()

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

Exception

Slugify class

class Slugify extends AbstractAttribute implements ExtensionOptionInterface Slugify.php:18

Class Slugify package Base\Database\Attribute\Slugify

Slugify::__construct()

public function __construct(?string $reference = null, bool $unique = true, bool $sync = false, bool $nullable = false, string $separator = "-", array $keep = [], bool $capital = false, ?string $locale = null, ?array $map = null, bool $perType = false)

Slugify::getReferenceColumn()

public function getReferenceColumn()

Slugify::getInvalidSlugs()

public function getInvalidSlugs($event, $entity, $property)
Throws

Exception

Slugify::slug()

public function slug($entity, ?string $input = null, string $suffix = ''): ?string
Throws

Exception

Slugify::getSlug()

public function getSlug($entity, string $property, ?string $defaultInput = null, array $invalidSlugs = []): ?string

Slugify::supports()

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

Slugify::onFlush()

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

Exception

Timestamp class

class Timestamp extends AbstractAttribute implements ExtensionOptionInterface Timestamp.php:18

Class Timestamp package Base\Database\Attribute\Timestamp

Timestamp::__construct()

public function __construct(string|array $on = [], bool $immutable = false, array $fields = [], string $value = "")

Timestamp::getContext()

public function getContext(): array

Timestamp::getFields()

public function getFields(): array

Timestamp::isImmutable()

public function isImmutable(): bool

Timestamp::getValue()

public function getValue(): DateTime

Timestamp::supports()

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

Timestamp::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Timestamp::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Timezone class

class Timezone extends AbstractAttribute implements ExtensionOptionInterface Timezone.php:17

Class Timezone package Base\Database\Attribute\Timezone

const DEFAULT_TIMEZONE = "UTC"

Timezone::__construct()

public function __construct(string|array $on = [], string $value = "")

Timezone::getContext()

public function getContext(): array

Timezone::getValue()

public function getValue(): string

Timezone::supports()

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

Timezone::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Timezone::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Trasheable class

class Trasheable extends AbstractAttribute implements EntityExtensionInterface Trasheable.php:33

Marks an entity as soft-deletable: $em->remove() stamps the deletion field instead of issuing a DELETE, and TrashFilter hides the row from every read.

The behaviour itself lives in TrasheableSubscriber - this class only carries the configuration and knows how to find itself on a class.

## Why resolve() exists

ReflectionClass::getAttributes() is NOT inheriting, and AttributeReader caches per exact class name, so #[Trasheable] declared on Thread is invisible to Article, Gallery, ArticleCommentReply and every other subtype - which is to say invisible to all of the content this bundle actually manages. Property attributes do not have the problem (getProperties() walks parents), which is why Versionable needs no equivalent.

Making AttributeReader inherit class attributes wholesale is not an option: DiscriminatorEntry, Cache and Hierarchify are all class-level and all mean something different on a subclass. So the walk is done here, by the one attribute that wants it.

public string $deletedAt

Field carrying the deletion date.

public ?string $expiry

How long a trashed entity survives before the purge command may destroy it for good. Null means "use base.extension.empty_trash".

public bool $cascade

Whether the cascade-remove children of a trashed entity are kept.

Translations are cascade:remove, so leaving this off would empty an article of its title and content the moment it hit the trash - and restoring would hand back a blank row.

Trasheable::__construct()

public function __construct(string $field = "deletedAt", ?string $expiry = null, bool $cascade = true)

Trasheable::supports()

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

Exception

Trasheable::resolve()

public static function resolve(object|string $entityOrClass): ?self

Find the attribute on $entityOrClass or on any of its ancestors, nearest declaration first. Doctrine proxies are normalised by the caller passing a ClassMetadata (or its name) rather than get_class($proxy).

Trasheable::has()

public static function has(object|string $entityOrClass): bool

Uploader class

class Uploader extends AbstractAttribute implements ExtensionOptionInterface Uploader.php:33

Class Uploader package Base\Database\Attribute\Uploader

const SYMFONY_FILE = 'Symfony\Component\HttpFoundation\File\File'

The file an upload is handed as (plan "omnibase agnostique", step C3d): what the uploader takes is any \SplFileInfo - Symfony's File and UploadedFile are ones - and what it gives back is Symfony's HttpFoundation File where that component is installed (every Symfony application: an entity's getter typed ?File, a form's FileType get the class they always had), a plain \SplFileInfo elsewhere. The class is named by its string, so the uploader loads nothing of the framework.

Uploader::__construct()

public function __construct(?string $pool = "_", ?string $max_size = null, ?string $storage = null, bool $missable = false, bool $fetch = false, array $config = [], array $mime_types = [], array $formats = [])

Uploader::file()

public static function file(string $path): \SplFileInfo

Uploader::getFileMimeType()

public static function getFileMimeType(\SplFileInfo $file): ?string

The MIME type of a file: its own getMimeType() when it has one (Symfony's File), symfony/mime's guess otherwise.

Uploader::getUploadMaxFilesize()

public static function getUploadMaxFilesize(): int|float

The largest upload PHP accepts, in bytes: the smaller of post_max_size and upload_max_filesize, as Symfony's UploadedFile::getMaxFilesize() reads them (the same parsing: k, m, g, t suffixes; octal and hexadecimal; 0 for no limit).

Uploader::onFlush()

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

Uploader::getStorage()

public function getStorage()

Uploader::getFormats()

public function getFormats()

Uploader::storage()

public function storage()

Uploader::formats()

public function formats()

Uploader::mimeTypes()

public function mimeTypes()

Uploader::isImage()

public function isImage()

Uploader::getPool()

public function getPool()

Uploader::getMissable()

public function getMissable()

Uploader::getDeclaringEntity()

public function getDeclaringEntity(mixed $entity, string $fieldName)
Throws

Exception

Uploader::getPath()

public function getPath(mixed $entity, string $fieldPath, ?string $uuid = null): ?string

Uploader::getPublic()

public static function getPublic($entity, $fieldName)
Throws

Exception

Uploader::getMimeTypes()

public static function getMimeTypes($entity, $fieldName): array

Uploader::getMaxFilesize()

public static function getMaxFilesize($entity, $fieldName): int

Uploader::materializeTemporaryFile()

public static function materializeTemporaryFile(string $index, callable $read): ?\SplFileInfo

Remote objects are copied into a tmpfile() so callers get a real file (see file()). One handle per (adapter, uuid), kept open for the request because closing a tmpfile() deletes it.

Until 2026-09-14 every call fwrite()'d the object into the SAME handle again without rewinding: a second get() of the same field within one request - an entity getter and FileType rendering the same upload, say - handed back a file holding the content twice over, i.e. a corrupt image or document, after paying for a second full download. An upload never changes under its uuid, so once materialized the copy is simply reused.

The table is request-scoped; see forgetTemporaryFiles().

Uploader::forgetTemporaryFiles()

public static function forgetTemporaryFiles(): void

Close every materialized copy; closing a tmpfile() deletes it.

Under FPM, or FrankenPHP classic mode, statics die with the request and this never mattered. A process that outlives the request - FrankenPHP worker mode, a messenger consumer - kept every handle open forever (file descriptors and /tmp space growing without bound), and because spl_object_hash() values are recycled once an adapter is freed, a later request could even be handed one object's bytes under another's key.

Called at the start of every main request and on kernel.reset, by Base\Subscriber\RequestScopedStateSubscriber.

Uploader::get()

public static function get($entity, string $fieldName)
Throws

FilesystemException

Uploader::supports()

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

Uploader::preFlush()

public function preFlush(PreFlushEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null): void
Throws

InvalidMimeTypeException

Throws

InvalidSizeException

Uploader::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)
Throws

Exception

Uploader::postRemove()

public function postRemove(LifecycleEventArgs $event, ClassMetadata $classMetadata, $entity, ?string $property = null)

Vault class

class Vault extends AbstractAttribute Vault.php:24

public string $vault
public array $fields
public array $unique

Vault::__construct()

public function __construct(string $vault = "vault", array $fields = [], array $unique = [])

Vault::supports()

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

Exception

Vault::getKeyPath()

public function getKeyPath(?string $vault = null): string

Where the key pair of a vault is: Symfony's own secrets vault of that environment (bin/console secrets:generate-keys).

Vault::loadKeys()

public function loadKeys(?string $vault = null): array

The key pair of a vault: config/secrets/<vault>/<vault>.decrypt.private.php, else - for the running environment - the SYMFONY_DECRYPTION_SECRET variable (the same key, base64-encoded: how a production server is given it without the file).

Vault::getMarshaller()

public function getMarshaller(?string $vault = null): ?MarshallerInterface

Vault::allowsPlaintext()

public function allowsPlaintext(): bool

base.vault.allow_plaintext: the behaviour of before - without a key pair, a secured field is stored as it is. Off unless a site turns it on.

Vault::canSeal()

public function canSeal(?string $vault = null): bool

Whether a secured field can be stored in this vault: its key pair is there, or the site accepted clear text.

Vault::seal()

public function seal(?MarshallerInterface $marshaller, mixed $value, ?string $vault = null): string

Fails closed: without the vault's key pair the value is refused (VaultKeyNotFoundException), never stored in clear - unless the site said so (base.vault.allow_plaintext).

Throws

VaultKeyNotFoundException

Vault::reveal()

public function reveal(?MarshallerInterface $marshaller, ?string $value): mixed

Vault::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Vault::preFlush()

public function preFlush(PreFlushEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

Vault::preUpdate()

public function preUpdate(LifecycleEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

Vault::prePersist()

public function prePersist(LifecycleEventArgs $event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

Vault::preLifecycleEvent()

public function preLifecycleEvent($event, ClassMetadata $classMetadata, mixed $entity, ?string $property = null): void

Vault::postFlush()

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

Vault::postLoad()

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

Vault::postLifecycleEvent()

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

Versionable class

class Versionable extends AbstractAttribute implements EntityExtensionInterface Versionable.php:24

Marks a property as worth remembering: every flush that changes it appends the old value to the entity's revision history (see VersionableSubscriber, which writes one Revision per entity per flush - not one per field).

Pure metadata, deliberately: the subscriber needs to see ALL of an entity's versioned fields at once to write a single coherent revision, which a per-property lifecycle hook cannot do.

Unlike Trasheable this needs no hierarchy walk - AttributeReader builds property attributes from ReflectionClass::getProperties(), which does include inherited properties, so #[Versionable] on Thread::$slug is seen on Article.

public bool $restorable

Whether the history badge offers to restore this field, or only to read it. Fields whose form widget has no value setter are shown read-only rather than given a button that silently does nothing.

public array $ignore

Top-level keys ignored when deciding whether a JSON-valued field changed. The stored diff still holds the real values - this only governs equality.

EditorJS is why this exists: its payload carries a "time" stamped at save, so opening an article and saving it again without touching a word yields a value that differs from the previous one in that field alone. Left unfiltered, every save would append a ~28 KB revision recording nothing, and five of those would be all the history an article ever had.

Versionable::__construct()

public function __construct(bool $restorable = true, array $ignore = [])

Versionable::comparable()

public function comparable(mixed $value): mixed

The comparable form of a value: same value, minus the volatile keys.

A value that is not a JSON object is returned untouched.

Versionable::supports()

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

Versionable::resolve()

public static function resolve(object|string $entityOrClass): array

Versioned property names for a class, mapped to their attribute.

Versionable::anchor()

public static function anchor(object $entity): array

Where an entity's revisions live, and the prefix its field names carry there.

A translation is not versioned in its own right: its history belongs to the translatable it translates, under a locale-prefixed key. Shared by the subscriber that writes revisions and the form extension that reads them back, so the two can never disagree about the key.

Versionable::has()

public static function has(object|string $entityOrClass, ?string $property = null): bool

Base\Database\Attribute\Extension

ExtensionHookInterface interface

interface ExtensionHookInterface extends EntityExtensionInterface ExtensionHookInterface.php:7

ExtensionHookInterface::getProperties()

public function getProperties(): array

Returns the properties of the extension.

ExtensionInlineInterface interface

interface ExtensionInlineInterface extends EntityExtensionInterface ExtensionInlineInterface.php:7

ExtensionMetadataInterface interface

interface ExtensionMetadataInterface extends EntityExtensionInterface ExtensionMetadataInterface.php:7

ExtensionMetadataInterface::payload()

public function payload(string $action, string $className, array $properties, object $entity): array

ExtensionMetadataInterface::get()

public static function get(): array

ExtensionMetadataInterface::has()

public static function has(string $className, ?string $property = null): bool

ExtensionOptionInterface interface

interface ExtensionOptionInterface extends EntityExtensionInterface ExtensionOptionInterface.php:8

ExtensionOptionInterface::supports()

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

ExtensionOptionInterface::loadClassMetadata()

public function loadClassMetadata(ClassMetadata $classMetadata, string $target, ?string $targetValue = null): void

Base\Database\Common\Collections

OrderedArrayCollection class

class OrderedArrayCollection extends ArrayCollection OrderedArrayCollection.php:12

OrderedArrayCollection::__construct()

public function __construct(Collection|array $array = [], array $positions = [])

OrderedArrayCollection::getPositions()

public function getPositions()

OrderedArrayCollection::reorder()

public function reorder()

OrderedArrayCollection::toArray()

public function toArray(): array

OrderedArrayCollection::first()

public function first(): mixed

{@inheritDoc}

OrderedArrayCollection::last()

public function last(): mixed

{@inheritDoc}

OrderedArrayCollection::key()

public function key(): int|string|null

{@inheritDoc}

OrderedArrayCollection::next()

public function next(): mixed

{@inheritDoc}

OrderedArrayCollection::current()

public function current(): mixed

{@inheritDoc}

OrderedArrayCollection::offsetExists()

public function offsetExists(mixed $offset): bool

{@inheritDoc}

OrderedArrayCollection::offsetGet()

public function offsetGet(mixed $offset): mixed

{@inheritDoc}

OrderedArrayCollection::offsetSet()

public function offsetSet(mixed $offset, mixed $value): void

{@inheritDoc}

OrderedArrayCollection::offsetUnset()

public function offsetUnset(mixed $offset): void

{@inheritDoc}

OrderedArrayCollection::indexOf()

public function indexOf($element): string|int|false

{@inheritDoc}

OrderedArrayCollection::get()

public function get(string|int $key): mixed

{@inheritDoc}

OrderedArrayCollection::getKeys()

public function getKeys(): array

{@inheritDoc}

OrderedArrayCollection::getValues()

public function getValues(): array

{@inheritDoc}

OrderedArrayCollection::set()

public function set(string|int $key, mixed $value): void

OrderedArrayCollection::getIterator()

public function getIterator(): Traversable

OrderedArrayCollection::map()

public function map(Closure $func): static

OrderedArrayCollection::reduce()

public function reduce(Closure $func, $initial = null): mixed

OrderedArrayCollection::filter()

public function filter(Closure $p): static

OrderedArrayCollection::findFirst()

public function findFirst(Closure $p): mixed

OrderedArrayCollection::forAll()

public function forAll(Closure $p): bool

OrderedArrayCollection::partition()

public function partition(Closure $p): array

OrderedArrayCollection::slice()

public function slice(int $offset, int|null $length = null): array

OrderedArrayCollection::matching()

public function matching(Criteria $criteria): Collection&Selectable

Collection&Selectable satisfies both doctrine/collections majors: 2.x declares ReadableCollection&Selectable here (Collection extends ReadableCollection), 3.x narrowed ArrayCollection::matching() to Collection - and the old ReadableCollection&Selectable is not a subtype of that, a compile error that took the whole kernel down.

Base\Database\Entity

EntityExtension class

class EntityExtension EntityExtension.php:5

const TARGET_CLASS = "class"
const TARGET_METHOD = "method"
const TARGET_PROPERTY = "property"
const ACTION_CREATE = 'create'
const ACTION_UPDATE = 'update'
const ACTION_REMOVE = 'remove'

EntityExtension::getExtensions()

public function getExtensions(): array

EntityExtension::addExtension()

public function addExtension(EntityExtensionInterface $extension): self

EntityExtensionInterface interface

interface EntityExtensionInterface EntityExtensionInterface.php:5

EntityHydrator class

class EntityHydrator implements EntityHydratorInterface EntityHydrator.php:35

const HYDRATE_BY_FIELD = 1
const HYDRATE_BY_COLUMN = 2
const DEFAULT_AGGREGATE = 0b0

Aggregate methods: by default, it is "object properties" by "deep copy" method without fallback, but initializing properties

const CLASS_METHODS = 0b1
const OBJECT_PROPERTIES = 0b10
const PREVENT_ASSOCIATIONS = 0b100
const ARRAY_OBJECT = 0b1000
const DEEPCOPY = 0b10000
const CONSTRUCT = 0b100000
const INITIALIZE = 0b1000000
const IGNORE_NULLS = 0b10000000
const AUTOTYPE = 0b100000000
const OBJECT_INHERITED = 0b1000000000
const FETCH_ASSOCIATIONS = 0b10000000000

EntityHydrator::__construct()

public function __construct(EntityManagerInterface $entityManager, ClassMetadataManipulator $classMetadataManipulator)

EntityHydrator::hydrate()

public function hydrate(mixed $entity, null|array|object $data = [], array $fieldExceptions = [], int $aggregateModel = self::DEFAULT_AGGREGATE, ...$constructArguments): mixed

EntityHydrator::dehydrate()

public function dehydrate(mixed $entity, array $fieldExceptions = [], int $aggregateModel = self::CLASS_METHODS | self::OBJECT_PROPERTIES): ?array

EntityHydrator::fromProxy()

public function fromProxy(Proxy $proxy)

EntityHydrator::toArray()

public function toArray(object|array $objectOrArray, bool $deepcast = false): array

EntityHydrator::clone()

public function clone(object $entity, int $aggregateModel = self::DEEPCOPY)

EntityHydrator::setHydrateAssociationReferences()

public function setHydrateAssociationReferences(bool $hydrateAssociationReferences)

EntityHydrator::getEntityFromData()

public function getEntityFromData($className, $data): ?object
Throws

Exception

EntityHydrator::getOriginalEntity()

public function getOriginalEntity($eventOrEntity)
Throws

Exception

EntityHydrator::getOriginalEntityData()

public function getOriginalEntityData($eventOrEntity)

EntityHydratorInterface interface

interface EntityHydratorInterface EntityHydratorInterface.php:5

EntityHydratorInterface::hydrate()

public function hydrate(mixed $entity, null|array|object $data = [], array $fieldExceptions = [], int $aggregateModel = EntityHydrator::DEFAULT_AGGREGATE, ...$constructArguments): mixed

EntityHydratorInterface::dehydrate()

public function dehydrate(mixed $entity, array $fieldExceptions = []): ?array

EntityHydratorInterface::getOriginalEntity()

public function getOriginalEntity($eventOrEntity)

Base\Database\Entity\AggregateHydrator

PopulableInterface interface

interface PopulableInterface PopulableInterface.php:5

PopulableInterface::populate()

public function populate(array $data = [])

SerializableInterface interface

interface SerializableInterface SerializableInterface.php:5

SerializableInterface::exchangeArray()

public function exchangeArray(array|object $array): array

SerializableInterface::getArrayCopy()

public function getArrayCopy(): array

Base\Database\Entity\Extension

AliasInterface interface

interface AliasInterface AliasInterface.php:5

AliasInterface::__call()

public function __call(string $method, array $args): mixed

AliasInterface::__isset()

public function __isset(string $property): bool

AliasInterface::__get()

public function __get(string $property): mixed

AliasInterface::__set()

public function __set(string $property, mixed $value): void

AliasTrait trait

trait AliasTrait AliasTrait.php:13

AliasTrait::__get()

public function __get(string $name): mixed

------------------- Magic Accessors -------------------

AliasTrait::__set()

public function __set(string $name, mixed $value): void

AliasTrait::__isset()

public function __isset(string $name): bool

AliasTrait::__call()

public function __call(string $name, array $arguments): mixed

TranslatableAliasTrait trait

trait TranslatableAliasTrait TranslatableAliasTrait.php:7

TranslatableAliasTrait::__call()

public function __call(string $method, array $arguments): mixed

TranslatableAliasTrait::__isset()

public function __isset(string $property): bool

TranslatableAliasTrait::__get()

public function __get(string $property): mixed

TranslatableAliasTrait::__set()

public function __set(string $property, mixed $value): void

TranslatableInterface interface

interface TranslatableInterface TranslatableInterface.php:5

TranslatableInterface::translate()

public function translate(?string $locale)

TranslatableInterface::getTranslations()

public function getTranslations()

TranslatableInterface::clearTranslations()

public function clearTranslations()

TranslatableInterface::addTranslation()

public function addTranslation(TranslationInterface $translation)

TranslatableInterface::removeTranslation()

public function removeTranslation(TranslationInterface $translation)

TranslatableTrait trait

trait TranslatableTrait TranslatableTrait.php:18

TranslatableTrait::getEntityFqcn()

public static function getEntityFqcn(): string

TranslatableTrait::getTranslationEntityClass()

public static function getTranslationEntityClass(bool $withInheritance = true, bool $selfClass = false): ?string

TranslatableTrait::getTranslations()

public function getTranslations()

TranslatableTrait::commitPendingTranslations()

public function commitPendingTranslations()

Moves into the collection the translations translate() handed out that have since been written in; the empty ones stay aside. Called by getTranslations() and translate(), and before each flush by IntlSubscriber::preFlush, so a value written through translate($locale)->setX() is persisted like before.

TranslatableTrait::removeTranslation()

public function removeTranslation(TranslationInterface $translation)

TranslatableTrait::clearTranslations()

public function clearTranslations()

TranslatableTrait::addTranslation()

public function addTranslation(TranslationInterface $translation)

TranslatableTrait::translate()

public function translate(?string $locale = null)

The translation to read or write in a language.

  • translate($locale) is that locale's translation. When the entity has none, a new one for that locale - which the entity holds aside, out of its collection, until a value is written in it: a mere read (a getter asking about a language nothing was written in) creates nothing, and a write (translate('de')->setTitle(...)) is kept as it always was (commitPendingTranslations()).
  • translate() (no locale) is the one to show on the current page: the page's language when something is written in it, else the same language in another region, else the default locale's, else the first available locale's, else any written one; only when nothing is written at all, a new one for the page's language, as above.

A read in a language used to add an empty translation for it to the collection, and a later translate() on a page in that language found it: the default language was lost (Attribute::resolve(null) after resolve('ja') gave null).

Throws

Exception

TranslatableTrait::__call()

public function __call(string $method, array $arguments): mixed
Throws

Exception

TranslatableTrait::__set()

public function __set(string $property, mixed $value): void
Throws

Exception

TranslatableTrait::__get()

public function __get(string $property): mixed
Throws

Exception

TranslatableTrait::__isset()

public function __isset(string $property): bool

TranslationInterface interface

interface TranslationInterface TranslationInterface.php:5

TranslationInterface::getTranslatable()

public function getTranslatable(): ?TranslatableInterface

TranslationInterface::setTranslatable()

public function setTranslatable(?TranslatableInterface $translatable)

TranslationInterface::getLocale()

public function getLocale(): ?string

TranslationInterface::setLocale()

public function setLocale(string $locale)

TranslationInterface::isEmpty()

public function isEmpty(): bool

TranslationTrait trait

trait TranslationTrait TranslationTrait.php:11

TranslationTrait::getId()

public function getId(): ?int

TranslationTrait::getEntityFqcn()

public static function getEntityFqcn(): string

Translatable related methods

TranslationTrait::getTranslatableEntityClass()

public static function getTranslatableEntityClass(): string

TranslationTrait::getTranslatable()

public function getTranslatable(): ?TranslatableInterface

TranslationTrait::setTranslatable()

public function setTranslatable(?TranslatableInterface $translatable)

TranslationTrait::getLocale()

public function getLocale(): ?string

TranslationTrait::setLocale()

public function setLocale(string $locale)

TranslationTrait::isEmpty()

public function isEmpty(array $addIgnoredVars = [], ?callable $addConditions = null): bool

TrasheableInterface interface

interface TrasheableInterface TrasheableInterface.php:5

TrasheableTrait trait

trait TrasheableTrait TrasheableTrait.php:9

TrasheableTrait::isDeleted()

public function isDeleted()

TrasheableTrait::getDeletedAt()

public function getDeletedAt(): ?DateTimeInterface

TrasheableTrait::setDeletedAt()

public function setDeletedAt(?DateTimeInterface $deletedAt): self

TrasheableTrait::restore()

public function restore(): self

Take the entity back out of the trash. Nullable is the whole point of the widened setter above: without it there was no way, in code, to undo a soft deletion.

VaultInterface interface

interface VaultInterface VaultInterface.php:5

VaultTrait trait

trait VaultTrait VaultTrait.php:8

VaultTrait::getVault()

public function getVault(): ?string

VaultTrait::setVault()

public function setVault(?string $vault): self

VaultTrait::getPlainVaultBag()

public function getPlainVaultBag(mixed $key): mixed

VaultTrait::getSealedVaultBag()

public function getSealedVaultBag(string $key): ?string

VaultTrait::setVaultBag()

public function setVaultBag(?string $key, string $sealedValue, mixed $plainValue): self

VaultTrait::isSecured()

public function isSecured(): bool

VaultTrait::getSecure()

public function getSecure(): bool

VaultTrait::setSecure()

public function setSecure(bool $secure)

Base\Database\Entity\Extension\Type

EntityHookInterface interface

interface EntityHookInterface EntityHookInterface.php:5

EntityInlineInterface interface

interface EntityInlineInterface EntityInlineInterface.php:5

EntityInlineInterface::getProperties()

public function getProperties(): array

EntityMetadataInterface interface

interface EntityMetadataInterface EntityMetadataInterface.php:5

EntityOptionInterface interface

interface EntityOptionInterface EntityOptionInterface.php:5

EntityOptionInterface::supports()

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

Base\Database\Event

DoctrineQueryEventArgs class

class DoctrineQueryEventArgs extends EventArgs DoctrineQueryEventArgs.php:11

DoctrineQueryEventArgs::__construct()

public function __construct(ClassMetadata $classMetadata, ?QueryBuilder $queryBuilder, ?Query $query = null)

Constructor.

$query

The Doctrine ORM Query object, or null if not yet created

$dql

The DQL string associated with the query

DoctrineQueryEventArgs::getClassMetadata()

public function getClassMetadata(): ClassMetadata

Get the ClassMetadata associated with the query.

DoctrineQueryEventArgs::getQuery()

public function getQuery(): ?Query

Get the current Doctrine Query object (may be null in preQueryCreate).

DoctrineQueryEventArgs::getEntityName()

public function getEntityName(): string

Get the name of the entity associated with the query.

Returns

The fully qualified class name of the entity

DoctrineQueryEventArgs::setQuery()

public function setQuery(Query $query): void

Set the current Doctrine Query object.

$query

The Doctrine ORM Query object

DoctrineQueryEventArgs::getQueryBuilder()

public function getQueryBuilder(): ?QueryBuilder

Get the current QueryBuilder object (may be null in preQueryCreate).

DoctrineQueryEventArgs::setQueryBuilder()

public function setQueryBuilder(QueryBuilder $queryBuilder): void

Set the current QueryBuilder object.

$queryBuilder

The Doctrine ORM QueryBuilder object

ResolveDiscriminatorEventArgs class

class ResolveDiscriminatorEventArgs extends LoadClassMetadataEventArgs ResolveDiscriminatorEventArgs.php:7

Base\Database\Filter

TrashFilter class

class TrashFilter extends SQLFilter TrashFilter.php:27

Hides soft-deleted rows from every read that goes through the ORM.

Registered as "trash_filter" by DoctrineConfigurationPass and enabled in BaseBundle::boot(). Disable it ($em->getFilters()->disable("trash_filter")) to see the trash - the trash listing, the restore flow and the purge command all do exactly that.

NB: the previous implementation emitted

deletedAt < <now + 1h> OR deletedAt IS NULL

which is every row that was ever trashed plus every row that was not, i.e. it hid nothing. That went unnoticed for the same reason nothing else here worked: the filter WAS registered and enabled all along, it just resolved #[Trasheable] with getClassAttributes() on the exact class, which never matches an Article or a Gallery, and returned an empty constraint.

TrashFilter::addFilterConstraint()

public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias): string
Throws

Exception

VaultFilter class

class VaultFilter extends SQLFilter VaultFilter.php:11

VaultFilter::getEnvironment()

public function getEnvironment()

VaultFilter::setEnvironment()

public function setEnvironment(string $environment)

VaultFilter::addFilterConstraint()

public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias): string
Throws

Exception

Base\Database\Function

Field class

class Field extends FunctionNode Field.php:14

Field::parse()

public function parse(Parser $parser): void

Field::getSql()

public function getSql(SqlWalker $sqlWalker): string

JsonArrayPosition class

class JsonArrayPosition extends FunctionNode JsonArrayPosition.php:16

const FUNCTION_NAME = 'JSON_ARRAY_POSITION'
public $jsonExpr
public $searchExpr

JsonArrayPosition::__construct()

public function __construct()

JsonArrayPosition::parse()

public function parse(Parser $parser): void

JsonArrayPosition::getSql()

public function getSql(SqlWalker $walker): string

Rand class

class Rand extends FunctionNode Rand.php:10

Rand::parse()

public function parse(Parser $parser): void

Rand::getSql()

public function getSql(SqlWalker $sqlWalker): string

Base\Database\Mapping

ClassMetadataCompletor class

class ClassMetadataCompletor ClassMetadataCompletor.php:5

ClassMetadataCompletor::__construct()

public function __construct(string $className, array $payload = [])

ClassMetadataCompletor::getName()

public function getName(): ?string

ClassMetadataCompletor::exists()

public function exists($name)

ClassMetadataCompletor::__get()

public function __get($name)

ClassMetadataCompletor::__set()

public function __set(string $name, mixed $value)

ClassMetadataFactory class

class ClassMetadataFactory extends DoctrineClassMetadataFactory ClassMetadataFactory.php:27

Doctrine's ClassMetadataFactory, as the applications name it in their doctrine.yaml (class_metadata_factory_name), on doctrine/orm as published: it uses nothing Doctrine keeps private (plan "omnibase agnostique", C6).

What it did on a doctrine/orm that glitchr/base-plugin patched - the resolveDiscriminator event before a class is read, the table names checked, the discriminator maps keyed by class name through an overridden getShortName() - is Base\Bridge\Doctrine\MappingDriver's, the driver the bundle wraps every entity manager's with, and which an entity manager built by hand gets from Base\Bridge\Doctrine\Mapping::register(), on Doctrine's own factory. Kept here: the naming strategy given back to a ClassMetadata read from the cache, getAllClassNames() and isEntity().

ClassMetadataFactory::setEntityManager()

public function setEntityManager(EntityManagerInterface $em): void

ClassMetadataFactory::getAllClassNames()

public function getAllClassNames()

ClassMetadataFactory::isEntity()

public function isEntity($class): bool

{@inheritDoc}

ClassMetadataManipulator class

class ClassMetadataManipulator extends AbstractLocalCache ClassMetadataManipulator.php:45

const DEFAULT_TRACKING = 0

ClassMetadataManipulator::__construct()

public function __construct(ManagerRegistry $doctrine, EntityManagerInterface $entityManager, ?string $cacheDir = null, ?string $buildDir = null, array $globalExcludedFields = ['id', 'translatable', 'locale'])

ClassMetadataManipulator::getEntityManager()

public function getEntityManager(): EntityManagerInterface

ClassMetadataManipulator::isEntity()

public function isEntity($entityOrClassOrMetadata): bool
Throws

Doctrine\Persistence\Mapping\MappingException

ClassMetadataManipulator::isEnumType()

public function isEnumType($entityOrClassOrMetadata): bool

ClassMetadataManipulator::isNativeEnum()

public function isNativeEnum(mixed $class): bool

A PHP enum (backed or not), as opposed to omnibase's own EnumType / SetType column types.

ClassMetadataManipulator::getEnumClass()

public function getEnumClass(null|string|object $entityOrClassOrMetadata, string $fieldName): ?string

The PHP enum a column holds: Doctrine's enumType: (which Doctrine also reads by itself from a property typed with a backed enum), null for any other column.

ClassMetadataManipulator::getGlobalTrackingPolicy()

public function getGlobalTrackingPolicy()

ClassMetadataManipulator::setGlobalTrackingPolicy()

public function setGlobalTrackingPolicy(int $policy)
Throws

Exception

ClassMetadataManipulator::getTrackingPolicy()

public function getTrackingPolicy($className)

ClassMetadataManipulator::setTrackingPolicy()

public function setTrackingPolicy($className, int $policy)
Throws

Exception

ClassMetadataManipulator::isSetType()

public function isSetType($entityOrClassOrMetadata): bool

ClassMetadataManipulator::getDoctrineType()

public function getDoctrineType(?string $type)

ClassMetadataManipulator::getPrimaryKey()

public function getPrimaryKey($entity)
Throws

MappingException

ClassMetadataManipulator::getDiscriminatorColumn()

public function getDiscriminatorColumn($entity): ?string

ClassMetadataManipulator::getDiscriminatorValue()

public function getDiscriminatorValue($entity): ?string

ClassMetadataManipulator::getDiscriminatorMap()

public function getDiscriminatorMap($entity): array

ClassMetadataManipulator::getRootEntityName()

public function getRootEntityName($entity): ?string

ClassMetadataManipulator::getRepository()

public function getRepository(null|string|object $entityOrClassOrMetadata)

ClassMetadataManipulator::getClassMetadata()

public function getClassMetadata(null|string|object $entityOrClassOrMetadata)

ClassMetadataManipulator::getFields()

public function getFields(null|string|object $entityOrClassOrMetadata, array $fields = [], array $excludedFields = []): array

ClassMetadataManipulator::getFieldValue()

public function getFieldValue($entity, string|array $fieldPath): mixed
Throws

Exception

ClassMetadataManipulator::setFieldValue()

public function setFieldValue($entity, string|array $fieldPath, $value)

ClassMetadataManipulator::hasField()

public function hasField(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::hasProperty()

public function hasProperty(null|string|object $entityOrClassOrMetadata, string $fieldName): ?string

ClassMetadataManipulator::getPropertyValue()

public function getPropertyValue($entity, string $property)

ClassMetadataManipulator::setPropertyValue()

public function setPropertyValue($entity, string $property, $value)

ClassMetadataManipulator::getType()

public function getType(null|string|object $entityOrClassOrMetadata, string $property)
Throws

MappingException

ClassMetadataManipulator::getClosestEntity()

public function getClosestEntity(FormInterface|FormEvent $form)

ClassMetadataManipulator::getClosestEntityCollection()

public function getClosestEntityCollection(FormInterface|FormEvent $form)

ClassMetadataManipulator::isCollectionOwner()

public function isCollectionOwner(object $entityOrForm, ?Collection $collection = null): ?bool

ClassMetadataManipulator::getDeclaringEntity()

public function getDeclaringEntity(null|string|object $entityOrClassOrMetadata, $fieldPath)
Throws

Exception

ClassMetadataManipulator::getTargetClass()

public function getTargetClass(null|string|object $entityOrClassOrMetadata, $fieldName)
Throws

Exception

ClassMetadataManipulator::getTypeOfField()

public function getTypeOfField(null|string|object $entityOrClassOrMetadata, string $property)
Throws

Exception

ClassMetadataManipulator::getTypeOfAssociation()

public function getTypeOfAssociation(null|string|object $entityOrClassOrMetadata, string $property)
Throws

MappingException

ClassMetadataManipulator::fetchEntityName()

public function fetchEntityName(string $entityName, array|string $fieldPath): ?string

ClassMetadataManipulator::fetchEntityMapping()

public function fetchEntityMapping(string $entityName, array|string $fieldPath): null|FieldMapping|AssociationMapping

ClassMetadataManipulator::isAlias()

public function isAlias(null|object|string $entityOrClassOrMetadata, array|string $fieldPath): bool

ClassMetadataManipulator::getBackFieldName()

public function getBackFieldName(null|object|string $entityOrClassOrMetadata, array|string $fieldName): ?string

ClassMetadataManipulator::getFieldNameMappedBy()

public function getFieldNameMappedBy(null|object|string $entityOrClassOrMetadata, string $mappedBy): ?string

ClassMetadataManipulator::getFieldNameInversedBy()

public function getFieldNameInversedBy(null|object|string $entityOrClassOrMetadata, string $inversedBy): ?string

ClassMetadataManipulator::getFieldName()

public function getFieldName(null|object|string $entityOrClassOrMetadata, array|string $fieldName): ?string

ClassMetadataManipulator::getFieldNames()

public function getFieldNames(null|object|string $entityOrClassOrMetadata): ?array

ClassMetadataManipulator::resolveFieldPath()

public function resolveFieldPath(null|object|string $entityOrClassOrMetadata, array|string $fieldPath): ?string

ClassMetadataManipulator::getAssociationTargetClass()

public function getAssociationTargetClass(null|string|object $entityOrClassOrMetadata, string $fieldName): string

ClassMetadataManipulator::hasAssociation()

public function hasAssociation(null|string|object $entityOrClassOrMetadata, ?string $fieldName)

ClassMetadataManipulator::hasRecursiveAssociation()

public function hasRecursiveAssociation(null|string|object $entityOrClassOrMetadata, ?string $fieldName)

ClassMetadataManipulator::getFieldMapping()

public function getFieldMapping(null|string|object $entityOrClassOrMetadata, string $fieldName): null|FieldMapping|AssociationMapping

ClassMetadataManipulator::getAssociationMapping()

public function getAssociationMapping(null|string|object $entityOrClassOrMetadata, string $fieldName): ?AssociationMapping

ClassMetadataManipulator::getUniqueKeys()

public function getUniqueKeys(null|string|object $entityOrClassOrMetadata, bool $inherits = false): ?array

ClassMetadataManipulator::hasTranslation()

public function hasTranslation(null|string|object $entityOrClassOrMetadata): bool

ClassMetadataManipulator::getTranslationMapping()

public function getTranslationMapping(null|string|object $entityOrClassOrMetadata, string $fieldName): ?FieldMapping

ClassMetadataManipulator::getMapping()

public function getMapping(null|string|object $entityOrClassOrMetadata, string $fieldName): null|FieldMapping|AssociationMapping

ClassMetadataManipulator::getAssociationMappings()

public function getAssociationMappings(null|string|object $entityOrClassOrMetadata): ?array

ClassMetadataManipulator::isOwningSide()

public function isOwningSide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isInverseSide()

public function isInverseSide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isToOneSide()

public function isToOneSide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isToManySide()

public function isToManySide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isManyToSide()

public function isManyToSide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isOneToSide()

public function isOneToSide(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isManyToMany()

public function isManyToMany(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isOneToMany()

public function isOneToMany(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isManyToOne()

public function isManyToOne(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::isOneToOne()

public function isOneToOne(null|string|object $entityOrClassOrMetadata, string $fieldName): bool

ClassMetadataManipulator::getAssociationType()

public function getAssociationType(null|string|object $entityOrClassOrMetadata, string $fieldName)
Throws

MappingException

ClassMetadataManipulator::getAllClassNames()

public function getAllClassNames()

ClassMetadataManipulator::getClassMetadataCompletor()

public function getClassMetadataCompletor(null|string|object $entityOrClassOrMetadata): ?ClassMetadataCompletor

ClassMetadataManipulator::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

ClassMetadataManipulator::enrichAndSaveCompletors()

public function enrichAndSaveCompletors(\Base\Attributes\AttributeReader $attributeReader): void

Runs the attribute-driven loadClassMetadata pipeline for every entity so that completors get their aliasNames, entityHierarchy, etc. fields populated, then persists the enriched completors to the /Completors cache entry.

Must be called from a context where both this service and the AttributeReader are fully constructed (i.e. a Symfony cache warmer), never from __construct (that would recurse through the AttributeReader -> ClassMetadataManipulator dependency).

ClassMetadataManipulator::saveCompletors()

public function saveCompletors()

NamingStrategy class

class NamingStrategy extends NamingStrategy NamingStrategy.php:20

omnibase's names for tables and columns: App\Entity\Thread\Tag is threadTag, App\Entity\User\Profile userProfile, Thread::$tags the join table thread_tags (thread_id, threadTag_id), a property its own name.

The rules are omnibridge/doctrine's NamingStrategy (framework-free, the one another framework reading the same database maps with), which this class extends: one place says how a class becomes a table. What omnibase adds on top is kept here, unchanged: a class may be given as an object, and every attribute of an entity is instantiated and must serialize (the metadata cache stores them) - a mistake said at once, with the attribute's name.

NamingStrategy::classToTableName()

public function classToTableName($className): string
Throws

Exception

Base\Database\Middleware

PlatformMiddleware class

class PlatformMiddleware implements Middleware PlatformMiddleware.php:11

PlatformMiddleware::wrap()

public function wrap(Driver $driver): Driver

Base\Database\Repository

ServiceEntityParser class

class ServiceEntityParser ServiceEntityParser.php:29

const ALIAS_ENTITY = 'e'
const REQUEST_FIND = "find"
const REQUEST_CACHE = "cache"
const REQUEST_COUNT = "count"
const REQUEST_DISTINCT = "distinctCount"
const REQUEST_LENGTH = "lengthOf"
const LOAD_EAGERLY = "Eagerly"
const SPECIAL_ALL = "All"
const SPECIAL_ONE = "One"
const SPECIAL_RAND = "Randomly"
const SPECIAL_ATMOST = "AtMost(?P<atMost>[0-9])*"
const SPECIAL_LASTONE = "LastOne"
const SPECIAL_LAST = "Last(?P<last>[0-9])*"
const SPECIAL_PREVONE = "PreviousOne"
const SPECIAL_PREV = "Previous(?P<prev>[0-9]*)"
const SPECIAL_NEXTONE = "NextOne"
const SPECIAL_NEXT = "Next(?P<next>[0-9]*)"
const OPTION_EMPTY = "Empty"
const OPTION_NOT_EMPTY = "NotEmpty"
const OPTION_TRUE = "True"
const OPTION_NOT_TRUE = "NotTrue"
const OPTION_FALSE = "False"
const OPTION_NOT_FALSE = "NotFalse"
const OPTION_NULL = "Null"
const OPTION_NOT_NULL = "NotNull"
const OPTION_EQUAL = "EqualTo"
const OPTION_NOT_EQUAL = "NotEqualTo"
const OPTION_GREATER = "GreaterThan"
const OPTION_GREATER_EQUAL = "GreaterEqualTo"
const OPTION_LOWER = "LowerThan"
const OPTION_LOWER_EQUAL = "LowerEqualTo"
const OPTION_WITHIN = "Within"
const OPTION_OLDER = "OlderThan"
const OPTION_OLDER_EQUAL = "OlderEqualTo"
const OPTION_YOUNGER = "YoungerThan"
const OPTION_YOUNGER_EQUAL = "YoungerEqualTo"
const OPTION_OVER = "IsOver"
const OPTION_NOT_OVER = "IsNotOver"
const OPTION_STARTING_WITH = "StartingWith"
const OPTION_ENDING_WITH = "EndingWith"
const OPTION_NOT_STARTING_WITH = "NotStartingWith"
const OPTION_NOT_ENDING_WITH = "NotEndingWith"
const OPTION_INSENSITIVE = "Insensitive"
const OPTION_WITH_ROUTE = "WithRoute"
const OPTION_PARTIAL = "Partial"
const OPTION_MODEL = "Model"
const OPTION_CLASSOF = "ClassOf"
const OPTION_NOT_CLASSOF = "NotClassOf"
const OPTION_INSTANCEOF = "InstanceOf"
const OPTION_NOT_INSTANCEOF = "NotInstanceOf"
const OPTION_MEMBEROF = "MemberOf"
const OPTION_NOT_MEMBEROF = "NotMemberOf"
const OPTION_BUT = "But"
const OPTION_CLOSESTTO = "ClosestTo"
const OPTION_FARESTTO = "FarestTo"
const SEPARATOR = ":"
const SEPARATOR_OR = "Or"
const SEPARATOR_AND = "And"
const SEPARATOR_FOR = "For"
const SEPARATOR_BY = "By"
const COUNT_ALL = "ALL"
const COUNT_DISTINCT = "DISTINCT"

ServiceEntityParser::__construct()

public function __construct(ServiceEntityRepository $serviceEntity, EntityManager $entityManager, ClassMetadataManipulator $classMetadataManipulator, EntityHydrator $entityHydrator)

ServiceEntityParser::parse()

public function parse($method, $arguments): mixed
Throws

MappingException

ServiceEntityParser::getCustomOption()

public function getCustomOption(string $id)

ServiceEntityParser::findCustomOption()

public function findCustomOption(string $id, string $option)

ServiceEntityRepository class

class ServiceEntityRepository extends EntityRepository ServiceEntityRepository.php:34

A repository of omnibase: Doctrine's EntityRepository, built from the ManagerRegistry contract (doctrine/persistence) as DoctrineBundle's ServiceEntityRepository is - __construct(ManagerRegistry $registry, ?string $entityName = null), the entity's class guessed from the repository's name when not given - plus the finder language (findByStateAndLocale(), cacheOneBySlug(), countByDomain()...).

It no longer extends DoctrineBundle's class (plan "omnibase agnostique", step C3b): loading a repository loads doctrine/orm and doctrine/persistence, not the bundle. Under Symfony it is still a repository service: the bundle tags every service extending this class doctrine.repository_service (BaseExtension, registerForAutoconfiguration(); AbstractBaseBundle:: isRepositoryService() for the bundles' mapped repositories), and DoctrineBundle's ContainerRepositoryFactory hands it out as before.

ServiceEntityRepository::getFqcnEntityName()

public static function getFqcnEntityName()

ServiceEntityRepository::__construct()

public function __construct(ManagerRegistry $doctrine, ?string $entityName = null)

ServiceEntityRepository::getClassMetadata()

public function getClassMetadata(): ClassMetadata

ServiceEntityRepository::getClassMetadataCompletor()

public function getClassMetadataCompletor(): ?ClassMetadataCompletor

ServiceEntityRepository::__call()

public function __call($method, $arguments): mixed

ServiceEntityRepository::find()

public function find($id, $lockMode = null, $lockVersion = null): ?object

ServiceEntityRepository::findAll()

public function findAll(): array

ServiceEntityRepository::findBy()

public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $offset = null): array

ServiceEntityRepository::findOneBy()

public function findOneBy(array $criteria, ?array $orderBy = null): ?object

ServiceEntityRepository::findByExample()

public function findByExample(object $select, ?array $orderBy = null, $limit = null, $offset = null): array

Query-by-Example: build the criteria from the *set* fields of a (usually non-persisted) select entity, then delegate to findBy(). Lets you query with a hydrated object instead of a raw array:

$select = (new Article())->setState('published'); $repo->findByExample($select); // == findBy(['state' => 'published'])

Only mapped scalar fields and to-one associations participate. Uninitialized and null properties are skipped — a select cannot express "IS NULL"; use the finder DSL (e.g. findByStateNull()) for that. Throws when the select yields no criteria, to avoid an accidental whole-table fetch (use findAll() instead).

Throws

Exception

ServiceEntityRepository::criteriaFromSelect()

public function criteriaFromSelect(object $select): array

Reflect over a select entity and collect its set, mapped fields into a findBy()-compatible criteria array. Shared by findByExample() and by the finder DSL's "Model" clause (e.g. findByModelAndIdGreaterThan($select, 0)).

ServiceEntityRepository::count()

public function count(array $criteria = []): int

The number of rows matching $criteria (all of them for []), as Doctrine's count() promises: an int, never the grouped rows.

ServiceEntityRepository::flush()

public function flush(bool $autoclear = false)

Flushes the unit of work - and clears the EntityManager only when asked: cleared by default (as it was), a request's signed-in user and every entity it held were detached for the rest of it, so the next flush touching them duplicated rows or failed on "a new entity was found through the relationship" (as SecuritySubscriber's did). A batch that wants its memory back passes true.

ServiceEntityRepository::clear()

public function clear()

ServiceEntityRepository::persist()

public function persist($entity, bool $flush = false): void
Throws

Exception

ServiceEntityRepository::remove()

public function remove($entity, bool $flush = false): void

Base\Database\Type

ArrayType class

class ArrayType extends Type ArrayType.php:28

Type that maps a PHP array to a clob SQL type.

ArrayType::getSQLDeclaration()

public function getSQLDeclaration(array $column, AbstractPlatform $platform): string

{@inheritDoc}

ArrayType::convertToDatabaseValue()

public function convertToDatabaseValue($value, AbstractPlatform $platform): mixed

{@inheritDoc}

ArrayType::convertToPHPValue()

public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mixed

{@inheritDoc}

ArrayType::getName()

public function getName()

{@inheritDoc}

ArrayType::requiresSQLCommentHint()

public function requiresSQLCommentHint(AbstractPlatform $platform)

{@inheritDoc}

DateTimeTypeUTC class

class DateTimeTypeUTC extends DateTimeType DateTimeTypeUTC.php:15

Doctrine's datetime (and datetimetz) as omnibase overrides them with base.database.use_custom (BaseBundle::boot()): a \DateTime moved to UTC as it is written, read back as UTC.

The conversion is omnibridge/doctrine's DateTimeType, the one another framework reading the same database registers (Omnibridge\Doctrine\Types): one place says how a moment is stored. This name stays the type omnibase registers, for the applications and bundles that name it.

EnumType class

abstract class EnumType extends Type implements SelectInterface EnumType.php:18

EnumType::getIcons()

public static function getIcons(): array

EnumType::getColor()

public static function getColor(string $id): ?string

EnumType::getIcon()

public static function getIcon(string $id, int $index = -1): ?string

EnumType::getText()

public static function getText(string $id, ?TranslatorInterface $translator = null): ?string

EnumType::getHtml()

public static function getHtml(string $id): ?string

EnumType::getData()

public static function getData(string $id): ?array

EnumType::getName()

public function getName(): string

EnumType::getStaticName()

public static function getStaticName()

EnumType::hasKey()

public static function hasKey(string $key, bool $inheritance = true)
Throws

Exception

EnumType::getValue()

public static function getValue(string $key, bool $inheritance = true)
Throws

Exception

EnumType::hasValue()

public static function hasValue(string $value, bool $inheritance = true)
Throws

Exception

EnumType::getPermittedValues()

public static function getPermittedValues(bool $inheritance = true, bool $preserve_keys = false): array

EnumType::getPermittedValuesByGroup()

public static function getPermittedValuesByGroup(bool $inheritance = true, bool $preserve_keys = false): array

EnumType::getPermittedValuesByClass()

public static function getPermittedValuesByClass(bool $preserve_groups = true, bool $preserve_keys = false): array

EnumType::getSQLDeclaration()

public function getSQLDeclaration(array $column, AbstractPlatform $platform): string

EnumType::convertToPHPValue()

public function convertToPHPValue($value, AbstractPlatform $platform): mixed

EnumType::convertToDatabaseValue()

public function convertToDatabaseValue($value, AbstractPlatform $platform): mixed
Throws

Exception

SetType class

abstract class SetType extends EnumType SetType.php:8

SetType::getSQLDeclaration()

public function getSQLDeclaration(array $column, AbstractPlatform $platform): string

SetType::convertToPHPValue()

public function convertToPHPValue($value, AbstractPlatform $platform): mixed
Throws

Exception

SetType::convertToDatabaseValue()

public function convertToDatabaseValue($value, AbstractPlatform $platform): mixed
Throws

Exception

SetType::getOrderingKeys()

public static function getOrderingKeys(array $array): array

Utc class

final class Utc Utc.php:13

Moments in UTC, for the code around a utc_datetime_immutable column: the present, and any date as the same moment in UTC - what a query parameter compared with such a column must be when it is bound without its type.

->setParameter('since', Utc::from($since)) // or, typed: ->setParameter('since', $since, UtcDateTimeImmutableType::NAME)

Utc::zone()

public static function zone(): \DateTimeZone

The zone moments are kept in: omnibridge/doctrine's, the one its types (and these) write with.

Utc::now()

public static function now(): \DateTimeImmutable

Utc::from()

public static function from(?\DateTimeInterface $moment): ?\DateTimeImmutable

Any date, as the same moment in UTC.

UtcDateTimeImmutableType class

final class UtcDateTimeImmutableType extends UtcDateTimeImmutableType UtcDateTimeImmutableType.php:31

A moment, written in UTC and read back as UTC (utc_datetime_immutable).

omnibase sets PHP's time zone per visitor (BaseBundle::boot(), from the timezone cookie). Doctrine's own datetime_immutable writes the wall clock of whatever zone the object carries and reads it back in PHP's default one: the same instant is stored at different hours by two requests, and comes back as another moment to a visitor elsewhere. omnibase's datetime is UTC already (DateTimeTypeUTC); this is its immutable twin, declared on a column that holds a moment:

#[ORM\Column(type: UtcDateTimeImmutableType::NAME)]
private \DateTimeImmutable $sentAt;

The column is the platform's DATETIME, as datetime_immutable's: moving a column from one type to the other changes no schema, only what its rows mean (docs/20-architecture/time.md).

What comes back is in UTC; show it with Twig's |date (PHP's zone: the visitor's) or ->setTimezone(). A wall clock that is no moment (a restaurant's reservation at 20:00, an opening hour) is not for this type.

omnibridge/doctrine's UtcDateTimeImmutableType, under omnibase's name: written and read as it writes and reads (in UTC; unreadable, the DBAL's own exception).

const NAME = 'utc_datetime_immutable'

UtcDateTimeType class

final class UtcDateTimeType extends UtcDateTimeType UtcDateTimeType.php:19

UtcDateTimeImmutableType's mutable twin (utc_datetime): a \DateTime written in UTC and read back as UTC, whatever zone PHP is in.

With base.database.use_custom (the default) omnibase's plain datetime is UTC already; this type says so by name, and holds without that option. It leaves the object it is given untouched (DateTimeTypeUTC moves the entity's own \DateTime to UTC as it writes it).

omnibridge/doctrine's UtcDateTimeType, under omnibase's name: written and read as it writes and reads (in UTC; unreadable, the DBAL's own exception), so a site mapped by omnibase and an application mapped by omnibridge/doctrine read each other's rows.

const NAME = 'utc_datetime'

Base\Database\Walker

CountWalker class

class CountWalker extends TreeWalkerAdapter CountWalker.php:11

CountWalker::walkSelectStatement()

public function walkSelectStatement(SelectStatement $AST): void

Walks down a SelectStatement AST node, thereby generating the appropriate SQL.

GroupByWalker class

class GroupByWalker extends TreeWalkerAdapter GroupByWalker.php:11

const HINT_GROUP_ARRAY = "group_by.array"

GroupByWalker::walkSelectStatement()

public function walkSelectStatement(SelectStatement $AST): void

Walks down a SelectStatement AST node, thereby generating the appropriate SQL.

MysqlWalker class

class MysqlWalker extends SqlWalker MysqlWalker.php:7

const HINT_NO_CACHE = "mysql.no_cache"

MysqlWalker::walkSelectClause()

public function walkSelectClause(AST\SelectClause $selectClause): string

Walks down a SelectClause AST node, thereby generating the appropriate SQL.

Returns

The SQL.

TranslatableWalker class

class TranslatableWalker extends SqlOutputWalker implements OutputWalker TranslatableWalker.php:17

const LOCALE = 'locale'
const FOREIGN_KEY = 'translatable_id'
const COLUMN_NAME = 'translations'
const SALT = "unique_translation"

TranslatableWalker::__construct()

public function __construct($query, $parserResult, array $queryComponents)

TranslatableWalker::walkFromClause()

public function walkFromClause($fromClause): string

TranslatableWalker::walkJoinAssociationDeclaration()

public function walkJoinAssociationDeclaration($joinAssociationDeclaration, $joinType = AST\Join::JOIN_TYPE_INNER, $condExpr = null): string
Throws

QueryException

Base\Demo

DemoAccount class

final class DemoAccount DemoAccount.php:15

A demonstration account, as a bundle or the application declares it (DemoAccountProviderInterface): who signs in, as what, and what that role sees. The fixtures create the accounts from these declarations (DemoAccountFactory); in the demo environment the sign-in page offers one button for each (docs/20-architecture/demo.md).

A super-administrator is never a demonstration account: the registry refuses a declaration whose roles reach ROLE_SUPERADMIN.

public readonly string $identifier

what the account signs in with (the field the application's User names in $userIdentifier)

public readonly string $label

the button's text: a translation key ("@health.demo.practitioner.label") or the text itself

public readonly string $description

one sentence on what this role sees: a translation key or the text itself

public readonly array $roles

the account's own roles

public readonly ?string $group

the name of a Base\Entity\User\Group the account belongs to (it holds the group's roles)

public readonly array $groupRoles

the roles of that group, when the fixtures have to create it

public readonly ?string $password

null: the identifier (demonstration accounts are public)

public readonly ?string $email

null: <identifier>@example.org

public readonly int $position

the order on the sign-in page, lowest first

DemoAccount::__construct()

public function __construct(public readonly string $identifier, public readonly string $label, public readonly string $description = '', public readonly array $roles = ['ROLE_USER'], public readonly ?string $group = null, public readonly array $groupRoles = [], public readonly ?string $password = null, public readonly ?string $email = null, public readonly int $position = 0)
$identifier

what the account signs in with (the field the application's User names in $userIdentifier)

$label

the button's text: a translation key ("@health.demo.practitioner.label") or the text itself

$description

one sentence on what this role sees: a translation key or the text itself

$roles

the account's own roles

$group

the name of a Base\Entity\User\Group the account belongs to (it holds the group's roles)

$groupRoles

the roles of that group, when the fixtures have to create it

$password

null: the identifier (demonstration accounts are public)

$email

null: <identifier>@example.org

$position

the order on the sign-in page, lowest first

DemoAccount::getPassword()

public function getPassword(): string

DemoAccount::getEmail()

public function getEmail(): string

DemoAccount::getAllRoles()

public function getAllRoles(): array
Returns

the account's own roles and its group's

DemoAccountFactory class

class DemoAccountFactory DemoAccountFactory.php:22

The declared demonstration accounts as rows: what the fixtures call instead of writing each account by hand, and what demo:reset calls after them so that every declared account exists.

$docteur = $this->demoAccounts->account('docteur', $manager); // found, or created from its declaration $this->demoAccounts->load($manager); // every declared account

An account the database already has is returned as it is: fixtures that create theirs themselves keep them, identifier included. Nothing is flushed here - the fixture does.

DemoAccountFactory::__construct()

public function __construct(readonly DemoAccountRegistry $registry, readonly ManagerRegistry $doctrine, readonly string $userClass = 'App\Entity\User')

DemoAccountFactory::find()

public function find(string $identifier, ?ObjectManager $manager = null): ?object

The row of a declared account, null when the database has none.

DemoAccountFactory::account()

public function account(string $identifier, ?ObjectManager $manager = null): object

The account of that identifier: the database's, or a new one made from its declaration (verified, approved, in its group - created with its roles when missing).

DemoAccountFactory::load()

public function load(?ObjectManager $manager = null): array

Every declared account, created when missing.

Returns

by identifier

DemoAccountFactory::missing()

public function missing(?ObjectManager $manager = null): array

The identifiers of the declared accounts the database lacks.

DemoAccountProviderInterface interface

interface DemoAccountProviderInterface DemoAccountProviderInterface.php:19

Declares demonstration accounts: implemented by a bundle for the roles of its trade (a practitioner, a secretary, a patient) and by the application for its own. Autoconfigured (tag base.demo_account_provider); the application's declaration replaces a bundle's for the same identifier.

final class ShopDemoAccounts implements DemoAccountProviderInterface { public function getDemoAccounts(): iterable { yield new DemoAccount('client', 'demo.client.label', 'demo.client.description'); } }

DemoAccountProviderInterface::getDemoAccounts()

public function getDemoAccounts(): iterable

DemoAccountRegistry class

class DemoAccountRegistry DemoAccountRegistry.php:28

Every demonstration account declared by the bundles and the application (DemoAccountProviderInterface), by identifier. The application's declarations come last and replace a bundle's; base.demo.exclude drops the ones a site has no use for.

It exists in every environment - the fixtures of dev and test create the same accounts as the demonstration's - but only the demo environment does anything with it at sign-in (DemoMode).

A declared account that opens the back office (base.demo.admin_roles) is created like the others and offered to nobody: offered() leaves it out.

A demonstration has one account for each role of the application's user_role type (App\Enum\UserRole, else Base\Enum\UserRole) below the back office: missingRoles() names those without one.

const SUPER_ADMIN = 'ROLE_SUPERADMIN'

DemoAccountRegistry::__construct()

public function __construct(readonly iterable $providers = [], readonly array $exclude = [], readonly ?RoleHierarchyInterface $roleHierarchy = null, readonly array $adminRoles = ['ROLE_ADMIN'])
$exclude

identifiers left out (base.demo.exclude)

$adminRoles

the roles that open the back office (base.demo.admin_roles)

DemoAccountRegistry::all()

public function all(): array
Returns

by identifier, in the order of the sign-in page

DemoAccountRegistry::offered()

public function offered(): array

The declared accounts a visitor is offered - in the banner, on the sign-in page, at a click: every one but those that open the back office.

Returns

by identifier, in the order of the sign-in page

DemoAccountRegistry::missingRoles()

public function missingRoles(?array $roles = null): array

The roles of the application's user_role type (or of $roles) that no account offered holds - leaving out those that open the back office.

ROLE_USER is everyone's: any account offered holds it. Empty when the demonstration has one account for each role it should.

$roles

null: the constants of the user_role type

DemoAccountRegistry::get()

public function get(?string $identifier): ?DemoAccount

DemoAccountRegistry::has()

public function has(?string $identifier): bool

DemoAccountRegistry::of()

public function of(?UserInterface $user): ?DemoAccount

The declaration this account was created from, if it is a demonstration account.

DemoAccountRegistry::reachesSuperAdmin()

public function reachesSuperAdmin(array $roles): bool

Do these roles reach ROLE_SUPERADMIN, directly or through the role hierarchy (a ROLE_EDITOR above it, in the sites where Glitch Art is one)?

DemoAccountRegistry::isSuperAdmin()

public function isSuperAdmin(?UserInterface $user): bool

DemoAccountRegistry::reachesAdministration()

public function reachesAdministration(array $roles): bool

Do these roles open the back office - one of base.demo.admin_roles, directly or through the role hierarchy? A super-administrator's do, wherever the hierarchy puts ROLE_SUPERADMIN above them.

DemoAccountRegistry::isAdministrator()

public function isAdministrator(?UserInterface $user): bool

DemoGuard class

class DemoGuard DemoGuard.php:21

What the demo environment refuses to start on (BaseBundle::boot() asks, for a page as for a command):

  • debug on: the demonstration behaves as production does, and a debug kernel shows its traces to visitors;
  • the production database: demo:reset empties the database it runs on every night. The application says which one production's is (base.demo.production_database, a DSN); a connection that reaches the same server, port and database name is refused, whoever signs in to it. Left unset, nothing can be compared: refused too.

DemoGuard::__construct()

public function __construct(readonly DemoMode $mode, readonly bool $debug, readonly ?string $productionDatabase = null, readonly ?ConnectionRegistry $doctrine = null)

DemoGuard::check()

public function check(): void
Throws

DemoRefusedException

DemoGuard::target()

public static function target(string|array $database): ?string

Where a connection leads - "host:port/name", or a file's path for SQLite - whoever signs in to it: from a DSN or from DBAL's parameters.

Null when it names no database.

DemoMode class

final class DemoMode DemoMode.php:13

Whether the kernel runs the demonstration: the demo environment, and no other. There is no switch to turn it on elsewhere - what it lifts (the staff's second factor) and what it offers (signing in as anyone declared) has no place on a production site.

const ENVIRONMENT = 'demo'

DemoMode::__construct()

public function __construct(readonly string $environment)

DemoMode::isActive()

public function isActive(): bool

Base\DependencyInjection

BaseConfiguration class

class BaseConfiguration extends AbstractBaseConfiguration BaseConfiguration.php:13

BaseConfiguration::getConfigTreeBuilder()

public function getConfigTreeBuilder(): TreeBuilder

BaseExtension class

class BaseExtension extends AbstractBaseExtension implements PrependExtensionInterface BaseExtension.php:29

BaseExtension::load()

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

{@inheritdoc}

BaseExtension::prepend()

public function prepend(ContainerBuilder $builder): void

Base\DependencyInjection\Compiler

AbstractPass class

abstract class AbstractPass implements CompilerPassInterface AbstractPass.php:12

AbstractPass for handling tagged services or entities implementing a specific interface.

AbstractPass::classFqcn()

abstract public function classFqcn(): string

AbstractPass::taggedServiceIds()

abstract public function taggedServiceIds(): ?string

AbstractPass::serviceInterface()

abstract public function serviceInterface(): ?string

AbstractPass::addMethod()

abstract public function addMethod(): string

AbstractPass::addArguments()

public function addArguments(string $className): array

AbstractPass::process()

public function process(ContainerBuilder $container): void

Base\DependencyInjection\Compiler\Pass

AdminUrlGeneratorPass class

final class AdminUrlGeneratorPass implements CompilerPassInterface AdminUrlGeneratorPass.php:19

Binds Base\Routing\AdminUrlGeneratorInterface to whatever back-office is installed.

base-bundle ships form types and Twig helpers that link back to the admin, but a front-end-only install has no admin at all. Resolving the binding in a compiler pass - rather than by registering competing service ids in two bundles - makes the outcome independent of bundle load order.

AdminUrlGeneratorPass::process()

public function process(ContainerBuilder $container): void

ApplicationTextsPass class

final class ApplicationTextsPass implements CompilerPassInterface ApplicationTextsPass.php:23

Which texts the application wrote itself (its own translations/ directory), for the level of politeness (base.translator.politeness, docs/20-architecture/politeness.md).

An application that rewrote a bundle's text under its key - a practice's "Aucun message." in place of a forum's "Tu n'as aucun message dans ta boîte" - wrote it as it speaks. When the bundle later brings a polite variant of its own text ("key._polite"), that variant must not come back in place of the application's: once the catalogues are merged nothing tells whose a text is, so the keys are read here, while the container is built, and given to omnibase's translator. Nothing is read when no level is set.

ApplicationTextsPass::process()

public function process(ContainerBuilder $container): void

ApplicationTextsPass::read()

public static function read(string $directory): array

The keys of every catalogue of a directory: "<domain>[+intl-icu].<locale>.<yaml|yml|php|json>".

Returns

domain => locale => keys, flattened with dots

AttributePass class

class AttributePass extends AbstractPass AttributePass.php:8

AttributePass::serviceInterface()

public function serviceInterface(): ?string

AttributePass::taggedServiceIds()

public function taggedServiceIds(): ?string

AttributePass::classFqcn()

public function classFqcn(): string

AttributePass::addMethod()

public function addMethod(): string

ContractsPass class

final class ContractsPass implements CompilerPassInterface ContractsPass.php:34

The locator Base\Contract\Runtime reaches the contracts of the Fondation through (plan "omnibase agnostique", C4), handed to it by BaseBundle::boot(): each contract by its interface's name, the service the container binds to that name - omnibase's adapters (Base\Bridge\Symfony\*, config/services/core.php), the framework's clock, event dispatcher and mailer, or an application's own binding, which wins as any alias does.

Only the contracts whose service exists are listed (no clock without symfony/clock, no mailer without symfony/mailer configured): the registry says it has none rather than failing when the service is built. A locator holds closures: nothing is constructed before a contract is asked.

const SERVICE = 'base.contracts'
const CONTRACTS = [Urls::class, Translations::class, Access::class, Locales::class, Files::class, Pictures::class, Texts::class, Tokens::class, ClockInterface::class, EventDis…

ContractsPass::process()

public function process(ContainerBuilder $container): void

DoctrineConfigurationPass class

class DoctrineConfigurationPass implements CompilerPassInterface DoctrineConfigurationPass.php:24

omnibase's Doctrine mapping on DoctrineBundle's entity managers, from the same lists and the same driver an entity manager built by hand gets from Base\Bridge\Doctrine\Mapping (plan "omnibase agnostique", C6):

  • the filters, the DQL functions and the default hint of Base\Bridge\Doctrine\Configuration, on doctrine.orm.configuration;
  • every entity manager's mapping driver wrapped in Base\Bridge\Doctrine\MappingDriver (the discriminator maps generated, the resolveDiscriminator event), given its entity manager lazily.

DoctrineConfigurationPass::process()

public function process(ContainerBuilder $container): void

DoctrineEnumSubscriberPass class

class DoctrineEnumSubscriberPass implements CompilerPassInterface DoctrineEnumSubscriberPass.php:11

DoctrineEnumSubscriberPass::process()

public function process(ContainerBuilder $container): void

EntityExtensionPass class

class EntityExtensionPass extends AbstractPass EntityExtensionPass.php:10

EntityExtensionPass::serviceInterface()

public function serviceInterface(): ?string

EntityExtensionPass::taggedServiceIds()

public function taggedServiceIds(): ?string

EntityExtensionPass::classFqcn()

public function classFqcn(): string

EntityExtensionPass::addMethod()

public function addMethod(): string

GuardPass class

final class GuardPass implements CompilerPassInterface GuardPass.php:15

Base\Service\FormGuard's default captcha is glitchr/omnishield's (omnishield.challenge.gateway) - a parameter that exists only when omnishield's bundle is registered: read here, once every extension has loaded, rather than named in the service's definition. So is glitchr/ux-google's switch, for the sign-in's captcha (SignInGuard).

GuardPass::process()

public function process(ContainerBuilder $container): void

IconProviderPass class

class IconProviderPass extends AbstractPass IconProviderPass.php:8

IconProviderPass::serviceInterface()

public function serviceInterface(): ?string

IconProviderPass::taggedServiceIds()

public function taggedServiceIds(): ?string

IconProviderPass::classFqcn()

public function classFqcn(): string

IconProviderPass::addMethod()

public function addMethod(): string

ObfuscatorCompressionPass class

class ObfuscatorCompressionPass extends AbstractPass ObfuscatorCompressionPass.php:8

ObfuscatorCompressionPass::serviceInterface()

public function serviceInterface(): ?string

ObfuscatorCompressionPass::taggedServiceIds()

public function taggedServiceIds(): string

ObfuscatorCompressionPass::classFqcn()

public function classFqcn(): string

ObfuscatorCompressionPass::addMethod()

public function addMethod(): string

SharingPass class

class SharingPass extends AbstractPass SharingPass.php:8

SharingPass::serviceInterface()

public function serviceInterface(): ?string

SharingPass::taggedServiceIds()

public function taggedServiceIds(): ?string

SharingPass::classFqcn()

public function classFqcn(): string

SharingPass::addMethod()

public function addMethod(): string

TagRendererPass class

class TagRendererPass extends AbstractPass TagRendererPass.php:8

TagRendererPass::serviceInterface()

public function serviceInterface(): ?string

TagRendererPass::taggedServiceIds()

public function taggedServiceIds(): ?string

TagRendererPass::classFqcn()

public function classFqcn(): string

TagRendererPass::addMethod()

public function addMethod(): string

TextOverrideCachePass class

final class TextOverrideCachePass implements CompilerPassInterface TextOverrideCachePass.php:13

The rewritten texts (Base\Translation\OverridingTranslator) are cached in the application's shared Redis pool when it declares one (cache.redis): the web, the worker and cron then agree after an edit. Otherwise cache.app.

TextOverrideCachePass::process()

public function process(ContainerBuilder $container): void

TradingPass class

class TradingPass extends AbstractPass TradingPass.php:8

TradingPass::serviceInterface()

public function serviceInterface(): ?string

TradingPass::taggedServiceIds()

public function taggedServiceIds(): ?string

TradingPass::classFqcn()

public function classFqcn(): string

TradingPass::addMethod()

public function addMethod(): string

TwigComponentPass class

class TwigComponentPass implements CompilerPassInterface TwigComponentPass.php:10

TwigComponentPass::process()

public function process(ContainerBuilder $container): void

WebauthnDeprecatedAliasPass class

class WebauthnDeprecatedAliasPass implements CompilerPassInterface WebauthnDeprecatedAliasPass.php:21

WebauthnExtension (web-auth/webauthn-symfony-bundle 5.3) still aliases the deprecated PublicKeyCredentialSourceRepositoryInterface to the configured credential_repository, next to CredentialRecordRepositoryInterface. Nothing in the bundle or here asks for the deprecated name, but the alias forced PasskeyRepository to keep implementing it (an alias to an interface the class lacks fails lint:container), and implementing it raises a deprecation on every boot.

Dropping the alias lets the repository implement only the current contract. The id is a string on purpose: ::class on a deprecated interface is harmless, but a string keeps this pass from ever needing it autoloaded.

WebauthnDeprecatedAliasPass::process()

public function process(ContainerBuilder $container): void

WorkflowPass class

class WorkflowPass extends AbstractPass WorkflowPass.php:13

WorkflowPass::serviceInterface()

public function serviceInterface(): ?string

WorkflowPass::taggedServiceIds()

public function taggedServiceIds(): ?string

WorkflowPass::classFqcn()

public function classFqcn(): string

WorkflowPass::addMethod()

public function addMethod(): string

WorkflowPass::process()

public function process(ContainerBuilder $container): void

Base\DependencyInjection\Dumper

CliDumper class

class CliDumper extends CliDumper CliDumper.php:8

CliDumper::__construct()

public function __construct($output = null, ?string $charset = null, int $flags = 0)

CliDumper::dumpString()

public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut): void

HtmlDumper class

class HtmlDumper extends HtmlDumper HtmlDumper.php:6

Base\Entity

Thread class

class Thread implements TranslatableInterface, IconizeInterface, GraphInterface, CacheableInterface Thread.php:45

Thread::__toKey()

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

Thread::__iconize()

public function __iconize(): ?array

Thread::__iconizeStatic()

public static function __iconizeStatic(): ?array

Thread::__toString()

public function __toString()

Thread::__construct()

public function __construct(?User $owner = null, ?Thread $parent = null, ?string $title = null, ?string $slug = null)

Thread::getId()

public function getId(): ?int

Thread::getUuid()

public function getUuid()

Thread::getParent()

public function getParent(): ?self

Thread::setParent()

public function setParent(?self $parent): self

Thread::getChildren()

public function getChildren(): Collection

Thread::addChild()

public function addChild(self $child): self

Thread::removeChild()

public function removeChild(self $child): self

Thread::getConnexes()

public function getConnexes(): Collection

Thread::addConnex()

public function addConnex($connex): self

Thread::removeConnex()

public function removeConnex($connex): self

Thread::getSlug()

public function getSlug(): ?string

Thread::setSlug()

public function setSlug(string $slug): self

Thread::getState()

public function getState()

Thread::setState()

public function setState($state): self

Thread::setIsPublished()

public function setIsPublished(bool $newState): self

Thread::isFuture()

public function isFuture(): bool

Thread::isDeleted()

public function isDeleted(): bool

Thread::isScheduled()

public function isScheduled(): bool

Thread::isSecret()

public function isSecret(): bool

Thread::isPublished()

public function isPublished(null|DateTime|string $within = null): bool

Thread::isVisible()

public function isVisible(): bool

An administrator sees every thread; anyone else an approved, published, not secret one. Asked of the Access contract (plan "omnibase agnostique", C3e), not of BaseService: under Symfony the same authorization checker (Base\Bridge\Symfony\SecurityAccess).

It also asked whether the owners contained the token storage's token - a token compared with users, never one of them: never true, so dropped with the token storage, the answers unchanged. Whether an owner should see their own unpublished thread is a decision left for later (plan, C3e).

Thread::isPublishable()

public function isPublishable(): bool

Thread::isApproved()

public function isApproved()

Thread::getWorkflow()

public function getWorkflow()

Thread::setWorkflow()

public function setWorkflow($workflow): self

Thread::getOwner()

public function getOwner(int $i = 0)

Thread::getOwners()

public function getOwners(): Collection

Thread::addOwner()

public function addOwner(?User $owner): self

Thread::removeOwner()

public function removeOwner(?User $owner): self

Thread::getFollowers()

public function getFollowers(): Collection

Thread::addFollower()

public function addFollower(User $follower): self

Thread::removeFollower()

public function removeFollower(User $follower): self

Thread::getPrimaryTag()

public function getPrimaryTag()

Thread::getSecondaryTags()

public function getSecondaryTags(): array

Thread::getTags()

public function getTags(): Collection

Thread::addTag()

public function addTag(Tag $tag): self

Thread::removeTag()

public function removeTag(?Tag $tag): self

Thread::getTaxa()

public function getTaxa(): Collection

Thread::getTaxonomy()

public function getTaxonomy(): Collection

Thread::addTaxon()

public function addTaxon($taxon): self

Thread::removeTaxon()

public function removeTaxon($taxon): self

Thread::getMentions()

public function getMentions(): Collection

Thread::addMention()

public function addMention(Mention $mention): self

Thread::removeMention()

public function removeMention(Mention $mention): self

Thread::getLikes()

public function getLikes(): Collection

Thread::addLike()

public function addLike(Like $like): self

Thread::removeLike()

public function removeLike(?Like $like): self

Thread::isLiked()

public function isLiked(?User $user, ?string $icon = null): bool

Thread::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Thread::getUpdatedAt()

public function getUpdatedAt(): ?DateTimeInterface

Thread::poke()

public function poke(): self

Thread::getPublishedAt()

public function getPublishedAt(): ?DateTimeInterface

Thread::getPublishTime()

public function getPublishTime(): ?int

Thread::getPublishTimeStr()

public function getPublishTimeStr(): ?string

Thread::setPublishedAt()

public function setPublishedAt(?DateTimeInterface $publishedAt): self

Thread::getKeywords()

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

Thread::setKeywords()

public function setKeywords(array $keywords, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

Thread::getHeadline()

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

Thread::setHeadline()

public function setHeadline(?string $headline, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

Thread::getTitle()

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

Thread::setTitle()

public function setTitle(?string $title, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

Thread::getExcerpt()

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

Thread::setExcerpt()

public function setExcerpt(?string $excerpt, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

Thread::getContent()

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

Thread::setContent()

public function setContent(?string $content, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

ThreadIntl class

class ThreadIntl implements TranslationInterface ThreadIntl.php:14

ThreadIntl::getTitle()

public function getTitle(): ?string

ThreadIntl::setTitle()

public function setTitle(?string $title)

ThreadIntl::getHeadline()

public function getHeadline(bool $fallback = false): ?string

ThreadIntl::setHeadline()

public function setHeadline(?string $headline)

ThreadIntl::getKeywords()

public function getKeywords(): array

ThreadIntl::setKeywords()

public function setKeywords(array $keywords)

ThreadIntl::getExcerpt()

public function getExcerpt(): ?string

ThreadIntl::setExcerpt()

public function setExcerpt(?string $excerpt)

ThreadIntl::getContent()

public function getContent(): ?string

ThreadIntl::setContent()

public function setContent(?string $content)

User class

class User implements UserInterface, TwoFactorInterface, EmailTwoFactorInterface, BackupCodeInterface, TrustedDeviceInterface, PasswordAuthenticatedUserInterface, IconizeInterface, AutocompleteInterface User.php:65

public static $userIdentifier = "email"
const TOTP_LENGTH = 6
const TOTP_TIMEOUT = 30
const LEVELS = [0, 100, 250, 500, 1000]

Where that score puts them, as a discrete level.

Thresholds are the lower bound of each level and must stay ascending. A public constant rather than a setting because nothing reads it yet: when levels start gating anything real this wants to move behind base.settings, and one constant is a smaller thing to move than a scattering of inline numbers.

User::__autocomplete()

public function __autocomplete(): string

User::__autocompleteData()

public function __autocompleteData(): array

User::__toString()

public function __toString()

User::nameOf()

public static function nameOf(?self $user): ?string

How a member is named in a record of what they did (revisions, trash): the application's username when it has one, else the display name.

Not getUsername() on the base class: the admin builds URLs from any getUsername() it finds, and only a real column resolves back.

User::__iconize()

public function __iconize(): ?array

User::__iconizeStatic()

public static function __iconizeStatic(): ?array

User::getUserIdentifierField()

public static function getUserIdentifierField(): string

User::getUserIdentifier()

public function getUserIdentifier(): string

User::equals()

public function equals($other): bool

User::__construct()

public function __construct(?string $email = null)
Throws

Exception

User::getRecipient()

public function getRecipient(): Recipient

User::isGranted()

public function isGranted($role): bool

Whether the visitor is granted $role on this user, asked of the Access contract (plan "omnibase agnostique", C3e) where it was BaseService's: under Symfony the same authorization checker, with this user as the subject.

User::killSession()

public function killSession()

User::logout()

public function logout()

User::getId()

public function getId(): ?int

User::setId()

public function setId($id): self

User::getTotpSecret()

public function getTotpSecret()

User::isTotpAuthenticationEnabled()

public function isTotpAuthenticationEnabled(): bool

User::getTotpAuthenticationUsername()

public function getTotpAuthenticationUsername(): string

User::getTotpAuthenticationConfiguration()

public function getTotpAuthenticationConfiguration(): ?TotpConfigurationInterface

User::setTotpSecret()

public function setTotpSecret($secret): self

User::isBackupCode()

public function isBackupCode(string $code): bool

User::invalidateBackupCode()

public function invalidateBackupCode(string $code): void

User::getBackupCodesCount()

public function getBackupCodesCount(): int

User::setBackupCodes()

public function setBackupCodes(array $plainCodes): self

User::isEmailAuthEnabled()

public function isEmailAuthEnabled(): bool

User::setEmailAuthEnabled()

public function setEmailAuthEnabled(bool $emailAuthEnabled): self

User::getEmailAuthRecipient()

public function getEmailAuthRecipient(): string

User::getEmailAuthCode()

public function getEmailAuthCode(): ?string

User::setEmailAuthCode()

public function setEmailAuthCode(string $authCode): void

User::getTrustedTokenVersion()

public function getTrustedTokenVersion(): int

User::invalidateTrustedDevices()

public function invalidateTrustedDevices(): self

Bump this to invalidate every previously-trusted device for this user (e.g. after disabling 2FA).

User::getEmail()

public function getEmail(): ?string

User::setEmail()

public function setEmail(string $email): self

User::getPhone()

public function getPhone(): ?string

User::setPhone()

public function setPhone(?string $phone): self

User::getAvatar()

public function getAvatar()
Throws

Exception

User::getAvatarFile()

public function getAvatarFile()
Throws

FilesystemException

User::setAvatar()

public function setAvatar($avatar)

User::getColor()

public function getColor(): ?string

User::setColor()

public function setColor(?string $color): self

User::getLocale()

public function getLocale(): ?string

User::setLocale()

public function setLocale(?string $locale = null): self

User::getPlainPassword()

public function getPlainPassword(): ?string

User::setPlainPassword()

public function setPlainPassword(?string $password): void

User::__serialize()

public function __serialize(): array

User::erasePlainPassword()

public function erasePlainPassword()

User::eraseCredentials()

public function eraseCredentials(): void

User::getPassword()

public function getPassword(): ?string

User::setPassword()

public function setPassword(string $password): self

User::getIdentityProvider()

public function getIdentityProvider(): ?string

User::setIdentityProvider()

public function setIdentityProvider(?string $identityProvider): self

User::isFederated()

public function isFederated(): bool

User::isPersistent()

public function isPersistent(): bool

User::getRoles()

public function getRoles(): array

Effective roles for security checks: this user's own roles unioned with every group they belong to. Memoized per-instance (busted by setRoles()/addGroup()/removeGroup()) since this is called on every auth check and getGroups() would otherwise trigger a lazy load each time.

User::getOwnRoles()

public function getOwnRoles(): array

Only this user's own roles - what the roles column stores, what edit forms bind to.

User::setRoles()

public function setRoles(array $roles): self

User::setOwnRoles()

public function setOwnRoles(array $roles): self

Alias so form binding on 'ownRoles' has a matching setter - writes only the own column, same as setRoles().

User::getGroups()

public function getGroups(): Collection

User::addGroup()

public function addGroup(Group $group): self

User::removeGroup()

public function removeGroup(Group $group): self

User::getPermissions()

public function getPermissions(): Collection

User::addPermission()

public function addPermission(Permission $permission): self

User::removePermission()

public function removePermission(Permission $permission): self

User::getSanctions()

public function getSanctions(): Collection

User::getActiveSanctions()

public function getActiveSanctions(?DateTimeInterface $at = null): Collection

Only the ones still standing: not lifted, not lapsed.

User::addSanction()

public function addSanction(Sanction $sanction): self

User::removeSanction()

public function removeSanction(Sanction $sanction): self

User::getPenalties()

public function getPenalties(?DateTimeInterface $at = null): array

The catalogue entries behind the sanctions still standing.

Kept under the old name so callers asking "what penalties does this user have" still read naturally, but it now answers with what is in force rather than with everything ever recorded.

User::getScore()

public function getScore(?DateTimeInterface $at = null): int

What this account is worth right now.

The sum of every sanction still in force, plus whatever the groups it belongs to carry. Signed, because the catalogue is: a penalty may cost points and a credit may award them, so one number answers both "is this account in trouble" and "has it earned its way in somewhere".

Group penalties count because membership is the point of a group - a group under sanction puts every member under it, without having to write the same sanction out per head.

Not cached. The obvious cache is per-request, and the obvious bug is a moderator lifting a sanction and the score not moving until the next page load; callers that need it hot should hold it themselves.

User::getLevel()

public function getLevel(?DateTimeInterface $at = null): int

User::getNotifications()

public function getNotifications()

User::addNotification()

public function addNotification(Notification $notification): self

User::removeNotification()

public function removeNotification(Notification $notification): self

User::isTester()

public function isTester()

User::getExpiredTokens()

public function getExpiredTokens(): Collection

User::getValidTokens()

public function getValidTokens(): Collection

User::getTokens()

public function getTokens($type = Token::ALL): Collection

User::removeExpiredTokens()

public function removeExpiredTokens(): self

User::getExpiredToken()

public function getExpiredToken(string $name): ?Token

User::getValidToken()

public function getValidToken(string $name): ?Token

User::getToken()

public function getToken(string $name, $type = Token::ALL): ?Token

User::addToken()

public function addToken(Token $token): self

User::removeTokenByName()

public function removeTokenByName(?string $name): self

User::removeToken()

public function removeToken(Token $token): self

User::getThreads()

public function getThreads(): Collection

User::addThread()

public function addThread(Thread $thread): self

User::removeThread()

public function removeThread(Thread $thread): self

User::isFollowing()

public function isFollowing(Thread $followedThread): bool

User::getFollowedThreads()

public function getFollowedThreads(): Collection

User::addFollowedThread()

public function addFollowedThread(Thread $thread): self

User::removeFollowedThread()

public function removeFollowedThread(Thread $thread): self

User::getMentions()

public function getMentions(): Collection

User::addMentions()

public function addMentions(Mention $mentions): self

User::removeMentions()

public function removeMentions(Mention $mentions): self

User::getLikes()

public function getLikes(): Collection

User::addLike()

public function addLike(Like $like): self

User::removeLike()

public function removeLike(Like $like): self

User::getStates()

public function getStates(): array

User::setStates()

public function setStates(array $states): self

User::newcomer()

public function newcomer(bool $newState = true): self

User::elder()

public function elder(bool $newState = true): self

User::isNewcomer()

public function isNewcomer(): bool

User::isElder()

public function isElder(): bool

User::setIsNewcomer()

public function setIsNewcomer(bool $newState): self

User::approve()

public function approve(bool $newState = true): self

User::disregarded()

public function disregarded(bool $newState = true): self

User::isApproved()

public function isApproved(): bool

User::isDisregarded()

public function isDisregarded(): bool

User::setIsApproved()

public function setIsApproved(bool $newState): self

User::verify()

public function verify(bool $newState = true): self

User::isVerified()

public function isVerified(): bool

User::setIsVerified()

public function setIsVerified(bool $newState)

User::enable()

public function enable(bool $newState = true): self

User::disable()

public function disable(bool $newState = true): self

User::isEnabled()

public function isEnabled(): bool

User::isDisabled()

public function isDisabled(): bool

User::setIsEnabled()

public function setIsEnabled(bool $newState): self

User::lock()

public function lock(bool $newState = true): self

User::unlock()

public function unlock(bool $newState = true): self

User::isLocked()

public function isLocked(): bool

User::setIsLocked()

public function setIsLocked(bool $newState): self

User::ban()

public function ban(bool $newState = true): self

User::unban()

public function unban(bool $newState = true): self

User::isBanned()

public function isBanned(): bool

User::setIsBanned()

public function setIsBanned(bool $newState = true): self

User::kick()

public function kick(bool $newState = true): self

User::unkick()

public function unkick(bool $newState = true): self

User::isKicked()

public function isKicked(): bool

User::setIsKicked()

public function setIsKicked(bool $newState = true): self

User::ghost()

public function ghost(bool $newState = true): self

User::isGhost()

public function isGhost(): bool

User::setIsGhost()

public function setIsGhost(bool $newState): self

User::getBirthdate()

public function getBirthdate(): ?DateTimeInterface

User::setBirthdate()

public function setBirthdate(?DateTimeInterface $birthdate): self

User::getAge()

public function getAge(): ?int

User::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

User::getUpdatedAt()

public function getUpdatedAt(): ?DateTimeInterface

User::getActiveAt()

public function getActiveAt(): ?DateTimeInterface

User::poke()

public function poke(?DateTimeInterface $activeAt): self

User::getActiveDelay()

public static function getActiveDelay(): int

User::isActive()

public function isActive(): bool

User::getOnlineDelay()

public static function getOnlineDelay(): int

User::isOnline()

public function isOnline(): bool

User::getAddresses()

public function getAddresses(): Collection

User::getAddress()

public function getAddress(int $i = 0): ?Address

User::addAddress()

public function addAddress(Address $address): self

User::removeAddress()

public function removeAddress(Address $address): self

User::getConnections()

public function getConnections(): Collection

User::addConnection()

public function addConnection(Connection $connection): self

User::removeConnection()

public function removeConnection(Connection $connection): self

User::getPasskeys()

public function getPasskeys(): Collection

User::addPasskey()

public function addPasskey(Passkey $passkey): self

User::removePasskey()

public function removePasskey(Passkey $passkey): self

Base\EntityDispatcher

AbstractEvent class

abstract class AbstractEvent extends Event implements EventInterface AbstractEvent.php:13

NB: Flushing object manager from within listener should be avoided, this is done already in event dispatcher if needed.

AbstractEvent::__construct()

public function __construct(LifecycleEventArgs $eventArgs, ?Request $request)

AbstractEvent::getLifecycle()

public function getLifecycle(): LifecycleEventArgs

AbstractEvent::getRequest()

public function getRequest(): ?Request

AbstractEvent::getObjectManager()

public function getObjectManager()

AbstractEvent::getObjectClass()

public function getObjectClass(): string

AbstractEvent::getObject()

public function getObject(): object

AbstractEventDispatcher class

abstract class AbstractEventDispatcher implements EventDispatcherInterface, ResetInterface AbstractEventDispatcher.php:19

const DISPATCHER_SUFFIX = "Dispatcher"

AbstractEventDispatcher::__construct()

public function __construct(SymfonyEventDispatcherInterface $dispatcher, EntityHydratorInterface $entityHydrator, EntityManagerInterface $entityManager, RequestStack $requestStack)

AbstractEventDispatcher::getEventClass()

public static function getEventClass()
Throws

Exception

AbstractEventDispatcher::addEvent()

public function addEvent(string $event, mixed $object)

AbstractEventDispatcher::dispatchEvents()

public function dispatchEvents(LifecycleEventArgs $event)

AbstractEventDispatcher::postFlush()

public function postFlush(PostFlushEventArgs $event): void

Nothing is flushed here any more: see $flushPending.

AbstractEventDispatcher::flushPending()

public function flushPending(): void

What the listeners changed, flushed - outside any flush. A flush may raise events again, whose listeners change more: a few rounds at most.

AbstractEventDispatcher::reset()

public function reset(): void

Keyed by spl_object_id, which PHP gives again to a new object once the old one is gone: in a worker, a message's entity inherited the events (or the "already sent" mark) of an earlier one's.

AbstractEventDispatcher::getEntityManager()

public function getEntityManager()

AbstractEventDispatcher::getAssociationChangeSet()

public function getAssociationChangeSet($entity): array

AbstractEventDispatcher::getAssociationDeleteDiff()

public function getAssociationDeleteDiff($entity, $field): array

AbstractEventDispatcher::getAssociationInsertDiff()

public function getAssociationInsertDiff($entity, $field): array

AbstractEventDispatcher::prePersist()

public function prePersist(LifecycleEventArgs $event)

AbstractEventDispatcher::preUpdate()

public function preUpdate(LifecycleEventArgs $event)

AbstractEventDispatcher::preRemove()

public function preRemove(LifecycleEventArgs $event)

AbstractEventDispatcher::postPersist()

public function postPersist(LifecycleEventArgs $event)

AbstractEventDispatcher::postUpdate()

public function postUpdate(LifecycleEventArgs $event)

AbstractEventDispatcher::postRemove()

public function postRemove(LifecycleEventArgs $event)

AbstractEventDispatcher::onPersist()

public function onPersist(LifecycleEventArgs $event)

AbstractEventDispatcher::onUpdate()

public function onUpdate(LifecycleEventArgs $event)

AbstractEventDispatcher::onRemove()

public function onRemove(LifecycleEventArgs $event)

EventDispatcherInterface interface

interface EventDispatcherInterface EventDispatcherInterface.php:10

EventDispatcherInterface::supports()

public function supports(mixed $subject): bool

EventDispatcherInterface::addEvent()

public function addEvent(string $event, mixed $subject)

EventDispatcherInterface::dispatchEvents()

public function dispatchEvents(LifecycleEventArgs $event)

EventDispatcherInterface::onPersist()

public function onPersist(LifecycleEventArgs $event)

EventDispatcherInterface::onUpdate()

public function onUpdate(LifecycleEventArgs $event)

EventDispatcherInterface::onRemove()

public function onRemove(LifecycleEventArgs $event)

EventInterface interface

interface EventInterface EventInterface.php:7

EventInterface::getObjectManager()

public function getObjectManager()

EventInterface::getObjectClass()

public function getObjectClass(): string

EventInterface::getObject()

public function getObject(): object

Base\EntityDispatcher\Event

ThreadEvent class

class ThreadEvent extends AbstractEvent ThreadEvent.php:8

const SCHEDULED = 'thread.scheduled'
const PUBLISHABLE = 'thread.publishable'
const PUBLISHED = 'thread.published'

ThreadEvent::getThread()

public function getThread(): Thread

ThreadEventDispatcher class

class ThreadEventDispatcher extends AbstractEventDispatcher ThreadEventDispatcher.php:10

ThreadEventDispatcher::supports()

public function supports(mixed $subject): bool

ThreadEventDispatcher::onPersist()

public function onPersist(LifecycleEventArgs $event)

ThreadEventDispatcher::onUpdate()

public function onUpdate(LifecycleEventArgs $event)

UserEvent class

class UserEvent extends AbstractEvent UserEvent.php:12

The order.placed event is dispatched each time an order is created in the system.

const REGISTER = 'user.register'
const VERIFIED = 'user.verified'
const APPROVAL = 'user.approval'
const DISABLED = 'user.disabled'
const ENABLED = 'user.enabled'
const KICKED = 'user.kickout'
const LOCKED = 'user.locked'
const NEWCOMER = 'user.newcomer'
const GHOST = 'user.ghost'
const BANNED = 'user.banned'

UserEvent::getUser()

public function getUser(): User

UserEventDispatcher class

class UserEventDispatcher extends AbstractEventDispatcher UserEventDispatcher.php:9

UserEventDispatcher::supports()

public function supports(mixed $subject): bool

UserEventDispatcher::onPersist()

public function onPersist(LifecycleEventArgs $event)

UserEventDispatcher::onUpdate()

public function onUpdate(LifecycleEventArgs $event)

Base\EntitySubscriber

ConnectionSubscriber class

class ConnectionSubscriber implements EventSubscriberInterface ConnectionSubscriber.php:18

ConnectionSubscriber::__construct()

public function __construct(UserTracker $userTracker, EntityManagerInterface $entityManager)

ConnectionSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

ConnectionSubscriber::onCheckPassport()

public function onCheckPassport(CheckPassportEvent $event)

ConnectionSubscriber::onLoginFailure()

public function onLoginFailure(LoginFailureEvent $event)

ConnectionSubscriber::onLoginSuccess()

public function onLoginSuccess(LoginSuccessEvent $event)

ConnectionSubscriber::onLogout()

public function onLogout(LogoutEvent $event)

ExtensionSubscriber class

class ExtensionSubscriber HookExtensionSubscriber.php:16

ExtensionSubscriber::__construct()

public function __construct(EntityManagerInterface $entityManager, EntityExtension $entityExtension)

ExtensionSubscriber::loadClassMetadata()

public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)

ExtensionSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $event)

ExtensionSubscriber::postPersist()

public function postPersist(EventArgs $args)

ExtensionSubscriber::payload()

public function payload(string $action, array $entities)
Throws

Exception

SettingSubscriber class

class SettingSubscriber SettingSubscriber.php:20

Invalidates SettingBag's compiled snapshot on any Setting/SettingIntl write, not just ones that went through SettingBag::set(). The admin CRUD (EasyAdmin's SettingCrudController / LayoutSettingListType) persists these entities via a plain flush() and never called SettingBag::set() at all, so without this listener an admin edit (e.g. the site logo) would keep serving the stale cached value until the next unrelated cache:clear.

SettingSubscriber::__construct()

public function __construct(protected \Closure $settingBag)

Lazy closure (service_closure in DI config), NOT the SettingBag itself: Doctrine instantiates event listeners during event-manager initialization, and constructing SettingBag there drags in SettingRepository -> getClassMetadata() -> a re-entrant resolveDiscriminator dispatch that corrupts the event manager's partially-initialized listener state. The closure defers all of that to the first actual Setting write.

SettingSubscriber::postPersist()

public function postPersist(PostPersistEventArgs $args): void

SettingSubscriber::postUpdate()

public function postUpdate(PostUpdateEventArgs $args): void

SettingSubscriber::postRemove()

public function postRemove(PostRemoveEventArgs $args): void

ThreadSubscriber class

class ThreadSubscriber implements EventSubscriberInterface ThreadSubscriber.php:18

ThreadSubscriber::__construct()

public function __construct(MentionEnhancerInterface $mentionEnhancer)

ThreadSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

ThreadSubscriber::onSchedule()

public function onSchedule(ThreadEvent $event)

ThreadSubscriber::onPublishable()

public function onPublishable(ThreadEvent $event)

ThreadSubscriber::prePersist()

public function prePersist(PrePersistEventArgs $event)

ThreadSubscriber::preUpdate()

public function preUpdate(PreUpdateEventArgs $event)

ThreadSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $event)

TrasheableSubscriber class

class TrasheableSubscriber TrasheableSubscriber.php:59

Turns $em->remove() into a soft delete for every entity carrying #[Trasheable] - Thread and, through it, articles, galleries, comments, guestbook messages, calendars and newsletters.

## How the DELETE is cancelled

preRemove cannot veto anything, so the interception happens at onFlush, after computeChangeSets has scheduled everything but before any SQL runs:

  • the deletion field is stamped,
  • persist() on an entity in STATE_REMOVED puts it back to STATE_MANAGED and drops it from the deletion queue - that is what cancels the DELETE,
  • scheduleExtraUpdate then emits the UPDATE that writes the stamp.

## Why the cascade has to be rescued

Thread::$translations is mapped cascade: [persist, refresh, remove], so by the time we get here Doctrine has already queued every ThreadIntl row for deletion. Cancelling only the parent would trash an article and destroy its title, headline, excerpt and content on the way in - restoring would hand back an empty shell. So every entity the removal cascaded to is rescued with it, recursively.

## Hard deletion

An entity whose deletion field is ALREADY stamped is left alone and deleted for real. That is deliberate and is the only escape hatch: emptying the trash, and the "delete permanently" action, both work by removing an already-trashed entity.

## Why the second-level cache has to be evicted

Thread is #[Cache(usage: "NONSTRICT_READ_WRITE")], and the L2 entity region is keyed by id alone - Doctrine folds the filter hash into query and collection keys, but not into that one. A copy cached before the trashing therefore still says deletedAt = null, which broke both directions: find() kept handing out entities the filter had hidden, and a later remove() read that stale null and soft-deleted an already-trashed entity instead of purging it. Evicting on the way out puts the next read back on the database, where the filter applies.

TrasheableSubscriber::__construct()

public function __construct(string|int $emptyTrash = "+7 days")
$emptyTrash

base.extension.empty_trash: a relative date ("+7 days"), or a number of days

TrasheableSubscriber::expiry()

public static function expiry(string|int|null $value, string $default = "+7 days"): string

An expiry as new DateTime() reads it: a bare number of days ("5", 5) becomes "+5 days", anything else is kept (a relative date, "+1 month").

The configuration's default was 5 once, and new DateTime("5") throws.

TrasheableSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $event): void

TrasheableSubscriber::postFlush()

public function postFlush(PostFlushEventArgs $event): void

UserSubscriber class

class UserSubscriber implements EventSubscriberInterface UserSubscriber.php:17

UserSubscriber::__construct()

public function __construct(NotifierInterface $notifier, TokenStorageInterface $tokenStorage, AdvancedRouterInterface $router)

UserSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

UserSubscriber::onEnabling()

public function onEnabling(UserEvent $event)

UserSubscriber::onDisabling()

public function onDisabling(UserEvent $event)

UserSubscriber::onKickout()

public function onKickout(UserEvent $event)

UserSubscriber::onVerification()

public function onVerification(UserEvent $event)

UserSubscriber::onRegistration()

public function onRegistration(UserEvent $event)

UserSubscriber::onApproval()

public function onApproval(UserEvent $event)

VersionableSubscriber class

class VersionableSubscriber VersionableSubscriber.php:47

Records what changed, for every property carrying #[Versionable].

One Revision per entity per flush, not one per field: a save that retitles an article and moves it out of draft is one editorial act and reads as one line of history. entityData is the diff, {"<field>": [old, new]}.

## Translations are folded into their parent

Everything an editor actually types - title, headline, excerpt, content, keywords - lives on ThreadIntl, one row per locale, not on Thread. Left alone, an article's history would be scattered across itself plus N translation rows, none of which the admin has a page for.

So a revision of a TranslationInterface entity is attributed to its translatable parent and its keys are prefixed with the locale:

{"slug": [...], "fr.content": [...], "en.title": [...]}

which is also the shape the per-field history badge reads, since the form renders translated fields under their locale too.

## Value normalisation

entityData is a JSON column, so entities and collections are reduced to ids (plus a label kept only for display - restoring reads the ids). Dates go to ATOM. Nothing else survives: an un-normalisable value is dropped from the diff rather than allowed to break the flush.

VersionableSubscriber::__construct()

public function __construct(protected EntityManagerInterface $entityManager, protected int $maxRevisions = 5)

VersionableSubscriber::onFlush()

public function onFlush(OnFlushEventArgs $event): void

VersionableSubscriber::postFlush()

public function postFlush(PostFlushEventArgs $event): void

Keep only the newest max_revisions per entity. Done after the flush so the revision this flush just wrote is counted, and issued as DQL so a long history is not hydrated to be thrown away.

Base\Entity\Analytics

PageView class

class PageView PageView.php:27

One row per (path, HOUR, source) - an hourly rolling aggregate, not a per-request event log. $views is incremented atomically (see PageViewRepository, which buckets any timestamp down to the top of its hour before writing) on every trackable request; time windows ("24h", "7 days", "all time") are just a SUM over however many of these rows fall in range, and a calendar-day figure (dailyBreakdown()) is itself a SUM over that day's up-to-24 hourly rows rather than its own storage grain - this is what lets "today" plot an hour-by-hour curve instead of the single flat point a pure daily rollup could ever produce.

$source splits that aggregate three ways (see Base\Service\Analytics\ UserAgentClassifier, which is what decides it at track() time) so a dashboard can tell real visitors apart from search/monitoring crawlers (SOURCE_BOT) and AI/LLM crawlers (SOURCE_AI) instead of one number that silently mixes all three. Rows written before this column existed (or by a raw INSERT that omits it, as the test suite's seed data does) default to SOURCE_HUMAN - the historic assumption this table always made.

const SOURCE_HUMAN = "human"
const SOURCE_BOT = "bot"
const SOURCE_AI = "ai"

PageView::getId()

public function getId(): ?int

PageView::getPath()

public function getPath(): ?string

PageView::setPath()

public function setPath(string $path): self

PageView::getDate()

public function getDate(): ?\DateTimeImmutable

PageView::setDate()

public function setDate(\DateTimeImmutable $date): self

PageView::getViews()

public function getViews(): int

PageView::setViews()

public function setViews(int $views): self

PageView::getSource()

public function getSource(): string

PageView::setSource()

public function setSource(string $source): self

PageVisit class

class PageVisit PageVisit.php:22

An HOURLY PRESENCE record per page: at most one row per (hour, path, subjectType, subjectId), inserted on first sight and ignored afterwards - the same mechanism as Visit, with the path added.

It exists because neither existing table can answer "unique views". PageView is a raw hit counter per (path, hour, source), so reloading a page ten times is ten views; Visit knows who came but not what they looked at, and nothing links the two. A unique view is one subject on one page, which is exactly the row this table keeps. PageView stays the non-unique count.

Human traffic only, and only for an identified subject: a consented visitor cookie or an authenticated user - see Analytics::track().

PageVisit::getId()

public function getId(): ?int

PageVisit::getDate()

public function getDate(): ?\DateTimeImmutable

PageVisit::setDate()

public function setDate(\DateTimeImmutable $date): self

PageVisit::getPath()

public function getPath(): ?string

PageVisit::setPath()

public function setPath(string $path): self

PageVisit::getSubjectType()

public function getSubjectType(): ?string

PageVisit::setSubjectType()

public function setSubjectType(string $subjectType): self

PageVisit::getSubjectId()

public function getSubjectId(): ?string

PageVisit::setSubjectId()

public function setSubjectId(string $subjectId): self

Visit class

class Visit Visit.php:29

An HOURLY PRESENCE record, not a per-request event log: at most one row per (hour, subjectType, subjectId) - see VisitRepository, which buckets any timestamp down to the top of its hour before writing - inserted on first sight that hour and ignored on every later request the same hour.

COUNT(DISTINCT subjectId) still gives an exact unique count over any window regardless of grain (a subject seen in two different hours of the same day contributes two rows but ONE distinct id, so a day/week/all-time total is never inflated); the finer grain only changes what an hour-by- hour BREAKDOWN can show (a subject active at 9am and 2pm now shows up in both hourly buckets, same as it already showed up on multiple separate DAYS in a multi-day breakdown before this). Unlike PageView (a raw hit counter), a returning subject never inflates this table twice in the same hour, and the table stays bounded by (subjects x hours), not raw traffic.

subjectType is "visitor" (an anonymous, cookie-identified browser - see Base\Service\Analytics for the consent-gating this depends on) or "user" (an authenticated Base\Entity\User's id) - two independent counters sharing one mechanism rather than two parallel tables.

const TYPE_VISITOR = "visitor"
const TYPE_USER = "user"

Visit::getId()

public function getId(): ?int

Visit::getDate()

public function getDate(): ?\DateTimeImmutable

Visit::setDate()

public function setDate(\DateTimeImmutable $date): self

Visit::getSubjectType()

public function getSubjectType(): ?string

Visit::setSubjectType()

public function setSubjectType(string $subjectType): self

Visit::getSubjectId()

public function getSubjectId(): ?string

Visit::setSubjectId()

public function setSubjectId(string $subjectId): self

Base\Entity\Extension

Revision class

class Revision extends AbstractExtension Revision.php:25

One entry of an entity's modification history: what changed in a single flush, as entityData = {"<field>": [old, new]}.

NB the hash used to be #[ORM\Column(type:"integer")] #[Hashify(random:true)], which could not work in either direction: Hashify hands prePersist a hashed STRING for an integer column, and its postPersist calls erasePlainMessage(), which throws outright when no reference column is configured - so the very first Revision ever persisted would have taken the flush down with it. It went unnoticed because nothing ever wrote one. getHashShort() shows the intent was a git-style short hash, so that is what it now is.

Revision::__iconizeStatic()

public static function __iconizeStatic(): ?array

Revision::__construct()

public function __construct()

Revision::getHash()

public function getHash()

Revision::getHashShort()

public function getHashShort()

Revision::getFields()

public function getFields(): array

Field names this revision touched, with the locale prefix stripped off.

Revision::getPreviousValue()

public function getPreviousValue(string $field): mixed

The value $field held BEFORE this revision - what a restore puts back.

Revision::getNextValue()

public function getNextValue(string $field): mixed

Revision::supports()

public function supports(): bool

TrashBall class

class TrashBall extends AbstractExtension TrashBall.php:13

TrashBall::__iconizeStatic()

public static function __iconizeStatic(): ?array

TrashBall::getPermanentAfter()

public function getPermanentAfter(): ?DateTimeInterface

TrashBall::setPermanentAfter()

public function setPermanentAfter(DateTimeInterface $permanentAfter): self

TrashBall::supports()

public function supports(): bool

Base\Entity\Extension\Abstract

AbstractExtension class

abstract class AbstractExtension implements AbstractExtensionInterface, IconizeInterface AbstractExtension.php:16

AbstractExtension::__iconize()

public function __iconize(): ?array

AbstractExtension::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractExtension::getId()

public function getId()

AbstractExtension::getImpersonator()

public function getImpersonator(): ?User

AbstractExtension::getInitiator()

public function getInitiator(): ?User

AbstractExtension::getEntityId()

public function getEntityId()

AbstractExtension::setEntityId()

public function setEntityId(mixed $entityOrId)

AbstractExtension::getEntityClass()

public function getEntityClass()

AbstractExtension::setEntityClass()

public function setEntityClass(object|string $entity)

AbstractExtension::getAction()

public function getAction()

AbstractExtension::setAction()

public function setAction(string $action)

AbstractExtension::isEmpty()

public function isEmpty()

AbstractExtension::getEntityData()

public function getEntityData(): array

AbstractExtension::setEntityData()

public function setEntityData(array $entityData)

AbstractExtension::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

AbstractExtension::setCreatedAt()

public function setCreatedAt(DateTimeInterface $createdAt): self

AbstractExtensionInterface interface

interface AbstractExtensionInterface extends EntityMetadataInterface AbstractExtensionInterface.php:7

Base\Entity\Hours

ScopedWeek class

class ScopedWeek ScopedWeek.php:18

The usual week of one place, when a site has several: a shop among the shops, a practice among the practices. The place is a scope key - any string its owner chooses ("store:12"), or an entity (Base\Service\OpeningHours::scopeOf()).

The site's own week stays where it was (WeekDayHours, one row per day, else base.opening_hours.week): a place without a row here follows it. One row per place, the seven days together: {"1": [["09:00","13:00"]], ...}.

ScopedWeek::__construct()

public function __construct(string $scope, array $week = [])

ScopedWeek::getId()

public function getId(): ?int

ScopedWeek::getScope()

public function getScope(): string

ScopedWeek::getWeek()

public function getWeek(): array
Returns

all seven days

ScopedWeek::setWeek()

public function setWeek(array $week): static
$week

ISO day => hours, in order, closing after opening

SpecialDay class

class SpecialDay SpecialDay.php:19

A day (or a run of days) off the usual week: closed (holidays, a bank holiday), or open at other hours ([["10:00","14:00"]]). Read by Base\Service\OpeningHours everywhere (the day an order is for, the time slots, the footer, a banner, the JSON-LD's specialOpeningHoursSpecification).

Without a scope it is the whole site's; with one, that place's only (ScopedWeek: "store:12"), where it wins over the site's on the same date.

Its own table (hoursSpecialDay), see WeekDayHours.

SpecialDay::__construct()

public function __construct(\DateTimeInterface $from, ?\DateTimeInterface $until = null, ?string $reason = null, ?string $scope = null)

SpecialDay::getId()

public function getId(): ?int

SpecialDay::getStartsOn()

public function getStartsOn(): string

SpecialDay::getEndsOn()

public function getEndsOn(): string

SpecialDay::getReason()

public function getReason(): ?string

SpecialDay::setReason()

public function setReason(?string $reason): static

SpecialDay::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

SpecialDay::getScope()

public function getScope(): ?string

SpecialDay::getHours()

public function getHours(): ?array

SpecialDay::setHours()

public function setHours(?array $hours): static

SpecialDay::isClosed()

public function isClosed(): bool

SpecialDay::covers()

public function covers(\DateTimeInterface $day): bool

SpecialDay::isOneDay()

public function isOneDay(): bool

SpecialDay::from()

public function from(): \DateTimeImmutable

SpecialDay::until()

public function until(): \DateTimeImmutable

WeekDayHours class

class WeekDayHours WeekDayHours.php:18

The usual hours of one day of the week: [["09:00","13:00"],["16:30","19:00"]], or none (closed). No row at all: the week the site was configured with (base.opening_hours.week), read by Base\Service\OpeningHours. Special days (SpecialDay) override a date.

Its own table (hoursWeekDay): an application that still keeps a copy of its own (Nakaya's weekDayHours) is not disturbed; moving onto this one is a RENAME TABLE.

WeekDayHours::__construct()

public function __construct(int $weekday, array $hours = [])

WeekDayHours::getWeekday()

public function getWeekday(): int

WeekDayHours::getId()

public function getId(): int

omnibase's listeners ask every entity for one.

WeekDayHours::getHours()

public function getHours(): array

WeekDayHours::setHours()

public function setHours(array $hours): static
$hours

in order, closing after opening

Base\Entity\Layout

Attribute class

abstract class Attribute extends AbstractAttribute implements TranslatableInterface Attribute.php:15

Attribute::__construct()

public function __construct(AbstractAdapter $adapter, mixed $value = null)

Attribute::__toString()

public function __toString()

Attribute::get()

public function get(?string $locale = null): mixed

Attribute::set()

public function set(...$args): self

Attribute::resolve()

public function resolve(?string $locale = null): mixed

AttributeIntl class

class AttributeIntl implements TranslationInterface AttributeIntl.php:16

AttributeIntl::isEmpty()

public function isEmpty(): bool

AttributeIntl::getValue()

public function getValue()
Throws

Exception

AttributeIntl::getValueFile()

public function getValueFile()
Throws

FilesystemException

AttributeIntl::setValue()

public function setValue($value)

AttributeIntl::getClass()

public function getClass(): ?string

AttributeIntl::setClass()

public function setClass(?string $class)

Image class

class Image implements IconizeInterface, ImageInterface, SaltInterface Image.php:26

Image::getSalt()

public function getSalt(): string

Image::__toLink()

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

Image::__iconize()

public function __iconize(): ?array

Image::__iconizeStatic()

public static function __iconizeStatic(): ?array

Image::__toString()

public function __toString()

Image::__construct()

public function __construct($src = null)

Image::getId()

public function getId(): ?int

Image::getSource()

public function getSource()
Throws

Exception

Image::getSourceFile()

public function getSourceFile()
Throws

FilesystemException

Image::setSource()

public function setSource($source): static

Image::getNaturalWidth()

public function getNaturalWidth(): ?int

Image::getNaturalHeight()

public function getNaturalHeight(): ?int

Image::getSourceMeta()

public function getSourceMeta(): array|null|false

Image::get()

public function get()

Image::getFile()

public function getFile()

Image::set()

public function set($source): self

Image::getQuadrant()

public function getQuadrant(): string

Image::getQuadrantPosition()

public function getQuadrantPosition(): string

Image::setQuadrant()

public function setQuadrant(string $quadrant): self

Image::getCrops()

public function getCrops(): Collection

Image::getCrop()

public function getCrop(string $identifier): ?ImageCrop

Image::addCrop()

public function addCrop(ImageCrop $crop): self

Image::removeCrop()

public function removeCrop(ImageCrop $crop): self

ImageCrop class

class ImageCrop implements LinkableInterface, SaltInterface ImageCrop.php:15

ImageCrop::getSalt()

public function getSalt(): string

ImageCrop::__toLink()

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

ImageCrop::__toString()

public function __toString()

ImageCrop::getRatio()

public function getRatio()

ImageCrop::isNormalized()

public function isNormalized()

ImageCrop::getId()

public function getId(): ?int

ImageCrop::getImage()

public function getImage(): ?Image

ImageCrop::setImage()

public function setImage(?Image $image): self

ImageCrop::getLabel()

public function getLabel(): ?string

ImageCrop::setLabel()

public function setLabel(?string $label): self

ImageCrop::getSlug()

public function getSlug(): ?string

ImageCrop::setSlug()

public function setSlug(?string $slug): self

ImageCrop::__construct()

public function __construct(?Image $image = null)

ImageCrop::getData()

public function getData(): array

ImageCrop::getX()

public function getX(?int $width = null): ?int

ImageCrop::getX0()

public function getX0(): ?float

ImageCrop::setX0()

public function setX0(float $x0): self

ImageCrop::getY()

public function getY(?int $height = null): ?int

ImageCrop::getY0()

public function getY0(): ?float

ImageCrop::setY0()

public function setY0(float $y0): self

ImageCrop::getPivotX()

public function getPivotX(?int $width = null)

ImageCrop::getXp()

public function getXp(): ?float

ImageCrop::setXp()

public function setXp(float $xP): self

ImageCrop::getPivotY()

public function getPivotY(?int $height = null)

ImageCrop::getYp()

public function getYp(): ?float

ImageCrop::setYp()

public function setYp(float $yP): self

ImageCrop::getNaturalWidth()

public function getNaturalWidth(): ?int

ImageCrop::getWidth()

public function getWidth(?int $width = null): ?int

ImageCrop::getWidth0()

public function getWidth0(): ?float

ImageCrop::setWidth0()

public function setWidth0(float $width0): self

ImageCrop::getNaturalHeight()

public function getNaturalHeight(): ?int

ImageCrop::getHeight()

public function getHeight(?int $height = null): ?int

ImageCrop::getHeight0()

public function getHeight0(): ?float

ImageCrop::setHeight0()

public function setHeight0(float $height0): self

ImageCrop::getScaleX()

public function getScaleX(): ?float

ImageCrop::setScaleX()

public function setScaleX(float $scaleX): self

ImageCrop::getScaleY()

public function getScaleY(): ?float

ImageCrop::setScaleY()

public function setScaleY(float $scaleY): self

ImageCrop::getRotate()

public function getRotate(): ?int

ImageCrop::setRotate()

public function setRotate(int $rotate): self

ImageCropInterface interface

interface ImageCropInterface ImageCropInterface.php:5

ImageCropInterface::getPivotX()

public function getPivotX()

ImageCropInterface::getPivotY()

public function getPivotY()

ImageCropInterface::getX()

public function getX(): ?int

ImageCropInterface::setX()

public function setX(int $x): self

ImageCropInterface::getY()

public function getY(): ?int

ImageCropInterface::setY()

public function setY(int $y): self

ImageCropInterface::getWidth()

public function getWidth(): ?int

ImageCropInterface::setWidth()

public function setWidth(int $width): self

ImageCropInterface::getHeight()

public function getHeight(): ?int

ImageCropInterface::setHeight()

public function setHeight(int $height): self

ImageCropInterface::getScaleX()

public function getScaleX(): ?float

ImageCropInterface::setScaleX()

public function setScaleX(float $scaleX): self

ImageCropInterface::getScaleY()

public function getScaleY(): ?float

ImageCropInterface::setScaleY()

public function setScaleY(float $scaleY): self

ImageCropInterface::getRotate()

public function getRotate(): ?int

ImageCropInterface::setRotate()

public function setRotate(int $rotate)

ImageInterface interface

interface ImageInterface ImageInterface.php:5

ImageInterface::getSource()

public function getSource()

ImageInterface::getSourceFile()

public function getSourceFile()

ImageInterface::setSource()

public function setSource($source): static

ImageInterface::getNaturalWidth()

public function getNaturalWidth(): ?int

ImageInterface::getNaturalHeight()

public function getNaturalHeight(): ?int

Redirection class

class Redirection Redirection.php:26

An address the site no longer answers, and where it leads now: the pages of a site taken over (/produit/enseigne-lumineuse/ -> /savoir-faire/enseigne), a page renamed. Asked only when a request ends in "not found" (Base\Subscriber\RedirectionSubscriber): a page that exists is never shadowed, and a page that is found costs nothing.

The source is a path, kept without its trailing slash ("/produit/enseigne"); with a query string ("/?p=123") it is matched with that query. Ending in "*" it covers everything beneath ("/categorie-produit/*"), and a "*" in the target then carries what the star stood for.

301 by default: the old address is gone for good, and search engines move what they know of it to the new one. 302 for a detour that will not last.

const PERMANENT = 301
const TEMPORARY = 302
const STATUSES = [self::PERMANENT, self::TEMPORARY]

Redirection::__construct()

public function __construct(string $source = '', string $target = '', int $status = self::PERMANENT)

Redirection::__toString()

public function __toString(): string

Redirection::normalize()

public static function normalize(string $address): string

An address as it is stored and compared: its path, without the site's host, without its trailing slash, with its query when it has one.

"https://old.example/produit/enseigne/?x=1#top" is "/produit/enseigne?x=1".

Redirection::getId()

public function getId(): ?int

Redirection::getSource()

public function getSource(): string

Redirection::setSource()

public function setSource(string $source): static

Redirection::isPrefix()

public function isPrefix(): bool

Covers everything beneath its path ("/categorie-produit/*").

Redirection::getTarget()

public function getTarget(): string

Redirection::setTarget()

public function setTarget(string $target): static

A path of the site ("/savoir-faire/enseigne") or a whole address ("https://...").

Redirection::getStatus()

public function getStatus(): int

Redirection::setStatus()

public function setStatus(int $status): static

Redirection::isEnabled()

public function isEnabled(): bool

Redirection::setEnabled()

public function setEnabled(bool $enabled): static

Redirection::getHits()

public function getHits(): int

Redirection::getLastHitAt()

public function getLastHitAt(): ?\DateTimeImmutable

Redirection::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Redirection::resolve()

public function resolve(string $address): ?string

Where this redirection sends $address (normalized), or null when it is not for it. A prefix carries what its star stood for into the target's.

Semantic class

class Semantic implements TranslatableInterface, IconizeInterface Semantic.php:19

Semantic::__iconize()

public function __iconize(): ?array

Semantic::__iconizeStatic()

public static function __iconizeStatic(): ?array

Semantic::__toLink()

public function __toLink(int $referenceType = Link::ABSOLUTE_PATH): ?string

Semantic::__construct()

public function __construct(?string $routeName, array $routeParameters = [], ?string $label = null)

Semantic::getId()

public function getId(): ?int

Semantic::getRouteName()

public function getRouteName(): ?string

Semantic::setRouteName()

public function setRouteName(?string $routeName): self

Semantic::getRouteParameters()

public function getRouteParameters(): ?array

Semantic::setRouteParameters()

public function setRouteParameters(?array $routeParameters): self

Semantic::getPath()

public function getPath()

Semantic::getRoute()

public function getRoute(): ?string

Semantic::getRouteIcons()

public function getRouteIcons()

Semantic::getUrl()

public function getUrl(): ?string

Semantic::enhance()

public function enhance(string $text, array $attributes = [])

Semantic::enhanceBy()

public function enhanceBy(string $text, array|string $keywords, array $attributes)

SemanticIntl class

class SemanticIntl implements TranslationInterface SemanticIntl.php:12

SemanticIntl::getLabel()

public function getLabel(): ?string

SemanticIntl::setLabel()

public function setLabel(?string $label)

SemanticIntl::getKeywords()

public function getKeywords(): array

SemanticIntl::setKeywords()

public function setKeywords(array $keywords)

Setting class

class Setting implements TranslatableInterface, IconizeInterface Setting.php:15

Setting::__iconize()

public function __iconize(): ?array

Setting::__iconizeStatic()

public static function __iconizeStatic(): ?array

Setting::__toString()

public function __toString()

Setting::__construct()

public function __construct(string $path, $value = null, $locale = null)
Throws

Exception

Setting::getId()

public function getId(): ?int

Setting::getPath()

public function getPath(): string

Setting::setPath()

public function setPath(string $path)

Setting::isLocked()

public function isLocked(): bool

Setting::getLocked()

public function getLocked(): bool

Setting::lock()

public function lock(): self

Setting::unlock()

public function unlock(): self

Setting::setLocked()

public function setLocked(bool $locked)

Setting::getBag()

public function getBag(): ?string

Setting::setBag()

public function setBag(?string $bag)

SettingIntl class

class SettingIntl implements TranslationInterface SettingIntl.php:16

SettingIntl::isEmpty()

public function isEmpty(): bool

SettingIntl::getLabel()

public function getLabel(): ?string

SettingIntl::setLabel()

public function setLabel(?string $label)

SettingIntl::getHelp()

public function getHelp(): ?string

SettingIntl::setHelp()

public function setHelp(?string $help)

SettingIntl::getValue()

public function getValue()
Throws

Exception

SettingIntl::getValueRaw()

public function getValueRaw()

Raw stored value (e.g. the upload uuid for file-backed settings), without the Uploader public-URL resolution applied by getValue().

Used by SettingBag's compiled snapshot so cached settings stay independent of the active media storage — the URL is derived at read time instead of being baked in at compile time.

SettingIntl::getValueFile()

public function getValueFile()
Throws

FilesystemException

SettingIntl::setValue()

public function setValue($value)

SettingIntl::getClass()

public function getClass(): ?string

SettingIntl::setClass()

public function setClass(?string $class)

class ShortLink implements TranslatableInterface, IconizeInterface, LinkableInterface ShortLink.php:19

ShortLink::__iconize()

public function __iconize(): ?array

ShortLink::__iconizeStatic()

public static function __iconizeStatic(): ?array

ShortLink::__toLink()

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

The short address, through the Urls contract (Base\Contract\Link): the router's own string under Symfony, made where there is no framework too.

ShortLink::__toString()

public function __toString()

ShortLink::__construct()

public function __construct(string $url = "", ?string $label = null)
public function getId(): ?int
public function getSlug(): ?string
public function setSlug(?string $slug)

ShortLinkIntl class

class ShortLinkIntl implements TranslationInterface ShortLinkIntl.php:12

ShortLinkIntl::getLabel()

public function getLabel(): ?string

ShortLinkIntl::setLabel()

public function setLabel(?string $label)

ShortLinkIntl::getUrl()

public function getUrl(): ?string

ShortLinkIntl::setUrl()

public function setUrl(string $url)

TextOverride class

class TextOverride TextOverride.php:19

A text of the site, as the team rewrote it from the back office: it replaces the one in translations/ for that key, domain and language (Base\Translation\OverridingTranslator), on every page and in every e-mail. Deleting it brings the original back. Same syntax as the original: {placeholders}, ICU plurals. Moved here from the apps' App\Entity\TextOverride (table textOverride there; this one is layoutTextOverride, so an app not moved yet keeps its own).

TextOverride::__construct()

public function __construct()

TextOverride::__toString()

public function __toString(): string

TextOverride::getId()

public function getId(): ?int

TextOverride::getDomain()

public function getDomain(): string

TextOverride::setDomain()

public function setDomain(string $domain): static

TextOverride::getKey()

public function getKey(): string

TextOverride::setKey()

public function setKey(string $key): static

TextOverride::getLocale()

public function getLocale(): string

TextOverride::setLocale()

public function setLocale(string $locale): static

TextOverride::getValue()

public function getValue(): string

TextOverride::setValue()

public function setValue(string $value): static

TextOverride::getUpdatedAt()

public function getUpdatedAt(): \DateTimeImmutable

Tooltip class

class Tooltip implements TranslatableInterface, IconizeInterface Tooltip.php:18

Tooltip::__iconize()

public function __iconize(): ?array

Tooltip::__iconizeStatic()

public static function __iconizeStatic(): ?array

Tooltip::__toString()

public function __toString()

Tooltip::__construct()

public function __construct(string $url = "", ?string $label = null)

Tooltip::getId()

public function getId(): ?int

Tooltip::getIcon()

public function getIcon()
Throws

Exception

Tooltip::getIconFile()

public function getIconFile()
Throws

FilesystemException

Tooltip::setIcon()

public function setIcon($icon)

Tooltip::getContent()

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

Tooltip::setContent()

public function setContent(?string $content, ?string $locale = null, int $inheritanceDepthIfNotSet = 0)
Throws

Exception

Tooltip::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Tooltip::getUpdatedAt()

public function getUpdatedAt(): ?DateTimeInterface

Tooltip::getStartedAt()

public function getStartedAt(): ?DateTimeInterface

Tooltip::getEndedAt()

public function getEndedAt(): ?DateTimeInterface

TooltipIntl class

class TooltipIntl implements TranslationInterface TooltipIntl.php:10

TooltipIntl::getTitle()

public function getTitle(): ?string

TooltipIntl::setTitle()

public function setTitle(?string $title)

TooltipIntl::getContent()

public function getContent(): ?string

TooltipIntl::setContent()

public function setContent(?string $content)

Widget class

class Widget implements TranslatableInterface, IconizeInterface, CacheableInterface Widget.php:28

Widget::__toKey()

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

Widget::__iconize()

public function __iconize(): ?array

Widget::__iconizeStatic()

public static function __iconizeStatic(): ?array

Widget::__toString()

public function __toString()

Widget::__construct()

public function __construct(?string $title = null, ?string $excerpt = null, ?string $content = null)

Widget::getTemplate()

public function getTemplate()

Widget::setTemplate()

public function setTemplate(?string $template)

Widget::getId()

public function getId(): ?int

Widget::getUuid()

public function getUuid()

Widget::getThumbnail()

public function getThumbnail()
Throws

Exception

Widget::getThumbnailFile()

public function getThumbnailFile()
Throws

FilesystemException

Widget::setThumbnail()

public function setThumbnail($thumbnail)

Widget::getConnexes()

public function getConnexes(): Collection

Widget::addConnex()

public function addConnex(Widget $connex): self

Widget::removeConnex()

public function removeConnex(Widget $connex): self

Widget::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Widget::getUpdatedAt()

public function getUpdatedAt(): ?DateTimeInterface

WidgetIntl class

class WidgetIntl implements TranslationInterface WidgetIntl.php:10

WidgetIntl::getTitle()

public function getTitle(): ?string

WidgetIntl::setTitle()

public function setTitle(?string $title): self

WidgetIntl::getHeadline()

public function getHeadline(): ?string

WidgetIntl::setHeadline()

public function setHeadline(?string $headline): self

WidgetIntl::getExcerpt()

public function getExcerpt(): ?string

WidgetIntl::setExcerpt()

public function setExcerpt(?string $excerpt): self

WidgetIntl::getContent()

public function getContent(): ?string

WidgetIntl::setContent()

public function setContent(?string $content): self

Base\Entity\Layout\Attribute

class Hyperlink extends AbstractAttribute implements TranslatableInterface, IconizeInterface Hyperlink.php:19

Hyperlink::__construct()

public function __construct(AbstractAdapter $adapter, mixed $value = null)

Hyperlink::__iconize()

public function __iconize(): ?array

Hyperlink::__iconizeStatic()

public static function __iconizeStatic(): ?array

Hyperlink::__toString()

public function __toString()
public function getHyperpattern(): ?HyperpatternAdapter
public function setHyperpattern(?HyperpatternAdapter $hyperpattern): self
public function generate(?string $locale = null)
public function getLabel(): string
public function get(?string $locale = null): mixed
public function set(...$args): self
public function resolve(?string $locale = null): mixed

HyperlinkIntl class

class HyperlinkIntl implements TranslationInterface HyperlinkIntl.php:9

HyperlinkIntl::isEmpty()

public function isEmpty(): bool

HyperlinkIntl::getValue()

public function getValue(): array

HyperlinkIntl::setValue()

public function setValue($value)

Base\Entity\Layout\Attribute\Adapter

ArrayAdapter class

class ArrayAdapter extends AbstractAdapter ArrayAdapter.php:13

ArrayAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

ArrayAdapter::__construct()

public function __construct(string $label, ?string $path = null, ?int $length = null)

ArrayAdapter::getLength()

public function getLength(): ?int

ArrayAdapter::setLength()

public function setLength(?int $length)

ArrayAdapter::getType()

public static function getType(): string

ArrayAdapter::getOptions()

public function getOptions(): array

ArrayAdapter::resolve()

public function resolve(mixed $value): mixed

ColorAdapter class

class ColorAdapter extends AbstractAdapter ColorAdapter.php:14

ColorAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

ColorAdapter::getType()

public static function getType(): string

ColorAdapter::getOptions()

public function getOptions(): array

ColorAdapter::resolve()

public function resolve(mixed $value): mixed

ColorAdapter::getName()

public function getName(?string $locale = null): string

CountryAdapter class

class CountryAdapter extends AbstractAdapter CountryAdapter.php:13

CountryAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

CountryAdapter::getType()

public static function getType(): string

CountryAdapter::getOptions()

public function getOptions(): array

CountryAdapter::resolve()

public function resolve(mixed $value): mixed

DateRangeAdapter class

class DateRangeAdapter extends AbstractRuleAdapter DateRangeAdapter.php:43

"Are we inside this window?" - the coupon predicate.

Two shapes, because the two questions people actually ask are different:

{"from": "2026-12-01", "to": "2026-12-25"}
    one window, once. A launch offer.
{"from": "12-01", "to": "12-25", "annual": true}
    the same window every year. "Valid in December", which is what a
    seasonal coupon means and what a single absolute range cannot say
    without being rewritten each December.

Either end may be omitted: from alone is "from then on", to alone is "until then". Both omitted is always true, which is the right reading of a rule that has been created but not yet filled in - a half-configured condition should not silently deny everybody.

The annual form handles a window that crosses new year. "from 12-15 to 01-15" is a real offer, and comparing month-day pairs naively would make it match nothing at all, because 12-15 sorts after 01-15. When the ends are inverted the test is inverted with them: inside means at or after the start, OR at or before the end.

The subject is the instant to judge, so a rule can be asked about a date other than now ("would this coupon have been valid on the order date?"). Anything that is not a date means now.

DateRangeAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

DateRangeAdapter::getType()

public static function getType(): string

DateRangeAdapter::getOptions()

public function getOptions(): array

DateRangeAdapter::resolve()

public function resolve(mixed $value): mixed

DateRangeAdapter::supports()

public function supports(mixed $value): bool

DateRangeAdapter::compliesWith()

public function compliesWith(mixed $value, mixed $subject): bool

DateTimeAdapter class

class DateTimeAdapter extends AbstractAdapter DateTimeAdapter.php:13

DateTimeAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

DateTimeAdapter::getType()

public static function getType(): string

DateTimeAdapter::getOptions()

public function getOptions(): array

DateTimeAdapter::resolve()

public function resolve(mixed $value): mixed

HyperpatternAdapter class

class HyperpatternAdapter extends AbstractAdapter HyperpatternAdapter.php:13

HyperpatternAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

HyperpatternAdapter::getType()

public static function getType(): string

HyperpatternAdapter::resolve()

public function resolve(mixed $value): mixed

HyperpatternAdapter::getOptions()

public function getOptions(): array

HyperpatternAdapter::__construct()

public function __construct(string $label = "", ?string $code = null, ?string $icon = "fa-solid fa-laptop", string $pattern = "https://{0}")

HyperpatternAdapter::getPattern()

public function getPattern(): string

HyperpatternAdapter::setPattern()

public function setPattern(string $pattern = "https://{0}")

HyperpatternAdapter::getNumberOfArguments()

public function getNumberOfArguments(): int

HyperpatternAdapter::generate()

public function generate(...$replace): ?string

HyperpatternAdapterIntl class

class HyperpatternAdapterIntl extends AbstractAdapterIntl HyperpatternAdapterIntl.php:8

HyperpatternAdapterIntl::getPlaceholder()

public function getPlaceholder(): ?array

HyperpatternAdapterIntl::setPlaceholder()

public function setPlaceholder(?array $placeholder): self

ImageAdapter class

class ImageAdapter extends AbstractAdapter ImageAdapter.php:13

ImageAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

ImageAdapter::getType()

public static function getType(): string

ImageAdapter::getOptions()

public function getOptions(): array

ImageAdapter::resolve()

public function resolve(mixed $value): mixed

MoneyAdapter class

class MoneyAdapter extends AbstractAdapter MoneyAdapter.php:13

MoneyAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

MoneyAdapter::getType()

public static function getType(): string

MoneyAdapter::getOptions()

public function getOptions(): array

MoneyAdapter::resolve()

public function resolve(mixed $value): mixed

MoneyAdapter::__construct()

public function __construct(string $label = "", ?string $code = null, ?int $minimum = null, ?int $maximum = null)

MoneyAdapter::getMinimum()

public function getMinimum(): ?int

MoneyAdapter::setMinimum()

public function setMinimum(?int $minimum)

MoneyAdapter::getMaximum()

public function getMaximum(): ?int

MoneyAdapter::setMaximum()

public function setMaximum(?int $maximum)

NumberAdapter class

class NumberAdapter extends AbstractAdapter NumberAdapter.php:13

NumberAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

NumberAdapter::getType()

public static function getType(): string

NumberAdapter::getOptions()

public function getOptions(): array

NumberAdapter::resolve()

public function resolve(mixed $value): mixed

NumberAdapter::__construct()

public function __construct(string $label = "", ?string $code = null, ?int $minimum = null, ?int $maximum = null)

NumberAdapter::getMinimum()

public function getMinimum(): ?int

NumberAdapter::setMinimum()

public function setMinimum(?int $minimum)

NumberAdapter::getMaximum()

public function getMaximum(): ?int

NumberAdapter::setMaximum()

public function setMaximum(?int $maximum)

PercentAdapter class

class PercentAdapter extends AbstractAdapter PercentAdapter.php:13

PercentAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

PercentAdapter::getType()

public static function getType(): string

PercentAdapter::getOptions()

public function getOptions(): array

PercentAdapter::resolve()

public function resolve(mixed $value): mixed

PercentAdapter::__construct()

public function __construct(string $label = "", ?string $code = null, int $epsilon = 4, int $scale = 2)

PercentAdapter::getPrecision()

public function getPrecision(): int

PercentAdapter::setPrecision()

public function setPrecision(int $epsilon)

PercentAdapter::getScale()

public function getScale(): int

PercentAdapter::setScale()

public function setScale(int $scale)

ScalarAdapter class

class ScalarAdapter extends AbstractAdapter ScalarAdapter.php:13

ScalarAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

ScalarAdapter::getType()

public static function getType(): string

ScalarAdapter::getOptions()

public function getOptions(): array

ScalarAdapter::resolve()

public function resolve(mixed $value): mixed

ScalarAdapter::__construct()

public function __construct(string $label = "", ?string $code = null, ?int $unit = null, ?int $minimum = null, ?int $maximum = null)

ScalarAdapter::getUnit()

public function getUnit(): ?int

ScalarAdapter::setUnit()

public function setUnit(?int $unit)

ScalarAdapter::getMinimum()

public function getMinimum(): ?int

ScalarAdapter::setMinimum()

public function setMinimum(?int $minimum)

ScalarAdapter::getMaximum()

public function getMaximum(): ?int

ScalarAdapter::setMaximum()

public function setMaximum(?int $maximum)

ScoreAdapter class

class ScoreAdapter extends AbstractRuleAdapter ScoreAdapter.php:32

"Is this account's score <operation> this number?"

Modelled on the marketplace's TotalPriceAdapter rather than on a bespoke shape: the comparison is a stored Operation (LESS, GREATER_EQUAL, EQUAL...) rather than baked into the class, so one adapter covers every threshold a rule might want instead of needing a MinScoreAdapter and a MaxScoreAdapter. It also means a band is expressed the way the engine already expresses everything else - as two rules on the same subject, AND-ed together by the caller, which is exactly what MarketplaceManager does with $validRules &=.

The subject is anything that can state a score - a User today, and a Group, since both grew a getScore(). Deliberately duck-typed rather than hinted on User: this class lives in the layout engine, and hinting it there would stop the same rule judging anything else that learns to score itself later. A subject that cannot state one returns false, the same way TotalPriceAdapter returns false for anything that is not an Order.

ScoreAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

ScoreAdapter::getType()

public static function getType(): string

ScoreAdapter::getOptions()

public function getOptions(): array

ScoreAdapter::resolve()

public function resolve(mixed $value): mixed

ScoreAdapter::supports()

public function supports(mixed $value): bool

ScoreAdapter::compliesWith()

public function compliesWith(mixed $value, mixed $subject): bool

ScoreAdapter::getOperation()

public function getOperation()

ScoreAdapter::setOperation()

public function setOperation($operation): self

TextAdapter class

class TextAdapter extends AbstractAdapter TextAdapter.php:13

TextAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

TextAdapter::getType()

public static function getType(): string

TextAdapter::getOptions()

public function getOptions(): array

TextAdapter::resolve()

public function resolve(mixed $value): mixed

TextAdapter::getLength()

public function getLength(): ?int

TextAdapter::setLength()

public function setLength(?int $length)

TextareaAdapter class

class TextareaAdapter extends AbstractAdapter TextareaAdapter.php:13

TextareaAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

TextareaAdapter::getType()

public static function getType(): string

TextareaAdapter::getOptions()

public function getOptions(): array

TextareaAdapter::resolve()

public function resolve(mixed $value): mixed

Base\Entity\Layout\Attribute\Adapter\Common

AbstractActionAdapter class

abstract class AbstractActionAdapter extends AbstractAdapter implements ActionAdapterInterface AbstractActionAdapter.php:11

AbstractActionAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractActionAdapter::apply()

public function apply(mixed $value, mixed $subject): mixed

AbstractAdapter class

abstract class AbstractAdapter implements AttributeAdapterInterface, AutocompleteInterface, TranslatableInterface, IconizeInterface AbstractAdapter.php:22

AbstractAdapter::__iconize()

public function __iconize(): ?array

AbstractAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractAdapter::__toString()

public function __toString()

AbstractAdapter::__autocomplete()

public function __autocomplete(): ?string

AbstractAdapter::__autocompleteData()

public function __autocompleteData(): array

AbstractAdapter::__construct()

public function __construct(string $label = "", ?string $code = null)

AbstractAdapter::getId()

public function getId(): ?int

AbstractAdapter::getAttributes()

public function getAttributes(): Collection

AbstractAdapter::addAttribute()

public function addAttribute(AttributeInterface $attribute): self

AbstractAdapter::removeAttribute()

public function removeAttribute(AttributeInterface $attribute): self

AbstractAdapter::getCode()

public function getCode(): ?string

AbstractAdapter::setCode()

public function setCode(?string $code): self

AbstractAdapter::getIcon()

public function getIcon(): ?string

AbstractAdapter::setIcon()

public function setIcon(?string $icon): static

AbstractAdapterIntl class

class AbstractAdapterIntl implements TranslationInterface AbstractAdapterIntl.php:10

AbstractAdapterIntl::getLabel()

public function getLabel(): ?string

AbstractAdapterIntl::setLabel()

public function setLabel(?string $label): static

AbstractAdapterIntl::getHelp()

public function getHelp(): ?string

AbstractAdapterIntl::setHelp()

public function setHelp(?string $help): static

AbstractRuleAdapter class

abstract class AbstractRuleAdapter extends AbstractAdapter implements RuleAdapterInterface AbstractRuleAdapter.php:12

AbstractRuleAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractRuleAdapter::compliesWith()

public function compliesWith(mixed $value, mixed $subject): bool

AbstractScopeAdapter class

abstract class AbstractScopeAdapter extends AbstractAdapter implements ScopeAdapterInterface AbstractScopeAdapter.php:12

AbstractScopeAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractScopeAdapter::contains()

public function contains(mixed $value, mixed $subject): bool

ActionAdapterInterface interface

interface ActionAdapterInterface extends AttributeAdapterInterface ActionAdapterInterface.php:5

ActionAdapterInterface::apply()

public function apply(mixed $value, mixed $subject): mixed

AttributeAdapterInterface interface

interface AttributeAdapterInterface AttributeAdapterInterface.php:5

AttributeAdapterInterface::getType()

public static function getType(): string

AttributeAdapterInterface::getOptions()

public function getOptions(): array

AttributeAdapterInterface::resolve()

public function resolve(mixed $value): mixed

RuleAdapterInterface interface

interface RuleAdapterInterface extends AttributeAdapterInterface RuleAdapterInterface.php:5

RuleAdapterInterface::supports()

public function supports(mixed $value): bool

RuleAdapterInterface::compliesWith()

public function compliesWith(mixed $value, mixed $subject): bool

ScopeAdapterInterface interface

interface ScopeAdapterInterface extends AttributeAdapterInterface ScopeAdapterInterface.php:5

ScopeAdapterInterface::supports()

public function supports(mixed $value): bool

ScopeAdapterInterface::contains()

public function contains(mixed $value, mixed $subject): bool

Base\Entity\Layout\Attribute\Common

AbstractAction class

abstract class AbstractAction extends AbstractAttribute implements ActionInterface AbstractAction.php:13

AbstractAction::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractAction::apply()

public function apply(mixed $subject): mixed

AbstractAction::getValue()

public function getValue()

AbstractAction::setValue()

public function setValue($value): static

AbstractAction::getClass()

public function getClass(): ?string

AbstractAction::setClass()

public function setClass(?string $class): static

AbstractAttribute class

abstract class AbstractAttribute implements IconizeInterface, AttributeInterface AbstractAttribute.php:13

AbstractAttribute::__iconize()

public function __iconize(): ?array

AbstractAttribute::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractAttribute::__toString()

public function __toString()

AbstractAttribute::__construct()

public function __construct(AbstractAdapter $adapter)

AbstractAttribute::getId()

public function getId(): ?int

AbstractAttribute::getAdapter()

public function getAdapter(): ?AbstractAdapter

AbstractAttribute::setAdapter()

public function setAdapter(?AbstractAdapter $adapter): self

AbstractAttribute::getCode()

public function getCode(): ?string

AbstractAttribute::getType()

public function getType(): ?string

AbstractAttribute::getOptions()

public function getOptions(): array

AbstractRule class

abstract class AbstractRule extends AbstractAttribute implements RuleInterface AbstractRule.php:12

AbstractRule::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractRule::compliesWith()

public function compliesWith(mixed $subject): bool

AbstractRule::getValue()

public function getValue()

AbstractRule::setValue()

public function setValue($value)

AbstractRule::getClass()

public function getClass(): ?string

AbstractRule::setClass()

public function setClass(?string $class)

AbstractScope class

abstract class AbstractScope extends AbstractAttribute implements ScopeInterface AbstractScope.php:12

AbstractScope::__iconizeStatic()

public static function __iconizeStatic(): ?array

AbstractScope::contains()

public function contains(mixed $subject): bool

AbstractScope::getValue()

public function getValue()

AbstractScope::setValue()

public function setValue($value)

AbstractScope::getClass()

public function getClass(): ?string

AbstractScope::setClass()

public function setClass(?string $class)

ActionInterface interface

interface ActionInterface extends AttributeInterface ActionInterface.php:5

ActionInterface::apply()

public function apply(mixed $subject): mixed

AttributeInterface interface

interface AttributeInterface AttributeInterface.php:7

AttributeInterface::get()

public function get(?string $locale = null): mixed

AttributeInterface::set()

public function set(...$args): self

AttributeInterface::resolve()

public function resolve(?string $locale = null): mixed

AttributeInterface::getAdapter()

public function getAdapter()

AttributeInterface::setAdapter()

public function setAdapter(?AbstractAdapter $adapter): self

AttributeInterface::getCode()

public function getCode(): ?string

AttributeInterface::getType()

public function getType(): ?string

AttributeInterface::getOptions()

public function getOptions(): array

RuleInterface interface

interface RuleInterface extends AttributeInterface RuleInterface.php:5

RuleInterface::compliesWith()

public function compliesWith(mixed $subject): bool

ScopeInterface interface

interface ScopeInterface extends AttributeInterface ScopeInterface.php:5

ScopeInterface::contains()

public function contains(mixed $subject): bool

Base\Entity\Layout\Widget

Attachment class

class Attachment extends Widget implements IconizeInterface, LinkableInterface Attachment.php:21

Attachment::__iconize()

public function __iconize(): ?array

Attachment::__iconizeStatic()

public static function __iconizeStatic(): ?array

Attachment::__toLink()

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

Attachment::__toString()

public function __toString()

Attachment::getSlug()

public function getSlug(): ?string

Attachment::setSlug()

public function setSlug(string $slug): self

Attachment::getDownload()

public function getDownload()
Throws

Exception

Attachment::getDownloadFile()

public function getDownloadFile()
Throws

FilesystemException

Attachment::setDownload()

public function setDownload($file)

class Link extends Widget implements IconizeInterface, LinkableInterface Link.php:16

Link::__iconize()

public function __iconize(): ?array

Link::__iconizeStatic()

public static function __iconizeStatic(): ?array

Link::__toLink()

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

Link::__toString()

public function __toString()

Link::__construct()

public function __construct(?Hyperlink $hyperlink = null)
public function getHyperlink(): ?Hyperlink
public function setHyperlink(Hyperlink $hyperlink)

LinkIntl class

class LinkIntl extends WidgetIntl LinkIntl.php:9

LinkIntl::getTitle()

public function getTitle(): ?string

Page class

class Page extends Widget implements IconizeInterface, LinkableInterface Page.php:19

Page::__iconize()

public function __iconize(): ?array

Page::__iconizeStatic()

public static function __iconizeStatic(): ?array

Page::__toLink()

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

Page::__toString()

public function __toString()

Page::__construct()

public function __construct(?string $title = null, ?string $slug = null)

Page::getSlug()

public function getSlug(): ?string

Page::setSlug()

public function setSlug(?string $slug): self

Page::getBook()

public function getBook(): ?Book

Page::setBook()

public function setBook(?Book $book): self

Route class

class Route extends Widget implements IconizeInterface, LinkableInterface Route.php:15

Route::__iconize()

public function __iconize(): ?array

Route::__iconizeStatic()

public static function __iconizeStatic(): ?array

Route::__toLink()

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

Route::__toString()

public function __toString()

Route::__construct()

public function __construct(?string $title = null, ?string $routeName = null, array $routeParameters = [])

Route::getRouteName()

public function getRouteName(): ?string

Route::setRouteName()

public function setRouteName(?string $routeName): self

Route::getRouteParameters()

public function getRouteParameters(): ?array

Route::setRouteParameters()

public function setRouteParameters(?array $routeParameters): self

Route::getPath()

public function getPath()

Route::getRoute()

public function getRoute(): ?string

Route::getRouteIcons()

public function getRouteIcons()

Route::getUrl()

public function getUrl(): ?string

Route::generate()

public function generate(int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): ?string

Slot class

class Slot extends Widget implements TranslatableInterface, IconizeInterface Slot.php:17

Slot::__iconize()

public function __iconize(): ?array

Slot::__iconizeStatic()

public static function __iconizeStatic(): ?array

Slot::__toString()

public function __toString()

Slot::__construct()

public function __construct(string $path, ?string $label = null, ?string $help = null)

Slot::getPath()

public function getPath(): string

Slot::setPath()

public function setPath(string $path): self

Slot::getWidget()

public function getWidget(): ?Widget

Slot::setWidget()

public function setWidget(?Widget $widget): self

SlotIntl class

class SlotIntl extends WidgetIntl SlotIntl.php:10

SlotIntl::getLabel()

public function getLabel(): ?string

SlotIntl::setLabel()

public function setLabel(?string $label): self

SlotIntl::getHelp()

public function getHelp(): ?string

SlotIntl::setHelp()

public function setHelp(?string $help): self

Base\Entity\Layout\Widget\Set

Book class

class Book extends Widget implements IconizeInterface, SetInterface Book.php:18

Book::__iconize()

public function __iconize(): ?array

Book::__iconizeStatic()

public static function __iconizeStatic(): ?array

Book::__construct()

public function __construct(?string $title = null, array $pages = [])

Book::getPages()

public function getPages(): Collection

Book::addPage()

public function addPage(Page $page): self

Book::removePage()

public function removePage(Page $page): self

Linkset class

class Linkset extends Widget implements IconizeInterface, SetInterface Linkset.php:19

Linkset::__iconize()

public function __iconize(): ?array

Linkset::__iconizeStatic()

public static function __iconizeStatic(): ?array

Linkset::__construct()

public function __construct(?string $title = null, array $hyperlinks = [])
public function getHyperlinks(): Collection
public function addHyperlink(Hyperlink $hyperlink): self
public function removeHyperlink(Hyperlink $hyperlink): self

Menu class

class Menu extends Widget implements IconizeInterface, SetInterface Menu.php:18

Menu::__iconize()

public function __iconize(): ?array

Menu::__iconizeStatic()

public static function __iconizeStatic(): ?array

Menu::__construct()

public function __construct(?string $title = null)

Menu::getItems()

public function getItems(): Collection

Menu::addItem()

public function addItem(Widget $item): self

Menu::removeItem()

public function removeItem(Widget $item): self

Network class

class Network extends Widget implements IconizeInterface, SetInterface Network.php:19

Network::__iconize()

public function __iconize(): ?array

Network::__iconizeStatic()

public static function __iconizeStatic(): ?array

Network::__construct()

public function __construct(?string $title = null, array $routes = [])

Network::getRoutes()

public function getRoutes(): Collection

Network::addRoute()

public function addRoute(Route $route): self

Network::removeRoute()

public function removeRoute(Route $route): self

Paperclip class

class Paperclip extends Widget implements IconizeInterface Paperclip.php:19

Paperclip::__iconize()

public function __iconize(): ?array

Paperclip::__iconizeStatic()

public static function __iconizeStatic(): ?array

Paperclip::__construct()

public function __construct(?string $title = null, array $attachments = [])

Paperclip::getAttachments()

public function getAttachments(): Collection

Paperclip::addAttachment()

public function addAttachment(Attachment $attachment): self

Paperclip::removeAttachment()

public function removeAttachment(Attachment $attachment): self

SetInterface interface

interface SetInterface SetInterface.php:5

Base\Entity\Signature

AbstractEnvelope class

abstract class AbstractEnvelope AbstractEnvelope.php:15

What an envelope keeps (Base\Entity\Signature\Envelope): what it is about - any entity, by its class and id -, the glitchr/omnisign gateway it went through and that gateway's reference, where it stands, its signers, and the signed document and its evidence once kept in the private storage. A mapped superclass: no table of its own; Envelope is an entity only when glitchr/omnisign is installed.

const STATUS_DRAFT = 'draft'
const STATUS_SENT = 'sent'
const STATUS_COMPLETED = 'completed'
const STATUS_DECLINED = 'declined'
const STATUS_EXPIRED = 'expired'
const STATUS_CANCELED = 'canceled'

AbstractEnvelope::__construct()

public function __construct(string $subjectClass, string $subjectId, string $title, string $gateway)

AbstractEnvelope::getId()

public function getId(): ?int

AbstractEnvelope::getSubjectClass()

public function getSubjectClass(): string

AbstractEnvelope::getSubjectId()

public function getSubjectId(): string

AbstractEnvelope::getTitle()

public function getTitle(): string

AbstractEnvelope::getGateway()

public function getGateway(): string

AbstractEnvelope::getReference()

public function getReference(): ?string

AbstractEnvelope::getStatus()

public function getStatus(): string

AbstractEnvelope::isCompleted()

public function isCompleted(): bool

AbstractEnvelope::isOver()

public function isOver(): bool

Over: nothing more will happen to it (completed, declined, expired, canceled).

AbstractEnvelope::getEnvelope()

public function getEnvelope(): array

AbstractEnvelope::getSigners()

public function getSigners(): array

AbstractEnvelope::update()

public function update(?string $reference, string $status, array $envelope, ?\DateTimeImmutable $completedAt = null): static

Where it stands, as the gateway answered.

AbstractEnvelope::getSignedFile()

public function getSignedFile(): ?string

AbstractEnvelope::getEvidenceFile()

public function getEvidenceFile(): ?string

AbstractEnvelope::keep()

public function keep(?string $signedFile, ?string $evidenceFile): static

The signed document and its evidence, kept: their paths in the private storage.

AbstractEnvelope::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

AbstractEnvelope::getUpdatedAt()

public function getUpdatedAt(): \DateTimeImmutable

AbstractEnvelope::getCompletedAt()

public function getCompletedAt(): ?\DateTimeImmutable

Base\Entity\Thread

Comment class

class Comment implements SpamProtectionInterface Comment.php:32

What a visitor leaves under a thread (a blog post, a sequence, a video) - or, with no thread, in the site's visitors' book: a name, an e-mail (never shown), a site, a text, and for a reply the comment it answers. Signed in, the author is kept too. Moved here from omnibase/blog.

It implements SpamProtectionInterface: the form's model sends the text to Akismet before it is saved (base.spam.akismet), and the score lands in getSpamCallback(): a doubtful comment waits (PENDING), a clean one is APPROVED when $autoApprove says so.

JOINED, with a discriminator: a bundle that needs more on its comments (a video's time code) extends it with a #[DiscriminatorEntry] of its own.

public bool $autoApprove = true

Set before the spam check: whether a clean comment goes online at once.

Comment::__construct()

public function __construct(?Thread $thread = null, ?User $author = null)

Comment::__toString()

public function __toString(): string

Comment::getId()

public function getId(): ?int

Comment::getThread()

public function getThread(): ?Thread

Comment::setThread()

public function setThread(?Thread $thread): static

Comment::getAuthor()

public function getAuthor(): ?User

Comment::setAuthor()

public function setAuthor(?User $author): static

Comment::getName()

public function getName(): ?string

Comment::setName()

public function setName(?string $name): static

Comment::getEmail()

public function getEmail(): ?string

Comment::setEmail()

public function setEmail(?string $email): static

Comment::getWebsite()

public function getWebsite(): ?string

Comment::setWebsite()

public function setWebsite(?string $website): static

Comment::getContent()

public function getContent(): ?string

Comment::setContent()

public function setContent(?string $content): static

Comment::getParent()

public function getParent(): ?Comment

Comment::setParent()

public function setParent(?Comment $parent): static

Comment::getReplies()

public function getReplies(): Collection

Comment::getVisibleReplies()

public function getVisibleReplies(): array
Returns

the replies online

Comment::getState()

public function getState(): CommentState

Comment::setState()

public function setState(CommentState $state): static

Comment::isVisible()

public function isVisible(): bool

Comment::isPending()

public function isPending(): bool

Comment::approve()

public function approve(): static

Comment::markAsSpam()

public function markAsSpam(): static

Comment::trash()

public function trash(): static

Comment::getSpamScore()

public function getSpamScore(): ?int

Comment::getIp()

public function getIp(): ?string

Comment::setIp()

public function setIp(?string $ip): static

Comment::getUserAgent()

public function getUserAgent(): ?string

Comment::setUserAgent()

public function setUserAgent(?string $userAgent): static

Comment::getCreatedAt()

public function getCreatedAt(): ?\DateTimeInterface

Comment::setCreatedAt()

public function setCreatedAt(?\DateTimeInterface $createdAt): static

Comment::getModeratedAt()

public function getModeratedAt(): ?\DateTimeInterface

Comment::getDisplayName()

public function getDisplayName(): string

How the comment is signed: the account's name, or the name typed.

Comment::getSpamBlameable()

public function getSpamBlameable(): ?User

Comment::getSpamText()

public function getSpamText(): ?string

Comment::getSpamDate()

public function getSpamDate(): \DateTime

Comment::getSpamCallback()

public function getSpamCallback(int $score): void

The classifier's verdict (Akismet). NOT_SPAM goes online when the site auto-approves, else waits (PENDING); spam is kept aside (SPAM), for a person to read - and to report as ham if it was not; NO_TEXT (no classifier, or an empty text) is treated as clean - the form already refused an empty text.

Like class

class Like implements IconizeInterface Like.php:16

Like::__iconize()

public function __iconize(): ?array

Like::__iconizeStatic()

public static function __iconizeStatic(): ?array

Like::__construct()

public function __construct(?User $user = null)

Like::getId()

public function getId(): ?int

Like::getUser()

public function getUser(): ?User

Like::setUser()

public function setUser(?User $user): self

Like::getThread()

public function getThread(): ?Thread

Like::setThread()

public function setThread(?Thread $thread): self

Like::getIcon()

public function getIcon(): ?string

Like::setIcon()

public function setIcon(string $icon): self

Mention class

class Mention implements IconizeInterface Mention.php:16

Mention::__iconize()

public function __iconize(): ?array

Mention::__iconizeStatic()

public static function __iconizeStatic(): ?array

Mention::__construct()

public function __construct(?User $mentionee = null, ?Thread $thread = null)

Mention::getId()

public function getId(): ?int

Mention::getMentionee()

public function getMentionee(): ?User

Mention::setMentionee()

public function setMentionee(?User $mentionee): self

Mention::getMentioners()

public function getMentioners(): Collection

Mention::addMentioner()

public function addMentioner(User $mentioner): self

Mention::removeMentioner()

public function removeMentioner(User $mentioner): self

Mention::getThread()

public function getThread(): ?Thread

Mention::setThread()

public function setThread(?Thread $thread): self

Tag class

class Tag implements TranslatableInterface, IconizeInterface, AliasInterface Tag.php:27

Tag::__toString()

public function __toString()

Tag::__iconize()

public function __iconize(): ?array

Tag::__iconizeStatic()

public static function __iconizeStatic(): ?array

Tag::__construct()

public function __construct(?string $label = null, ?string $slug = null)

Tag::getId()

public function getId(): ?int

Tag::getSlug()

public function getSlug(): ?string

Tag::setSlug()

public function setSlug(?string $slug): self

Tag::getColor()

public function getColor(): ?string

Tag::setColor()

public function setColor(?string $color): self

Tag::getPriority()

public function getPriority(): ?int

Tag::setPriority()

public function setPriority(?int $priority): self

Tag::getIcon()

public function getIcon()
Throws

Exception

Tag::getIconFile()

public function getIconFile()
Throws

FilesystemException

Tag::setIcon()

public function setIcon($icon)

Tag::getThreads()

public function getThreads(): Collection

Tag::addThread()

public function addThread(Thread $thread): self

Tag::removeThread()

public function removeThread(Thread $thread): self

TagIntl class

class TagIntl implements TranslationInterface TagIntl.php:11

TagIntl::getLabel()

public function getLabel(): ?string

TagIntl::setLabel()

public function setLabel(?string $label): self

TagIntl::getKeywords()

public function getKeywords(): array

TagIntl::setKeywords()

public function setKeywords(array $keywords)

TagIntl::getDescription()

public function getDescription(): ?string

TagIntl::setDescription()

public function setDescription(?string $description): self

Taxon class

class Taxon implements TranslatableInterface, IconizeInterface, GraphInterface Taxon.php:26

Taxon::__iconize()

public function __iconize(): ?array

Taxon::__iconizeStatic()

public static function __iconizeStatic(): ?array

Taxon::__toString()

public function __toString()

Taxon::__construct()

public function __construct(?string $label = null, ?string $slug = null)

Taxon::validateLabel()

public function validateLabel(ExecutionContextInterface $context): void

A taxon is named in one language at least: the screen asks for the label of the site's language only (the others may stay empty), and a taxon without any label has nothing to show in a list, a picker or its slug.

Taxon::getId()

public function getId(): ?int

Taxon::getSlug()

public function getSlug(): ?string

Taxon::setSlug()

public function setSlug(?string $slug): self

Taxon::getIcon()

public function getIcon()
Throws

Exception

Taxon::getIconFile()

public function getIconFile()
Throws

FilesystemException

Taxon::setIcon()

public function setIcon($icon)

Taxon::getParent()

public function getParent(): ?self

Taxon::setParent()

public function setParent(?self $parent): self

Taxon::removeParent()

public function removeParent(self $parent): self

Taxon::getChildren()

public function getChildren(): Collection

Taxon::addChild()

public function addChild(self $child): self

Taxon::removeChild()

public function removeChild(self $child): self

Taxon::getThreads()

public function getThreads(): Collection

Taxon::addThread()

public function addThread(Thread $thread): self

Taxon::removeThread()

public function removeThread(Thread $thread): self

Taxon::getConnexes()

public function getConnexes(): Collection

Taxon::addConnex()

public function addConnex(self $connex): self

Taxon::removeConnex()

public function removeConnex(self $connex): self

TaxonIntl class

class TaxonIntl implements TranslationInterface TaxonIntl.php:11

TaxonIntl::getLabel()

public function getLabel(): ?string

TaxonIntl::setLabel()

public function setLabel(?string $label): self

TaxonIntl::getDescription()

public function getDescription(): ?string

TaxonIntl::setDescription()

public function setDescription(?string $description): self

TaxonIntl::getKeywords()

public function getKeywords(): array

TaxonIntl::setKeywords()

public function setKeywords(array $keywords)

Base\Entity\User

Address class

class Address implements IconizeInterface, HtmlizeInterface Address.php:14

Address::__toHtml()

public function __toHtml(array $options = [], ...$args): ?string

Address::__toString()

public function __toString()

Address::__iconize()

public function __iconize(): ?array

Address::__iconizeStatic()

public static function __iconizeStatic(): ?array

Address::__construct()

public function __construct(?string $name = null, ?Address $address = null)

Address::getId()

public function getId()

Address::getName()

public function getName(): ?string

Address::setName()

public function setName(string $name): self

Address::getCountry()

public function getCountry(): ?string

Address::setCountry()

public function setCountry(string $country): self

Address::getState()

public function getState(): ?string

Address::setState()

public function setState(?string $state): self

Address::getCity()

public function getCity(): ?string

Address::setCity()

public function setCity(string $city): self

Address::getZipCode()

public function getZipCode(): ?string

Address::setZipCode()

public function setZipCode(string $zipCode): self

Address::getStreetAddress()

public function getStreetAddress(): ?string

Address::setStreetAddress()

public function setStreetAddress(?string $streetAddress): self

Address::getAffix()

public function getAffix(): ?string

Address::setAffix()

public function setAffix(?string $affix): self

Address::getPhone()

public function getPhone(): ?string

Address::setPhone()

public function setPhone(?string $phone): self

Address::getFax()

public function getFax(): ?string

Address::setFax()

public function setFax(?string $fax): self

Address::getAdditional()

public function getAdditional(): ?string

Address::setAdditional()

public function setAdditional(?string $additional): self

Address::getUser()

public function getUser(): ?User

Address::setUser()

public function setUser(?User $user): self

Complaint class

class Complaint implements IconizeInterface Complaint.php:26

A user's complaint about another one (or about something), for the staff to answer.

Where it was made is the app's business: source names it (a game world, a forum…) and location where in it (a room, a topic), and context carries whatever makes it answerable there - for a game world, what was said in the room before it and every act of the staff that touched the people in it. The two users are kept by name as well as by account: an account may go, the complaint stays readable. targetStatus is the rank the one complained about held when it was made.

Who may read one is Base\Security\Voter\ComplaintVoter's call (COMPLAINT_READ / COMPLAINT_HANDLE on the complaint): the staff whose roles outrank the one it is about - a complaint about a moderator goes to the ranks above them, never to the moderator - and never the one it is about.

Settled, it may point at the Sanction it led to.

const OPEN = "open"
const HANDLED = "handled"
const DISMISSED = "dismissed"
const STATUSES = [self::OPEN => "À traiter", self::HANDLED => "Traitée", self::DISMISSED => "Classée sans suite"]

Complaint::__construct()

public function __construct(?User $complainant = null, ?string $text = null, ?string $source = null)

Complaint::__iconize()

public function __iconize(): ?array

Complaint::__iconizeStatic()

public static function __iconizeStatic(): ?array

Complaint::getId()

public function getId(): ?int

Complaint::getCreatedAt()

public function getCreatedAt(): DateTime

Complaint::setCreatedAt()

public function setCreatedAt(DateTime $at): self

Complaint::getComplainant()

public function getComplainant(): ?User

Complaint::setComplainant()

public function setComplainant(?User $user): self

Complaint::getComplainantName()

public function getComplainantName(): string

Complaint::setComplainantName()

public function setComplainantName(string $name): self

Complaint::getTarget()

public function getTarget(): ?User

Complaint::setTarget()

public function setTarget(?User $user): self

Complaint::getTargetName()

public function getTargetName(): ?string

Complaint::setTargetName()

public function setTargetName(?string $name): self

Complaint::getTargetStatus()

public function getTargetStatus(): ?string

Complaint::setTargetStatus()

public function setTargetStatus(?string $status): self

Complaint::getSource()

public function getSource(): ?string

Complaint::setSource()

public function setSource(?string $source): self

Complaint::getLocation()

public function getLocation(): ?string

Complaint::setLocation()

public function setLocation(?string $location): self

Complaint::getLocationName()

public function getLocationName(): ?string

Complaint::setLocationName()

public function setLocationName(?string $name): self

Complaint::getText()

public function getText(): string

Complaint::setText()

public function setText(string $text): self

Complaint::getContext()

public function getContext(): array

Complaint::setContext()

public function setContext(array $context): self

Complaint::getStatus()

public function getStatus(): string

Complaint::getStatusLabel()

public function getStatusLabel(): string

Complaint::isOpen()

public function isOpen(): bool

Complaint::getHandledBy()

public function getHandledBy(): ?User

Complaint::getHandledAt()

public function getHandledAt(): ?DateTime

Complaint::getAnswer()

public function getAnswer(): ?string

Complaint::getSanction()

public function getSanction(): ?Sanction

Complaint::setSanction()

public function setSanction(?Sanction $sanction): self

Complaint::settle()

public function settle(string $status, ?User $by, ?string $answer = null): self

Handled or dismissed (or opened again), by whom, with what answer.

Connection class

class Connection implements IconizeInterface Connection.php:14

Connection::__iconize()

public function __iconize(): ?array

Connection::__iconizeStatic()

public static function __iconizeStatic(): ?array

Connection::__construct()

public function __construct(string $uniqid = "", ?User $user = null)

Connection::getId()

public function getId(): ?int

Connection::getUniqid()

public function getUniqid(): ?string

Connection::setUniqid()

public function setUniqid(string $uniqid): self

Connection::getUser()

public function getUser(): ?User

Connection::setUser()

public function setUser(?User $user): self

Connection::getImpersonator()

public function getImpersonator(): ?User

Connection::setImpersonator()

public function setImpersonator(?User $impersonator): self

Connection::getLoginAttempts()

public function getLoginAttempts(): ?string

Connection::setLoginAttempts()

public function setLoginAttempts(int $loginAttempts): self

Connection::getState()

public function getState(): ?string

Connection::isValid()

public function isValid(): bool

Connection::markAsSucceeded()

public function markAsSucceeded(): self

Connection::markAsFailed()

public function markAsFailed(): self

Connection::markAsLogout()

public function markAsLogout(): self

Connection::getIpList()

public function getIpList(): ?array

Connection::addIp()

public function addIp(string $ip): self

Connection::removeIp()

public function removeIp(string $ip): self

Connection::getAgent()

public function getAgent(): ?string

Connection::setAgent()

public function setAgent(string $agent): self

Connection::getAgentLabel()

public function getAgentLabel(): ?string

A short, readable name for the browser behind this connection.

Purely for display: a settings page listing "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.5 Safari/605.1.15" twenty times over tells nobody which session is theirs. The full string stays available - this is a label beside it, not a replacement for it.

Order matters in both lists: Edge and Chrome both claim to be Safari, and Chrome claims to be Safari too, so the most specific claim has to be tested first. Anything unrecognised keeps the raw string.

Connection::getLocale()

public function getLocale(): ?string

Connection::setLocale()

public function setLocale(string $locale): self

Connection::getTimezones()

public function getTimezones(): ?array

Connection::addTimezone()

public function addTimezone(?string $timezone): self

Connection::removeTimezone()

public function removeTimezone(?string $timezone): self

Connection::getHostnames()

public function getHostnames(): ?array

Connection::addHostname()

public function addHostname(?string $hostname): self

Connection::removeHostname()

public function removeHostname(?string $hostname): self

Connection::getCreatedAt()

public function getCreatedAt(): ?\DateTimeInterface

Connection::setCreatedAt()

public function setCreatedAt(\DateTimeInterface $createdAt): self

Connection::getUpdatedAt()

public function getUpdatedAt(): ?\DateTimeInterface

Connection::setUpdatedAt()

public function setUpdatedAt(\DateTimeInterface $updatedAt): self

Group class

class Group implements IconizeInterface Group.php:31

Open to extension the way User is: JOINED inheritance on a class discriminator, so an application can add its own group (a leader, a motto, a join mode...) as a subclass in its own table, while roles, permissions, rules, scopes and actions keep working on the base row. An application without a subclass sees no change but the discriminator column.

const DEFAULT_ICON = "fa-solid fa-users"

The icon a group gets until it is given one: the column is NOT NULL.

Group::__iconize()

public function __iconize(): ?array

Group::__iconizeStatic()

public static function __iconizeStatic(): ?array

Group::__toString()

public function __toString(): string

Its name, wherever a group is shown as one line: the pickers (a permission's groups, a user's), the back office's titles and lists.

Without it a picker fell back to the translation key of the class and the id ("occasion_group._singular #1" for an application's subclass).

Group::__construct()

public function __construct()

Group::getId()

public function getId(): ?int

Group::getRoles()

public function getRoles(): array

Group::setRoles()

public function setRoles(array $roles): self

Group::getName()

public function getName(): ?string

Group::setName()

public function setName(string $name): self

Group::getMembers()

public function getMembers(): Collection

Group::addMember()

public function addMember(User $member): self

Group::removeMember()

public function removeMember(User $member): self

Group::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Group::setCreatedAt()

public function setCreatedAt(DateTimeInterface $createdAt): self

Group::getPermissions()

public function getPermissions(): Collection

Group::addPermission()

public function addPermission(Permission $permission): self

Group::removePermission()

public function removePermission(Permission $permission): self

Group::getRules()

public function getRules(): Collection

Group::addRule()

public function addRule(GroupRule $rule): self

Group::removeRule()

public function removeRule(GroupRule $rule): self

Group::getScopes()

public function getScopes(): Collection

Group::addScope()

public function addScope(GroupScope $scope): self

Group::removeScope()

public function removeScope(GroupScope $scope): self

Group::getActions()

public function getActions(): Collection

Group::addAction()

public function addAction(GroupAction $action): self

Group::removeAction()

public function removeAction(GroupAction $action): self

Group::awardsFor()

public function awardsFor(mixed $subject): array

Everything this group would award $subject, or nothing if it would not admit them.

Computes; it does not grant. The marketplace's manager accumulates what its actions return and applies the total itself ($discount += $action->apply($product)), and the same separation is what lets this be used to SHOW somebody what reaching the next level would give them - a preview that grants nothing.

Awards are merged and de-duplicated per kind, because two actions on one group may legitimately award the same role, and the caller wants the set rather than the tally.

Returns e.g. ["roles" => ["ROLE_X"], "permissions" => ["ALLIANCE.SENIOR"]]. The keys are the shapes the shipped adapters return; an adapter awarding something else lands under "other" rather than being silently dropped.

Group::isOpenTo()

public function isOpenTo(mixed $subject): bool

Whether this group would admit $subject as things stand.

Says nothing about whether they are already a member: this answers "have they earned it", so a group can be offered when it becomes reachable and a membership can be re-checked when a score moves.

No scopes means the group concerns everybody - the right default for one whose entry is purely a matter of score. No rules means nothing is being asked of them, so it admits anyone in scope rather than nobody: a group still being configured must not read as "closed".

Group::getScore()

public function getScore(): int

What belonging to this group costs, or earns.

A group carries penalties directly rather than through Sanction: a penalty on a group is a standing property of the group, not an incident with a date and an author, and it applies to whoever is a member at the time rather than to the people who were members when it was issued.

Group::getPenalties()

public function getPenalties(): Collection

Group::addPenalty()

public function addPenalty(Penalty $penalty): self

Group::removePenalty()

public function removePenalty(Penalty $penalty): self

Group::getColor()

public function getColor(): ?string

Group::setColor()

public function setColor(?string $color): self

Group::getIcon()

public function getIcon(): ?string

Group::setIcon()

public function setIcon(?string $icon): self

Invitation class

abstract class Invitation Invitation.php:18

An e-mail that opens something: whoever follows its link before it runs out gets an account (or signs in with theirs), attached to what it was made for. Only the token's hash is kept; the token itself is sent, never stored (Base\Service\Invitations).

A mapped superclass: each bundle keeps its own table and says what an invitation opens (omnibase/estate's Invitation: an associate, a tenant, a contractor, a member of the management, in estate_invitation).

Invitation::__construct()

public function __construct(string $email, string $name, string $tokenHash, \DateTimeImmutable $expiresAt)

Invitation::getId()

abstract public function getId(): ?int

Invitation::__toString()

public function __toString(): string

Invitation::getEmail()

public function getEmail(): string

Invitation::getName()

public function getName(): string

Invitation::getTokenHash()

public function getTokenHash(): string

Invitation::getCreatedAt()

public function getCreatedAt(): \DateTimeImmutable

Invitation::getExpiresAt()

public function getExpiresAt(): \DateTimeImmutable

Invitation::getAcceptedAt()

public function getAcceptedAt(): ?\DateTimeImmutable

Invitation::accept()

public function accept(): static

Invitation::getInvitedBy()

public function getInvitedBy(): ?User

Invitation::setInvitedBy()

public function setInvitedBy(?User $invitedBy): static

Invitation::isOpen()

public function isOpen(): bool

Notification class

class Notification extends SymfonyNotification implements BaseNotificationInterface, SmsNotificationInterface, EmailNotificationInterface, ChatNotificationInterface, IconizeInterface Notification.php:42

A notification: its subject, content, importance, channels, recipients, context and templates, and its sending through omnibase's notifier. Cut in two (plan "omnibase agnostique", step C3f): what needs Symfony - an ExceptionEvent or a FlattenException made content, render()'s Response, the e-mail built on Twig's TemplatedEmail and HttpFoundation's uploaded files - is Base\Bridge\Symfony\NotificationMessages'; this class names nothing of the framework (Symfony's Notifier is a standalone component).

const IMPORTANCE_DEFAULT = "default"
const IMPORTANCE_SUCCESS = "success"
const IMPORTANCE_INFO = "info"
const IMPORTANCE_NOTICE = "notice"
const IMPORTANCE_DANGER = "danger"

Notification::__toPrune()

public function __toPrune(?RecipientInterface $recipient = null): SymfonyNotification

Notification::__iconize()

public function __iconize(): ?array

Notification::__iconizeStatic()

public static function __iconizeStatic(): ?array

Notification::getId()

public function getId(): ?int

Notification::getUser()

public function getUser(): ?User

Notification::setUser()

public function setUser(?User $user): self

Notification::getAttachments()

public function getAttachments(): array

Notification::addAttachment()

public function addAttachment(\SplFileInfo $attachment): self

An e-mail's attachment: what the e-mail embeds is an uploaded file (HttpFoundation's UploadedFile, Base\Bridge\Symfony\NotificationMessages::email()), as before; the type is its parent, \SplFileInfo, so that this class names nothing of the framework.

Notification::removeAttachment()

public function removeAttachment(\SplFileInfo $attachment): self

Notification::getRecipients()

public function getRecipients(): array

Notification::addRecipient()

public function addRecipient(RecipientInterface $recipient): self

Notification::removeRecipient()

public function removeRecipient(RecipientInterface $recipient): self

Notification::getChannels()

public function getChannels(?RecipientInterface $recipient = null): array

Notification::setChannels()

public function setChannels(array $channels): self

Notification::getImportance()

public function getImportance(): string

Notification::setImportance()

public function setImportance(?string $importance): self

Notification::getSubject()

public function getSubject(): string

Notification::setSubject()

public function setSubject(string $subject): self

Notification::getContent()

public function getContent(): string

Notification::setContent()

public function setContent(string $content): self

Notification::getUrl()

public function getUrl(): ?string

Notification::setUrl()

public function setUrl(?string $url): self

Notification::getTargetClass()

public function getTargetClass(): ?string

Notification::getTargetId()

public function getTargetId(): ?string

Notification::setTarget()

public function setTarget(?object $entity): self

Notification::getTitle()

public function getTitle(): string

Notification::setTitle()

public function setTitle(string $title): self

Notification::isRead()

public function isRead(): bool

Notification::setIsRead()

public function setIsRead(bool $isRead): self

Notification::markAsRead()

public function markAsRead(bool $isRead)

Notification::markAsReadIfNeeded()

public function markAsReadIfNeeded(array $channels = [])

Notification::getSentAt()

public function getSentAt(): ?DateTimeInterface

Notification::setSentAt()

public function setSentAt(?DateTimeInterface $sentAt): self

Notification::getBacktrace()

public function getBacktrace(): string

Notification::isMarkAsAdmin()

public function isMarkAsAdmin()

Notification::markAsAdmin()

public function markAsAdmin(bool $markAsAdmin = true)

Notification::getContext()

public function getContext(array $additionalContext = [])

Notification::addContextKey()

public function addContextKey(string $key, $value = null): self

Notification::addContext()

public function addContext(array $context = []): self

Notification::setContext()

public function setContext(array $context): self

Notification::removeContextKey()

public function removeContextKey(string $key): self

Notification::getHtmlTemplate()

public function getHtmlTemplate()

Notification::setHtmlTemplate()

public function setHtmlTemplate(?string $htmlTemplate, array $htmlParameters = [])

Notification::getHtmlParameters()

public function getHtmlParameters(): array

Notification::setHtmlParameters()

public function setHtmlParameters(array $htmlParameters)

Notification::addHtmlParameter()

public function addHtmlParameter(string $key, $value)

Notification::removeHtmlParameter()

public function removeHtmlParameter(string $key)

Notification::getExcerpt()

public function getExcerpt()

Notification::setExcerpt()

public function setExcerpt(string $excerpt)

Notification::getFooter()

public function getFooter()

Notification::setFooter()

public function setFooter(string $footer)

Notification::__construct()

public function __construct($content = null, array $parameters = array(), string $domain = "@notifications", ?string $locale = null)
Throws

Exception

Notification::render()

public function render()

The notification as a page: Symfony's Response of renderHtml() (Base\Bridge\Symfony\NotificationMessages::response()).

Notification::renderHtml()

public function renderHtml(): string

The notification's HTML: its template rendered with its context, else its content.

Notification::send()

public function send(?string $importance = null, RecipientInterface ...$recipients)

Notification::sendBy()

public function sendBy(array $channels, RecipientInterface ...$recipients)

Notification::sendAdmins()

public function sendAdmins(string $importance)

Notification::asSmsMessage()

public function asSmsMessage(SmsRecipientInterface $recipient, ?string $transport = null): ?SmsMessage

Notification::asEmailMessage()

public function asEmailMessage(EmailRecipientInterface $recipient, ?string $transport = null): ?EmailMessage

The e-mail: Base\Bridge\Symfony\NotificationMessages::email(), with the notifier, Twig and the project's directory this notification reaches through BaseTrait.

Notification::asChatMessage()

public function asChatMessage(RecipientInterface $recipient, ?string $transport = null): ?ChatMessage

Passkey class

class Passkey extends CredentialRecord Passkey.php:13

Passkey::getId()

public function getId(): ?int

Passkey::getUser()

public function getUser(): ?User

Passkey::setUser()

public function setUser(?User $user): self

Passkey::getLabel()

public function getLabel(): ?string

Passkey::setLabel()

public function setLabel(?string $label): self

Passkey::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Passkey::getLastUsedAt()

public function getLastUsedAt(): ?DateTimeInterface

Passkey::touch()

public function touch(): self

Passkey::createFromCredentialRecord()

public static function createFromCredentialRecord(CredentialRecord $record, User $user, ?string $label = null): self

The library hands saveCredentialRecord() a plain CredentialRecord (built internally from the attestation response), never an instance of this class - copy its fields across into a real, persistable Passkey tied to the registering user.

Penalty class

class Penalty implements IconizeInterface Penalty.php:33

A penalty an administrator has defined, NOT one somebody has received.

This is a catalogue: an administrator writes the set of penalties the site recognises once - what each is called, what it costs, how long it lasts - and a moderator then applies one from that list rather than inventing a sanction and a number on the spot. Applying one creates a Sanction, which is where the per-case facts live (who, by whom, why, until when).

That split is why the user side is a Sanction and not the plain many-to-many it used to be: a join table has nowhere to record when a penalty expires or who issued it, so every application of the same penalty would have had to share one expiry.

Groups keep a direct many-to-many, because a penalty carried by a group is a property of the group itself rather than an incident with a date.

Penalty::__construct()

public function __construct(?string $type = null, int $weight = 0)

Penalty::__iconize()

public function __iconize(): ?array

Penalty::__iconizeStatic()

public static function __iconizeStatic(): ?array

Penalty::__toString()

public function __toString(): string

Penalty::getId()

public function getId(): ?int

Penalty::getFormType()

public function getFormType(): ?string

Penalty::getType()

public function getType(): ?string

Penalty::setType()

public function setType(string $type): self

Penalty::getWeight()

public function getWeight(): int

Penalty::setWeight()

public function setWeight(int $weight): self

Penalty::getDurationDays()

public function getDurationDays(): ?int

Penalty::setDurationDays()

public function setDurationDays(?int $durationDays): self

Penalty::expiresFrom()

public function expiresFrom(?DateTimeInterface $from = null): ?DateTime

When a sanction issued at $from would lapse, or null for one that never does. Kept here rather than in the moderator's hands so that changing a penalty's length in the catalogue changes it everywhere it is applied next, which is the point of having a catalogue.

Penalty::getExtra()

public function getExtra(): ?string

Penalty::setExtra()

public function setExtra(string $extra): self

Penalty::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Penalty::setCreatedAt()

public function setCreatedAt(DateTimeInterface $createdAt): self

Penalty::getSanctions()

public function getSanctions(): Collection

Penalty::getGid()

public function getGid(): Collection

Penalty::addGid()

public function addGid(Group $gid): self

Penalty::removeGid()

public function removeGid(Group $gid): self

Permission class

class Permission implements IconizeInterface Permission.php:14

Permission::__iconize()

public function __iconize(): ?array

Permission::__iconizeStatic()

public static function __iconizeStatic(): ?array

Permission::__construct()

public function __construct()

Permission::getId()

public function getId(): ?int

Permission::__toString()

public function __toString(): string

Its tag, wherever a permission is shown as one line (a group's permissions picker).

Permission::getTag()

public function getTag(): ?string

Permission::setTag()

public function setTag(string $tag): self

Permission::getDescription()

public function getDescription(): ?string

Permission::setDescription()

public function setDescription(string $description): self

Permission::getEmpoweredRoles()

public function getEmpoweredRoles(): array

Permission::setEmpoweredRoles()

public function setEmpoweredRoles(array $empower): self

Permission::getUid()

public function getUid(): Collection

Permission::addUid()

public function addUid(User $uid): self

Permission::removeUid()

public function removeUid(User $uid): self

Permission::getGid()

public function getGid(): Collection

Permission::addGid()

public function addGid(Group $gid): self

Permission::removeGid()

public function removeGid(Group $gid): self

Permission::getIcon()

public function getIcon(): ?string

Permission::setIcon()

public function setIcon(?string $icon): self

PushSubscription class

class PushSubscription PushSubscription.php:20

One browser's Web Push endpoint for one user. A person has one of these per browser they enabled notifications in (phone, laptop, ...), and each one dies on its own when the browser revokes it - the push service then answers 404/410 and WebPushService prunes the row.

Endpoint URLs run to ~300 characters, longer than an indexable MySQL unique key on utf8mb4, so uniqueness is enforced on a sha1 of it instead.

PushSubscription::getId()

public function getId(): ?int

PushSubscription::getUser()

public function getUser(): ?User

PushSubscription::setUser()

public function setUser(?User $user): self

PushSubscription::getEndpoint()

public function getEndpoint(): string

PushSubscription::setEndpoint()

public function setEndpoint(string $endpoint): self

PushSubscription::getEndpointHash()

public function getEndpointHash(): string

PushSubscription::getP256dh()

public function getP256dh(): string

PushSubscription::setP256dh()

public function setP256dh(string $p256dh): self

PushSubscription::getAuth()

public function getAuth(): string

PushSubscription::setAuth()

public function setAuth(string $auth): self

PushSubscription::getUserAgent()

public function getUserAgent(): ?string

PushSubscription::setUserAgent()

public function setUserAgent(?string $userAgent): self

PushSubscription::getCreatedAt()

public function getCreatedAt(): DateTimeInterface

PushSubscription::getLastUsedAt()

public function getLastUsedAt(): ?DateTimeInterface

PushSubscription::touch()

public function touch(): self

PushSubscription::__construct()

public function __construct()

PushSubscription::toArray()

public function toArray(): array

The shape minishlink/web-push expects.

Sanction class

class Sanction implements IconizeInterface Sanction.php:33

One penalty, given to one user, once.

The counterpart to Penalty: that one is the catalogue an administrator curates, this one is a moderator picking an entry from it and applying it. Everything that varies per case lives here - who received it, who issued it, why, and until when - while what the penalty IS and what it costs stays in the catalogue entry, so an administrator can restate the cost of "spam" in one place.

This exists as an entity rather than the join table it replaces (user_penalties) because a join row has room for nothing but the two ids. With one, every application of the same penalty would have shared a single expiry, and there would have been nowhere to record the moderator or the reason - the two things anybody asks for first when a sanction is disputed.

Expiry is stored, not derived. Penalty::expiresFrom() decides it when the sanction is created, and it is then frozen: shortening "spam" in the catalogue must not silently pardon everyone already serving one, and lengthening it must not silently extend them either.

Sanction::__construct()

public function __construct(?User $user = null, ?Penalty $penalty = null, ?User $moderator = null, ?string $reason = null)

Sanction::__iconize()

public function __iconize(): ?array

Sanction::__iconizeStatic()

public static function __iconizeStatic(): ?array

Sanction::getId()

public function getId(): ?int

Sanction::getUser()

public function getUser(): ?User

Sanction::setUser()

public function setUser(?User $user): self

Sanction::getPenalty()

public function getPenalty(): ?Penalty

Sanction::setPenalty()

public function setPenalty(?Penalty $penalty): self

Sanction::getModerator()

public function getModerator(): ?User

Sanction::setModerator()

public function setModerator(?User $moderator): self

Sanction::getReason()

public function getReason(): ?string

Sanction::setReason()

public function setReason(?string $reason): self

Sanction::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Sanction::getExpiresAt()

public function getExpiresAt(): ?DateTimeInterface

Sanction::setExpiresAt()

public function setExpiresAt(?DateTimeInterface $expiresAt): self

Sanction::getLiftedAt()

public function getLiftedAt(): ?DateTimeInterface

Sanction::lift()

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

Sanction::isActive()

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

Sanction::getWeight()

public function getWeight(?DateTimeInterface $at = null): int

What this contributes to a score right now - nothing once it has lapsed.

Token class

class Token implements IconizeInterface Token.php:18

const ALL = "ALL_TOKENS"
const VALID = "VALID_TOKENS"
const EXPIRED = "EXPIRED_TOKENS"

Token::__iconize()

public function __iconize(): ?array

Token::__iconizeStatic()

public static function __iconizeStatic(): ?array

Token::__construct()

public function __construct(string $name, ?int $expiry = null, ?int $throttle = null)

Token::__sleep()

public function __sleep()

Token::encode()

public function encode()

Token::decode()

public function decode(string $hash)

Token::getId()

public function getId(): ?int

Token::getUser()

public function getUser(): ?User

Token::setUser()

public function setUser(?User $user): self

Token::getName()

public function getName(): ?string

Token::setName()

public function setName(string $name): self

Token::get()

public function get(): ?string

Token::getValue()

public function getValue(): ?string

Token::generate()

public function generate(?int $expiry = null, ?int $throttle = null): self

Token::getCreatedAt()

public function getCreatedAt(): ?DateTimeInterface

Token::setCreatedAt()

public function setCreatedAt(DateTimeInterface $createdAt): self

Token::getExpireAt()

public function getExpireAt(): ?DateTimeInterface

Token::setExpireAt()

public function setExpireAt(DateTimeInterface $expireAt): self

Token::getExpiry()

public function getExpiry(): ?DateTimeInterface

Token::setExpiry()

public function setExpiry(DateTimeInterface $expireAt): self

Token::isValid()

public function isValid(): bool

Token::getElapsedTime()

public function getElapsedTime(): int

Token::getLifetime()

public function getLifetime(): int

Token::getRemainingTime()

public function getRemainingTime(): int

Token::getRemainingTimeStr()

public function getRemainingTimeStr(): string

Token::getAllowAt()

public function getAllowAt(): ?DateTimeInterface

Token::setAllowAt()

public function setAllowAt(DateTimeInterface $allowAt): self

Token::hasVeto()

public function hasVeto(): bool

Token::getThrottleTime()

public function getThrottleTime(): int

Token::getThrottleTimeStr()

public function getThrottleTimeStr(): string

Token::setThrottleTime()

public function setThrottleTime(DateTimeInterface $allowAt): self

Token::isThrottled()

public function isThrottled(): bool

Token::revoke()

public function revoke(): self

Token::isRevoked()

public function isRevoked(): bool

Token::markAsRevoked()

public function markAsRevoked(): self

Token::isLogginable()

public function isLogginable(): bool

Token::markAsLogginable()

public function markAsLogginable(bool $isLogginable = true): self

Base\Entity\User\Attribute

GroupAction class

class GroupAction extends AbstractAction GroupAction.php:29

What a group DOES for somebody who qualifies for it.

The third of the triad, and the half that was missing: scopes decide who a group concerns, rules decide whether they qualify, and actions are what actually happens when they do. Without this the engine could only ever answer yes or no, which is why "reaching level 3 unlocks that alliance" stopped at "is eligible" and never became "has the role".

Modelled on the marketplace's DiscountAction: owned by the thing it belongs to, delegating the work to an adapter, and - importantly - COMPUTING rather than mutating. There, MarketplaceManager accumulates what the actions return ($discount += $action->apply($product)) and applies the total itself. Group::grantTo() does the same, gathering what every action awards before touching the user once, so an action can be evaluated (previewed, listed, explained) without granting anything.

GroupAction::get()

public function get(?string $locale = null): mixed

GroupAction::set()

public function set(...$args): self

GroupAction::resolve()

public function resolve(?string $locale = null): mixed

GroupAction::getGroup()

public function getGroup(): ?Group

GroupAction::setGroup()

public function setGroup(?Group $group): self

GroupRule class

class GroupRule extends AbstractRule GroupRule.php:26

A condition a user must satisfy for a group to be open to them.

Shaped after the marketplace's DiscountRule rather than as a free-floating rule: a rule belongs to the thing it qualifies, and carries a foreign key to it. That is what lets one rule table serve a discount, a shipping method and a group without any of them knowing about each other - the concrete subclass is the only thing that names an owner.

The predicate itself is not here. It lives in the adapter (ScoreAdapter and friends), which is why "reaching level 3 unlocks this alliance" needs no class of its own: it is a GroupRule pointing at a ScoreAdapter whose operation is GREATER_EQUAL.

GroupRule::get()

public function get(?string $locale = null): mixed

GroupRule::set()

public function set(...$args): self

GroupRule::resolve()

public function resolve(?string $locale = null): mixed

GroupRule::getGroup()

public function getGroup(): ?Group

GroupRule::setGroup()

public function setGroup(?Group $group): self

GroupScope class

class GroupScope extends AbstractScope GroupScope.php:26

Who a group's rules are about in the first place.

Scope and rule answer different questions, and the marketplace evaluates them differently for that reason (MarketplaceManager): scopes are OR-ed - any one matching brings the subject into range - while rules are AND-ed, because every condition has to hold. Scope is "does this concern you", rule is "do you qualify".

For a group that means a scope can narrow an alliance to, say, a region or a taxon, and the rules then decide whether a user inside that scope has earned their way in. A group with no scopes concerns everyone, which is the right default for one whose entry is purely a matter of score.

GroupScope::get()

public function get(?string $locale = null): mixed

GroupScope::set()

public function set(...$args): self

GroupScope::resolve()

public function resolve(?string $locale = null): mixed

GroupScope::getGroup()

public function getGroup(): ?Group

GroupScope::setGroup()

public function setGroup(?Group $group): self

Base\Entity\User\Attribute\Action

GrantPermissionAdapter class

class GrantPermissionAdapter extends AbstractActionAdapter GrantPermissionAdapter.php:33

Awards one or more fine-grained permission tags.

This is the piece that closes the loop the site already had half of. PermissionVoter has been live for a while, resolving custom tags like ARTICLE.PUBLISH from a user and their groups, with "ARTICLE.*" wildcards - but nothing could ever GRANT a tag except an administrator doing it by hand. With this, a score threshold can:

score >= 250  ->  grant "ALLIANCE.SENIOR"  ->  isGranted() says yes

so a level becomes a real capability with no code between the two.

Returns tags, not Permission entities, and deliberately: resolving a tag to its row is a repository lookup, and an entity that queries is an entity you cannot evaluate offline. The caller resolves and attaches, the same way MarketplaceManager applies the totals its adapters return.

GrantPermissionAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

GrantPermissionAdapter::getType()

public static function getType(): string

GrantPermissionAdapter::getOptions()

public function getOptions(): array

GrantPermissionAdapter::resolve()

public function resolve(mixed $value): mixed

GrantPermissionAdapter::apply()

public function apply(mixed $value, mixed $subject): mixed

GrantRoleAdapter class

class GrantRoleAdapter extends AbstractActionAdapter GrantRoleAdapter.php:33

Awards one or more roles to whoever qualified.

This is the action behind "passing a level gives access": a group whose rules say score >= 250 and whose action grants ROLE_ALLIANCE_SENIOR turns a number into an actual capability, without anything hard-coding either the threshold or the role.

Returns the roles rather than assigning them, following the marketplace's adapters, which compute an amount and let MarketplaceManager apply the total. Group::grantTo() accumulates across every action and writes to the user once - so listing what a group WOULD give somebody costs nothing and changes nothing.

A role already held is still returned; deduplicating is the caller's job, because "what does this action award" and "what would change" are different questions and only the caller knows the user's current roles.

GrantRoleAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

GrantRoleAdapter::getType()

public static function getType(): string

GrantRoleAdapter::getOptions()

public function getOptions(): array

GrantRoleAdapter::resolve()

public function resolve(mixed $value): mixed

GrantRoleAdapter::apply()

public function apply(mixed $value, mixed $subject): mixed

Base\Entity\User\Attribute\Scope

GroupAdapter class

class GroupAdapter extends AbstractScopeAdapter GroupAdapter.php:34

Narrows something to the members of another group.

This is what makes groups chain. An alliance scoped to "Explorers" with a rule of score >= 250 admits a senior explorer and nobody else, so membership can be built in tiers without any tier knowing the rules of the one below it - the same way the marketplace scopes a coupon to a Taxon and lets the category tree do the work.

Membership is read from the SUBJECT rather than from the scoped group, so this asks a user which groups they are in rather than asking a group to enumerate its members. On a group with many members that is the difference between one collection and a table scan, and it is also the direction that survives a user being scoped without the group being loaded.

Deliberately not transitive: being in a group that is itself scoped to Explorers does not make you an Explorer. Chaining is a thing you express by pointing a scope at each tier, not something inferred - inferred transitive membership is how a cycle becomes an infinite loop.

GroupAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

GroupAdapter::getType()

public static function getType(): string

GroupAdapter::getOptions()

public function getOptions(): array

GroupAdapter::resolve()

public function resolve(mixed $value): mixed

GroupAdapter::supports()

public function supports(mixed $value): bool

GroupAdapter::contains()

public function contains(mixed $value, mixed $subject): bool

UserAdapter class

class UserAdapter extends AbstractScopeAdapter UserAdapter.php:34

Narrows something to named people.

The scope half of the engine, ported from the marketplace's own UserAdapter - the one that limits a coupon to particular customers. Here it limits a group to particular users, which is what makes an alliance invitational rather than open to anyone who clears its score.

The stored value is a User entity, not an id: supports() says so, and the form is an entity picker. That follows the original rather than being a choice - scopes there hold Products, Regions and Users, and comparing rows rather than ids is what lets a scope be checked without a lookup.

contains() walks from whatever subject it is handed to the user it is really about, exactly as the marketplace's walks Order and OrderItem to their customer. A Sanction is asked about its user, so a scope can be pointed at moderation records as readily as at people. Anything with no user behind it falls through to the parent, which throws rather than quietly answering false - a scope that cannot judge a subject is a misconfiguration, not a "no".

UserAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

UserAdapter::getType()

public static function getType(): string

UserAdapter::getOptions()

public function getOptions(): array

UserAdapter::resolve()

public function resolve(mixed $value): mixed

UserAdapter::supports()

public function supports(mixed $value): bool

UserAdapter::contains()

public function contains(mixed $value, mixed $subject): bool

Base\Enum

Allergen enum

enum Allergen Allergen.php:15

The fourteen allergens a food business must declare in the European Union (Regulation (EU) No 1169/2011, Annex II), in the Annex's order. A plain string enum: stored as is (a JSON list of values on a dish, a varchar), labelled through the "enums" translation domain (allergen.<value>).

#[ORM\Column(type: 'json')] private array $allergens = []; // ['gluten', 'milk'] Allergen::fromList($dish->getAllergens()) {{ ('@enums.allergen.' ~ a.value)|trans }}

case GLUTEN = 'gluten'
case CRUSTACEANS = 'crustaceans'
case EGGS = 'eggs'
case FISH = 'fish'
case PEANUTS = 'peanuts'
case SOYBEANS = 'soybeans'
case MILK = 'milk'
case NUTS = 'nuts'
case CELERY = 'celery'
case MUSTARD = 'mustard'
case SESAME = 'sesame'
case SULPHITES = 'sulphites'
case LUPIN = 'lupin'
case MOLLUSCS = 'molluscs'

Allergen::number()

public function number(): int

Its number in Annex II (1 to 14), as menus often print it.

Allergen::trans()

public function trans(): string

The translation key of its name, in the "enums" domain.

Allergen::fromList()

public static function fromList(iterable $values): array

Stored values back to cases, unknown ones dropped, in the Annex's order.

Allergen::choices()

public static function choices(): array
Returns

translation key => value, for a ChoiceType (choice_translation_domain: 'enums')

CommentState enum

enum CommentState CommentState.php:10

Where a comment is: waiting for the moderator, online, filed as spam, or taken down. A string enum (not omnibase's EnumType) so the column reads plainly in the database and in the admin's filters.

case PENDING = 'pending'
case APPROVED = 'approved'
case SPAM = 'spam'
case TRASH = 'trash'

CommentState::isVisible()

public function isVisible(): bool

ConnectionState class

class ConnectionState extends EnumType implements IconizeInterface ConnectionState.php:8

const FAILED = "CONNECTION_FAILED"
const REQUESTED = "CONNECTION_REQUESTED"
const SUCCEEDED = "CONNECTION_SUCCEEDED"
const CLOSED = "CONNECTION_CLOSED"

ConnectionState::__iconize()

public function __iconize(): ?array

ConnectionState::__iconizeStatic()

public static function __iconizeStatic(): ?array

EntityAction class

class EntityAction extends EnumType implements IconizeInterface EntityAction.php:8

const INSERT = "ACTION_INSERT"
const UPDATE = "ACTION_UPDATE"
const DELETE = "ACTION_DELETE"

EntityAction::__iconize()

public function __iconize(): ?array

EntityAction::__iconizeStatic()

public static function __iconizeStatic(): ?array

LogLevel class

class LogLevel extends EnumType implements IconizeInterface LogLevel.php:8

const INFO = "INFO"
const DEBUG = "DEBUG"
const WARNING = "WARNING"
const CRITICAL = "CRITICAL"

LogLevel::__iconize()

public function __iconize(): ?array

LogLevel::__iconizeStatic()

public static function __iconizeStatic(): ?array

Operation class

class Operation extends EnumType implements IconizeInterface Operation.php:8

const LT = "LESS"
const LTE = "LESS_EQUAL"
const EQ = "EQUAL"
const GTE = "GREATER_EQUAL"
const GT = "GREATER"
const NEQ = "NOTEQUAL"

Operation::__iconize()

public function __iconize(): ?array

Operation::__iconizeStatic()

public static function __iconizeStatic(): ?array

SpamApi class

class SpamApi extends EnumType implements IconizeInterface SpamApi.php:12

the classifier is a gateway of glitchr/omnishield, named by base.guard.classifier (Akismet by default): SpamChecker no longer reads this value

const AKISMET = "AKISMET"

SpamApi::__iconize()

public function __iconize(): ?array

SpamApi::__iconizeStatic()

public static function __iconizeStatic(): ?array

SpamScore class

class SpamScore extends EnumType implements IconizeInterface SpamScore.php:8

const NO_TEXT = "NO_TEXT"
const NOT_SPAM = "NOT_SPAM"
const MAYBE_SPAM = "MAYBE_SPAM"
const BLATANT_SPAM = "BLATANT_SPAM"

SpamScore::__iconize()

public function __iconize(): ?array

SpamScore::__iconizeStatic()

public static function __iconizeStatic(): ?array

SpamScore::__toInt()

public static function __toInt()

ThreadState class

class ThreadState extends EnumType implements IconizeInterface, ColorizeInterface ThreadState.php:9

const DRAFT = "STATE_DRAFT"
const FUTURE = "STATE_FUTURE"
const PUBLISH = "STATE_PUBLISH"
const SECRET = "STATE_PUBLISH_SECRET"
const ARCHIVE = "STATE_PUBLISH_ARCHIVE"
const PASSWORD = "STATE_PUBLISH_PASSWORD"
const DELETE = "STATE_DELETE"

ThreadState::__iconize()

public function __iconize(): ?array

ThreadState::__iconizeStatic()

public static function __iconizeStatic(): ?array

ThreadState::__colorize()

public function __colorize(): ?array

ThreadState::__colorizeStatic()

public static function __colorizeStatic(): ?array

UploadState class

class UploadState extends SetType implements IconizeInterface UploadState.php:8

const UPLOAD_ERROR = "UPLOAD_ERROR"
const UPLOAD_FILESIZE = "UPLOAD_FILESIZE"
const UPLOAD_MIMETYPE = "UPLOAD_MIMETYPE"

UploadState::__iconize()

public function __iconize(): ?array

UploadState::__iconizeStatic()

public static function __iconizeStatic(): ?array

UserGender class

class UserGender extends EnumType implements IconizeInterface UserGender.php:8

const MALE = "MALE"
const FEMALE = "FEMALE"
const HYBRID = "HYBRID"
const GENDERLESS = "GENDERLESS"

UserGender::__iconize()

public function __iconize(): ?array

UserGender::__iconizeStatic()

public static function __iconizeStatic(): ?array

UserRole class

class UserRole extends SetType implements IconizeInterface UserRole.php:9

const EDITOR = "ROLE_EDITOR"
const SUPERADMIN = "ROLE_SUPERADMIN"
const ADMIN = "ROLE_ADMIN"
const USER = "ROLE_USER"

UserRole::__iconize()

public function __iconize(): ?array

UserRole::__iconizeStatic()

public static function __iconizeStatic(): ?array

UserRole::getCrudController()

public static function getCrudController(string $role): ?string

UserState class

class UserState extends SetType implements IconizeInterface UserState.php:8

const NEWCOMER = "USER_NEWCOMER"
const GHOST = "USER_GHOST"
const BANNED = "USER_BANNED"
const LOCKED = "USER_LOCKED"
const KICKED = "USER_KICKED"
const VERIFIED = "USER_VERIFIED"
const APPROVED = "USER_APPROVED"
const ENABLED = "USER_ENABLED"

UserState::__iconize()

public function __iconize(): ?array

UserState::__iconizeStatic()

public static function __iconizeStatic(): ?array

WorkflowState class

class WorkflowState extends EnumType implements IconizeInterface WorkflowState.php:8

const SUBMITTED = "WORKFLOW_SUBMITTED"
const SUSPENDED = "WORKFLOW_SUSPENDED"
const PENDING = "WORKFLOW_PENDING"
const REVIEWING = "WORKFLOW_REVIEWING"
const REJECTED = "WORKFLOW_REJECTED"
const APPROVED = "WORKFLOW_APPROVED"

WorkflowState::__iconize()

public function __iconize(): ?array

WorkflowState::__iconizeStatic()

public static function __iconizeStatic(): ?array

Base\Enum\Quadrant

Quadrant class

class Quadrant extends EnumType implements IconizeInterface Quadrant.php:8

const O = "ORIGIN"
const N = "NORTH"
const E = "EAST"
const S = "SOUTH"
const W = "WEST"

Quadrant::__iconize()

public function __iconize(): ?array

Quadrant::__iconizeStatic()

public static function __iconizeStatic(): ?array

Quadrant::getDefault()

public static function getDefault()

Quadrant::getTheta()

public static function getTheta()

Quadrant::getRotation()

public static function getRotation(string $quadrant): ?float

Quadrant::getRotations()

public static function getRotations(): array

Quadrant::getPosition()

public static function getPosition(string $quadrant): string

Quadrant::getPositions()

public static function getPositions(): array

Quadrant16 class

class Quadrant16 extends Quadrant8 Quadrant16.php:5

const NNE = "NORTH_NORTHEAST"
const ENE = "EAST_NORTHEAST"
const ESE = "EAST_SOUTHEAST"
const SSE = "SOUTH_SOUTHEAST"
const SSW = "SOUTH_SOUTHWEST"
const WSW = "WEST_SOUTHWEST"
const WNW = "WEST_NORTHWEST"
const NNW = "NORTH_NORTHWEST"

Quadrant16::__iconize()

public function __iconize(): ?array

Quadrant16::__iconizeStatic()

public static function __iconizeStatic(): ?array

Quadrant16::getTheta()

public static function getTheta()

Quadrant16::getRotation()

public static function getRotation(string $quadrant): ?float

Quadrant16::getRotations()

public static function getRotations(): array

Quadrant16::getPosition()

public static function getPosition(string $quadrant): string

Quadrant16::getPositions()

public static function getPositions(): array

Quadrant32 class

class Quadrant32 extends Quadrant16 Quadrant32.php:5

const NbW = "NORTH_BY_WEST"
const NbE = "NORTH_BY_EAST"
const NEbN = "NORTHEAST_BY_NORTH"
const NEbE = "NORTHEAST_BY_EAST"
const EbN = "EAST_BY_NORTH"
const EbS = "EAST_BY_SOUTH"
const SEbE = "SOUTHEAST_BY_EAST"
const SEbS = "SOUTHEAST_BY_SOUTH"
const SbE = "SOUTH_BY_EAST"
const SbW = "SOUTH_BY_WEST"
const SWbS = "SOUTHWEST_BY_SOUTH"
const SWbW = "SOUTHWEST_BY_WEST"
const WbS = "WEST_BY_SOUTH"
const WbN = "WEST_BY_NORTH"
const NWbW = "NORTHWEST_BY_WEST"
const NWbN = "NORTHWEST_BY_NORTH"

Quadrant32::__iconize()

public function __iconize(): ?array

Quadrant32::__iconizeStatic()

public static function __iconizeStatic(): ?array

Quadrant32::getTheta()

public static function getTheta()

Quadrant32::getRotation()

public static function getRotation(string $quadrant): ?float

Quadrant32::getRotations()

public static function getRotations(): array

Quadrant32::getPosition()

public static function getPosition(string $quadrant): string

Quadrant32::getPositions()

public static function getPositions(): array

Quadrant8 class

class Quadrant8 extends Quadrant Quadrant8.php:5

const NE = "NORTHEAST"
const SE = "SOUTHEAST"
const SW = "SOUTHWEST"
const NW = "NORTHWEST"

Quadrant8::__iconize()

public function __iconize(): ?array

Quadrant8::__iconizeStatic()

public static function __iconizeStatic(): ?array

Quadrant8::getTheta()

public static function getTheta()

Quadrant8::getRotation()

public static function getRotation(string $quadrant): ?float

Quadrant8::getRotations()

public static function getRotations(): array

Quadrant8::getPosition()

public static function getPosition(string $quadrant): string

Quadrant8::getPositions()

public static function getPositions(): array

Base\Enum\SystemOfUnits

BritishImperialUnits class

class BritishImperialUnits extends EnumType implements IconizeInterface BritishImperialUnits.php:8

BritishImperialUnits::__iconize()

public function __iconize(): ?array

BritishImperialUnits::__iconizeStatic()

public static function __iconizeStatic(): ?array

StandardBaseUnits class

class StandardBaseUnits extends EnumType implements IconizeInterface, ColorizeInterface StandardBaseUnits.php:9

const SECOND = "s"
const METER = "m"
const KILOGRAM = "kg"
const AMPERE = "A"
const KELVIN = "K"
const MOLE = "mol"
const CANDELA = "cd"

StandardBaseUnits::__iconize()

public function __iconize(): ?array

StandardBaseUnits::__iconizeStatic()

public static function __iconizeStatic(): ?array

StandardBaseUnits::__colorize()

public function __colorize(): ?array

StandardBaseUnits::__colorizeStatic()

public static function __colorizeStatic(): ?array

StandardBaseUnits::getBaseUnit()

public static function getBaseUnit(string $name): ?string

StandardBaseUnits::getBaseUnits()

public static function getBaseUnits(): ?array

StandardBaseUnits::getBaseUnitName()

public static function getBaseUnitName(string $name): ?string

StandardBaseUnits::getBaseUnitNames()

public static function getBaseUnitNames(): ?array

StandardBaseUnits::getConstant()

public static function getConstant(string $name): ?string

StandardBaseUnits::getConstants()

public static function getConstants(): ?array

StandardBaseUnits::getConstantSymbol()

public static function getConstantSymbol(string $name): ?string

StandardBaseUnits::getConstantSymbols()

public static function getConstantSymbols(): ?array

StandardBaseUnits::getConstantUnit()

public static function getConstantUnit(string $name): ?string

StandardBaseUnits::getConstantUnits()

public static function getConstantUnits(): ?array

StandardBaseUnits::getConstantName()

public static function getConstantName(string $name): ?string

StandardBaseUnits::getConstantNames()

public static function getConstantNames(): ?array

StandardUnits class

class StandardUnits extends StandardBaseUnits implements IconizeInterface StandardUnits.php:7

StandardUnits::__iconize()

public function __iconize(): ?array

StandardUnits::__iconizeStatic()

public static function __iconizeStatic(): ?array

UnitedStatesCustomaryUnits class

class UnitedStatesCustomaryUnits extends EnumType implements IconizeInterface UnitedStatesCustomaryUnits.php:8

UnitedStatesCustomaryUnits::__iconize()

public function __iconize(): ?array

UnitedStatesCustomaryUnits::__iconizeStatic()

public static function __iconizeStatic(): ?array

Base\Event

SignatureEvent class

final class SignatureEvent extends Event SignatureEvent.php:19

An envelope moved (Base\Service\Signatures): completed, declined, expired, canceled - or a signer signed. The application answers on what it is about: a quote accepted once signed, a lease in force.

#[AsEventListener(event: SignatureEvent::COMPLETED)] public function onSigned(SignatureEvent $event): void { if (Quote::class === $event->getEnvelope()->getSubjectClass()) { ... } }

const COMPLETED = 'base.signature.completed'
const DECLINED = 'base.signature.declined'
const EXPIRED = 'base.signature.expired'
const CANCELED = 'base.signature.canceled'
const SIGNED = 'base.signature.signed'

A signer signed; the others may not have yet.

SignatureEvent::__construct()

public function __construct(readonly Envelope $envelope, readonly ?object $subject = null, readonly ?string $signer = null)

SignatureEvent::getEnvelope()

public function getEnvelope(): Envelope

SignatureEvent::getSubject()

public function getSubject(): ?object

The entity it is about, when it still exists.

SignatureEvent::getSigner()

public function getSigner(): ?string

For SIGNED: the signer's key.

SitemapEvent class

class SitemapEvent extends Event SitemapEvent.php:18

Dispatched while /sitemap.xml is being built, once the routes carrying a Sitemap attribute have been registered.

registerAttributes() can only see routes it can generate on its own, so it skips every route taking a parameter - which is every entity page a site actually wants indexed. The bundle has no way to know what those entities are, and must not: listen to this event from the application and call register() or registerUrl() for the URLs it alone can enumerate.

const BUILD = 'sitemap.build'

SitemapEvent::__construct()

public function __construct(readonly SitemapperInterface $sitemapper, readonly string $hostname)

SitemapEvent::getSitemapper()

public function getSitemapper(): SitemapperInterface

SitemapEvent::getHostname()

public function getHostname(): string

Base\Exception

DemoRefusedException class

class DemoRefusedException extends RuntimeException DemoRefusedException.php:6

The demo environment refuses to start, or demo:reset to run (Base\Demo\DemoGuard).

InvalidMimeTypeException class

class InvalidMimeTypeException extends Exception InvalidMimeTypeException.php:7

InvalidMimeTypeException::getMessageKey()

public function getMessageKey()

{}

InvalidPageException class

class InvalidPageException extends Exception InvalidPageException.php:7

InvalidPageException::getMessageKey()

public function getMessageKey()

{}

InvalidSizeException class

class InvalidSizeException extends Exception InvalidSizeException.php:7

InvalidSizeException::getMessageKey()

public function getMessageKey()

{}

InvalidUuidException class

class InvalidUuidException extends Exception InvalidUuidException.php:7

InvalidUuidException::getMessageKey()

public function getMessageKey()

{}

MissingContractException class

final class MissingContractException extends LogicException MissingContractException.php:10

A contract of the Fondation asked of Base\Contract\Runtime when no framework filled it: loud, where a getter that found no service used to return null in silence (plan "omnibase agnostique", the risk of the static locator).

MissingContractException::for()

public static function for(string $contract): self

MissingContractException::notAn()

public static function notAn(string $contract, object $service): self

MissingDiscriminatorMapException class

class MissingDiscriminatorMapException extends Exception MissingDiscriminatorMapException.php:7

MissingDiscriminatorMapException::getMessageKey()

public function getMessageKey()

{}

MissingDiscriminatorValueException class

class MissingDiscriminatorValueException extends Exception MissingDiscriminatorValueException.php:7

MissingDiscriminatorValueException::getMessageKey()

public function getMessageKey()

{}

MissingLocaleException class

class MissingLocaleException extends Exception MissingLocaleException.php:7

MissingLocaleException::getMessageKey()

public function getMessageKey()

{}

MissingPublicPathException class

class MissingPublicPathException extends Exception MissingPublicPathException.php:7

MissingPublicPathException::getMessageKey()

public function getMessageKey()

{}

NotDeletableException class

class NotDeletableException extends Exception NotDeletableException.php:7

NotDeletableException::getMessageKey()

public function getMessageKey()

{}

NotFoundResourceException class

class NotFoundResourceException extends Exception NotFoundResourceException.php:7

NotFoundResourceException::getMessageKey()

public function getMessageKey()

{}

NotReadableException class

class NotReadableException extends Exception NotReadableException.php:7

NotReadableException::getMessageKey()

public function getMessageKey()

{}

NotWritableException class

class NotWritableException extends Exception NotWritableException.php:7

NotWritableException::getMessageKey()

public function getMessageKey()

{}

OwnerSideException class

class OwnerSideException extends Exception OwnerSideException.php:7

OwnerSideException::getMessageKey()

public function getMessageKey()

{}

SitemapNotFoundException class

class SitemapNotFoundException extends Exception SitemapNotFoundException.php:7

SitemapNotFoundException::getMessageKey()

public function getMessageKey()

{}

TranslationAmbiguityException class

class TranslationAmbiguityException extends Exception TranslationAmbiguityException.php:7

TranslationAmbiguityException::getMessageKey()

public function getMessageKey()

{}

UploaderAmbiguityException class

class UploaderAmbiguityException extends Exception UploaderAmbiguityException.php:7

UploaderAmbiguityException::getMessageKey()

public function getMessageKey()

{}

VaultKeyNotFoundException class

class VaultKeyNotFoundException extends RuntimeException VaultKeyNotFoundException.php:9

A field secured by #[Vault] is about to be stored and the vault has no key pair: the value is refused rather than written in clear.

public readonly string $vault
public readonly string $path

VaultKeyNotFoundException::__construct()

public function __construct(public readonly string $vault, public readonly string $path, ?string $reason = null, ?\Throwable $previous = null)

Base\Field

ArrayField class

class ArrayField extends CollectionField implements FieldInterface ArrayField.php:7

const OPTION_ASSOCIATIVE = 'associative'
const OPTION_LENGTH = 'length'
const OPTION_PATTERN_FIELD_NAME = 'pattern'
const OPTION_PLACEHOLDER = 'placeholder'

ArrayField::new()

public static function new(string $propertyName, $label = null): self

ArrayField::useAssociativeKeys()

public function useAssociativeKeys(bool $use_associative = true): self

ArrayField::setPlaceholder()

public function setPlaceholder(array $placeholder): self

ArrayField::setPatternFieldName()

public function setPatternFieldName(string $fieldName): self

ArrayField::allowAdd()

public function allowAdd(bool $allow = true): self

ArrayField::allowDelete()

public function allowDelete(bool $allow = true): self

ArrayField::setEntryIsComplex()

public function setEntryIsComplex(bool $isComplex): self

Set this option to TRUE if the collection items are complex form types composed of several form fields (EasyAdmin applies a special rendering to make them look better).

ArrayField::setEntryType()

public function setEntryType(string $entryType): self

ArrayField::setEntryOptions()

public function setEntryOptions(array $entryOptions): self

ArrayField::renderExpanded()

public function renderExpanded(bool $renderExpanded = true): self

ArrayField::setLength()

public function setLength(string|int $length): self

AssociationField class

final class AssociationField implements FieldInterface AssociationField.php:9

const OPTION_RENDER_FORMAT = 'renderFormat'
const OPTION_ICONS = 'icons'
const OPTION_CLASS = 'class'
const OPTION_CRUD_CONTROLLER = 'crudControllerFqcn'
const OPTION_DISPLAY_LIMIT = 'displayLimit'
const OPTION_ENTITY_DISPLAY = 'entityDisplay'
const OPTION_ICON_ALIGN = 'iconAlign'
const OPTION_SHOW_FIRST = 'showFirst'
const OPTION_SHOW = 'show'
const NO_SHOW = 0
const SHOW_NAME_ONLY = 1
const SHOW_ICON_ONLY = 2
const SHOW_ALL = 3
const OPTION_ALLOW_ADD = 'allowAdd'
const OPTION_ALLOW_DELETE = 'allowDelete'
const OPTION_LENGTH = 'length'
const OPTION_DOCTRINE_ASSOCIATION_TYPE = 'associationType'

AssociationField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

AssociationField::embed()

public function embed(bool $embed = true): self

The related record's own form, inside the form of the record being edited. By default the back office does that only for what the record owns (one-to-many, one-to-one); a record that exists on its own (many-to-one, many-to-many, a user account) is chosen in a list.

embed(false) asks for the list whatever the association.

AssociationField::justDisplay()

public function justDisplay(): self

AssociationField::autoload()

public function autoload($autoload = true): self

AssociationField::setFields()

public function setFields(array $fields): self

AssociationField::allowAdd()

public function allowAdd(bool $allowAdd = true): self

AssociationField::setTextAlign()

public function setTextAlign(string $textAlign)

AssociationField::setIconAlign()

public function setIconAlign(string $iconAlign)

AssociationField::allowMultipleChoices()

public function allowMultipleChoices(bool $allow = true)

AssociationField::allowDelete()

public function allowDelete(bool $allow = true)

AssociationField::turnHorizontal()

public function turnHorizontal(bool $horizontal)

AssociationField::showVertical()

public function showVertical(bool $vertical = true)

AssociationField::setDisplayLimit()

public function setDisplayLimit(int $limit = 2)

AssociationField::setEntityDisplay()

public function setEntityDisplay(string $mode = FieldValueResolver::DISPLAY_USERNAME)
$mode

one of FieldValueResolver::DISPLAY_*

AssociationField::setIcons()

public function setIcons(array $icons)

AssociationField::setClass()

public function setClass(?string $class = null)

AssociationField::showFirst()

public function showFirst(int $show = self::SHOW_ALL)

AssociationField::show()

public function show(int $show = self::SHOW_ALL)

AssociationField::useHtml()

public function useHtml(bool $useHtml = true)

AssociationField::renderAsCount()

public function renderAsCount()

AssociationField::renderAsText()

public function renderAsText()

AssociationField::setLength()

public function setLength(int $length): self

AssociationField::showEmbedded()

public function showEmbedded($embed = true): self

AssociationField::showEmbeddedRow()

public function showEmbeddedRow($embed = true): self

AssociationField::showCollapsed()

public function showCollapsed($collapsed = true): self

AssociationFileField class

final class AssociationFileField implements FieldInterface AssociationFileField.php:12

const OPTION_SHOWFIRST = "showFirst"
const OPTION_ICONS = 'icons'
const OPTION_RENDER_FORMAT = "renderFormat"
const OPTION_CRUD_CONTROLLER = 'crudControllerFqcn'
const OPTION_DOCTRINE_ASSOCIATION_TYPE = 'associationType'
const OPTION_CLASS = 'class'
const OPTION_DISPLAY_LIMIT = 'displayLimit'
const OPTION_ICON_ALIGN = 'iconAlign'
const OPTION_SHOW_FIRST = 'showFirst'
const OPTION_SHOW = 'show'
const NO_SHOW = 0
const SHOW_NAME_ONLY = 1
const SHOW_ICON_ONLY = 2
const SHOW_ALL = 3

AssociationFileField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

AssociationFileField::setClass()

public function setClass(?string $class = null)

AssociationFileField::renderAsText()

public function renderAsText(): self

AssociationFileField::renderAsCount()

public function renderAsCount(): self

AssociationFileField::renderAsImage()

public function renderAsImage(): self

AssociationFileField::renderAsAvatar()

public function renderAsAvatar(): self

AssociationFileField::setFieldFile()

public function setFieldFile(string $fieldFile): self

AssociationFileField::setFieldData()

public function setFieldData(array|callable $data): self

AssociationFileField::setTextAlign()

public function setTextAlign(string $textAlign)

AssociationFileField::setIconAlign()

public function setIconAlign(string $iconAlign)

AssociationFileField::allowMultipleChoices()

public function allowMultipleChoices(bool $allow = true)

AssociationFileField::allowDelete()

public function allowDelete(bool $allow = true)

AssociationFileField::setMaxSize()

public function setMaxSize(int $filesize)

AssociationFileField::setMaxFiles()

public function setMaxFiles(int $nFiles)

AssociationFileField::setMimeTypes()

public function setMimeTypes(array $mimeTypes)

AssociationFileField::setDisplayLimit()

public function setDisplayLimit(int $limit = 2)

AssociationFileField::setIcons()

public function setIcons(array $icons)

AssociationFileField::showFirst()

public function showFirst(int $show = self::SHOW_ALL)

AssociationFileField::show()

public function show(int $show = self::SHOW_ALL)

AttributeField class

final class AttributeField implements FieldInterface AttributeField.php:8

const OPTION_CLASS = 'class'
const OPTION_CHOICES = 'choices'
const OPTION_ICONS = 'icons'
const OPTION_FILTER = 'filter'
const OPTION_DISPLAY_LIMIT = 'displayLimit'
const OPTION_ICON_ALIGN = 'iconAlign'
const OPTION_RENDER_FORMAT = 'renderFormat'
const OPTION_SHOW_FIRST = 'showFirst'
const OPTION_SHOW = 'show'
const NO_SHOW = 0
const SHOW_NAME_ONLY = 1
const SHOW_ICON_ONLY = 2
const SHOW_ALL = 3
const OPTION_FILTER_CODE = 'filter_code'

AttributeField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

AttributeField::setFilterCode()

public function setFilterCode(?string $filter = null): self

AttributeField::setClass()

public function setClass(?string $class = null)

AttributeField::allowDelete()

public function allowDelete(bool $allowDelete = true): self

AttributeField::allowAdd()

public function allowAdd(bool $allowAdd = true): self

AttributeField::setFields()

public function setFields(array $fields): self

AttributeField::setTextAlign()

public function setTextAlign(string $textAlign)

AttributeField::setIconAlign()

public function setIconAlign(string $iconAlign)

AttributeField::allowMultipleChoices()

public function allowMultipleChoices(bool $allow = true)

AttributeField::allowMultiValues()

public function allowMultiValues(bool $allow = true)

AttributeField::setChoices()

public function setChoices($choiceGenerator)

AttributeField::setFilter()

public function setFilter(...$filter)

AttributeField::setDisplayLimit()

public function setDisplayLimit(int $limit = 2)

AttributeField::setIcons()

public function setIcons(array $icons)

AttributeField::showFirst()

public function showFirst(int $show = self::SHOW_ALL)

AttributeField::show()

public function show(int $show = self::SHOW_ALL)

AttributeField::renderAsCount()

public function renderAsCount()

AudioField class

class AudioField extends FileField implements FieldInterface AudioField.php:9

const OPTION_RENDER_FORMAT = 'renderFormat'

AudioField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

AvatarField class

class AvatarField extends ImageField implements FieldInterface AvatarField.php:9

const OPTION_RENDER_FORMAT = 'renderFormat'

AvatarField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

BooleanField class

final class BooleanField implements FieldInterface BooleanField.php:8

const OPTION_RENDER_AS_SWITCH = 'switch'
const OPTION_CONFIRMATION_MODAL_ON_CHECK = 'confirmation[onCheck]'
const OPTION_CONFIRMATION_MODAL_ON_UNCHECK = 'confirmation[onUncheck]'
const OPTION_TOGGLE_URL = 'toggleUrl'

BooleanField::new()

public static function new(string $propertyName, $label = null): self

BooleanField::renderAsSwitch()

public function renderAsSwitch(bool $isASwitch = true): self

BooleanField::showInline()

public function showInline(bool $inline = true): self

BooleanField::withConfirmation()

public function withConfirmation(bool $onCheck = true, bool $onUncheck = true): self

CodeField class

class CodeField implements FieldInterface CodeField.php:12

A code of known length, one box per character (Base\Field\Type\CodeType).

Reads as plain text on index/detail.

CodeField::new()

public static function new(string $propertyName, $label = null)

CodeField::setLength()

public function setLength(int $length): static

CodeField::setAlphabet()

public function setAlphabet(string $alphabet): static

'alnum' (default), 'digits' or 'alpha'.

CodeField::setUppercase()

public function setUppercase(bool $uppercase = true): static

CollectionField class

class CollectionField implements FieldInterface CollectionField.php:8

const OPTION_ALLOW_ADD = 'allow_add'
const OPTION_ALLOW_OBJECT = 'allow_object'
const OPTION_ALLOW_DELETE = 'allow_delete'
const OPTION_ENTRY_IS_COMPLEX = 'entryIsComplex'
const OPTION_ENTRY_TYPE = 'entry_type'
const OPTION_ENTRY_OPTIONS = 'entry_options'
const OPTION_ENTRY_LABEL = 'entry_label'
const OPTION_RENDER_EXPANDED = 'renderExpanded'
const OPTION_LENGTH = 'length'

CollectionField::new()

public static function new(string $propertyName, $label = null): self

CollectionField::allowAdd()

public function allowAdd(bool $allow = true): self

CollectionField::allowObject()

public function allowObject(bool $allow = true): self

CollectionField::allowDelete()

public function allowDelete(bool $allow = true): self

CollectionField::setEntryType()

public function setEntryType(string $entryType): self

CollectionField::setEntryOptions()

public function setEntryOptions(array $entryOptions): self

CollectionField::setEntryLabel()

public function setEntryLabel($entryLabel): self

CollectionField::renderExpanded()

public function renderExpanded(bool $renderExpanded = true): self

CollectionField::setLength()

public function setLength(int $length): self

CollectionField::showEmbedded()

public function showEmbedded($embed = true): self

CollectionField::showEmbeddedRow()

public function showEmbeddedRow($embed = true): self

CollectionField::showCollapsed()

public function showCollapsed($collapsed = true): self

ColorField class

final class ColorField implements FieldInterface ColorField.php:10

ColorField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

ColorPickerField class

final class ColorPickerField implements FieldInterface ColorPickerField.php:9

ColorPickerField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

CountryField class

class CountryField extends SelectField implements FieldInterface CountryField.php:8

CountryField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

CropperField class

class CropperField implements FieldInterface CropperField.php:9

const OPTION_SHOWFIRST = 'showFirst'
const OPTION_RENDER_FORMAT = 'renderFormat'

CropperField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

CurrencyField class

class CurrencyField extends SelectField implements FieldInterface CurrencyField.php:8

CurrencyField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

DateField class

class DateField implements FieldInterface DateField.php:8

DateField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

DateTimeField class

class DateTimeField implements FieldInterface DateTimeField.php:8

DateTimeField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

DateTimePickerField class

final class DateTimePickerField implements FieldInterface DateTimePickerField.php:9

const FORMAT_FULL = 'full'
const FORMAT_LONG = 'long'
const FORMAT_MEDIUM = 'medium'
const FORMAT_SHORT = 'short'
const FORMAT_NONE = 'none'
const VALID_DATE_FORMATS = [self::FORMAT_NONE, self::FORMAT_SHORT, self::FORMAT_MEDIUM, self::FORMAT_LONG, self::FORMAT_FULL]
const INTL_DATE_PATTERNS = [self::FORMAT_FULL => 'EEEE, MMMM d, y', self::FORMAT_LONG => 'MMMM d, y', self::FORMAT_MEDIUM => 'MMM d, y', self::FORMAT_SHORT => 'M/d/yy', self::FORMAT_NO…
const INTL_TIME_PATTERNS = [self::FORMAT_FULL => 'h:mm:ss a zzzz', self::FORMAT_LONG => 'h:mm:ss a z', self::FORMAT_MEDIUM => 'h:mm:ss a', self::FORMAT_SHORT => 'h:mm a', self::FORMAT_…
const WIDGET_NATIVE = 'native'
const WIDGET_CHOICE = 'choice'
const WIDGET_TEXT = 'text'
const OPTION_DATE_PATTERN = 'datePattern'
const OPTION_TIME_PATTERN = 'timePattern'
const OPTION_TIMEZONE = 'timezone'
const OPTION_WIDGET = 'widget'
const OPTION_DEFAULT = 'default_value'

DateTimePickerField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

DateTimePickerField::setDebug()

public function setDebug(bool $debug = true): self

DateTimePickerField::setTimezone()

public function setTimezone(string $timezoneId): self
$timezoneId

A valid PHP timezone ID

DateTimePickerField::setFormat()

public function setFormat(string $dateFormatOrPattern, string $timeFormat = self::FORMAT_NONE): self
$dateFormatOrPattern

A format name ('none', 'short', 'medium', 'long', 'full') or a valid ICU Datetime Pattern (see http://userguide.icu-project.org/formatparse/datetime)

$timeFormat

A format name ('none', 'short', 'medium', 'long', 'full')

DateTimePickerField::renderAsNativeWidget()

public function renderAsNativeWidget(bool $asNative = true): self

Uses native HTML5 widgets when rendering this field in forms.

DateTimePickerField::renderAsChoice()

public function renderAsChoice(bool $asChoice = true): self

Uses <select> lists when rendering this field in forms.

DateTimePickerField::renderAsText()

public function renderAsText(bool $asText = true): self

Uses <input type="text"> elements when rendering this field in forms.

DateTimePickerField::setDefault()

public function setDefault(?\DateTime $datetime = null)

DateTimePickerField::now()

public function now()

DiscriminatorField class

class DiscriminatorField extends SelectField implements FieldInterface DiscriminatorField.php:9

const OPTION_DISCRIMINATOR_AUTOLOAD = 'discriminatorAutoload'
const OPTION_SHOW_COLUMN = 'discriminatorColumn'
const OPTION_SHOW_INLINE = 'discriminatorInline'
const OPTION_SHOW_LEAF = 'discriminatorLeaf'

DiscriminatorField::new()

public static function new(string $propertyName = "id", TranslatableInterface|string|bool|null $label = null): self

DiscriminatorField::showColumnLabel()

public function showColumnLabel(bool $show = true): self

DiscriminatorField::showInline()

public function showInline(bool $inline = true): self

DiscriminatorField::showLeaf()

public function showLeaf(bool $show = true): self

EditorField class

final class EditorField implements FieldInterface EditorField.php:9

EditorField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

EmailField class

class EmailField implements FieldInterface EmailField.php:8

const OPTION_ICON_CUSTOM = 'icon'
const OPTION_SHOW = 'show'
const SHOW_ICON = 'icon'
const SHOW_EMAIL = 'email'
const SHOW_ALL = 'all'

EmailField::setTargetFieldName()

public function setTargetFieldName(string $show): self

EmailField::new()

public static function new(string $propertyName, $label = null): self

EmailField::setCustomIcon()

public function setCustomIcon(string $faIcon)

EmailField::renderIcon()

public function renderIcon()

EmailField::renderAll()

public function renderAll()

EmailField::renderText()

public function renderText()

EmojiPickerField class

final class EmojiPickerField implements FieldInterface EmojiPickerField.php:10

EmojiPickerField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

FieldDescriptor class

final class FieldDescriptor FieldDescriptor.php:15

Single mutable descriptor carried by every field: what property it maps, which Symfony FormType renders it, where it is displayed, and how.

This is the EasyCorp-free replacement for both FieldDto and its KeyValueStore bags: one class, plain arrays, no builder/DTO split.

const PAGE_INDEX = 'index'
const PAGE_DETAIL = 'detail'
const PAGE_EDIT = 'edit'
const PAGE_NEW = 'new'
const ALL_PAGES = [self::PAGE_INDEX, self::PAGE_DETAIL, self::PAGE_EDIT, self::PAGE_NEW]
const FORM_PAGES = [self::PAGE_EDIT, self::PAGE_NEW]

FieldDescriptor::__construct()

public function __construct()

FieldDescriptor::getUniqueId()

public function getUniqueId(): string

FieldDescriptor::setUniqueId()

public function setUniqueId(string $uniqueId): static

FieldDescriptor::getFieldFqcn()

public function getFieldFqcn(): ?string

FieldDescriptor::setFieldFqcn()

public function setFieldFqcn(?string $fieldFqcn): static

FieldDescriptor::getProperty()

public function getProperty(): ?string

FieldDescriptor::setProperty()

public function setProperty(?string $propertyName): static

FieldDescriptor::getPropertySuffix()

public function getPropertySuffix(): ?string

FieldDescriptor::setPropertySuffix()

public function setPropertySuffix(?string $propertyNameSuffix): static

FieldDescriptor::getPropertyWithSuffix()

public function getPropertyWithSuffix(): ?string

FieldDescriptor::getValue()

public function getValue(): mixed

FieldDescriptor::setValue()

public function setValue(mixed $value): static

FieldDescriptor::getFormattedValue()

public function getFormattedValue(): mixed

FieldDescriptor::setFormattedValue()

public function setFormattedValue(mixed $formattedValue): static

FieldDescriptor::getFormatValueCallable()

public function getFormatValueCallable(): ?callable

FieldDescriptor::setFormatValueCallable()

public function setFormatValueCallable(?callable $callable): static

FieldDescriptor::getLabel()

public function getLabel(): TranslatableInterface|string|bool|null

FieldDescriptor::setLabel()

public function setLabel(TranslatableInterface|string|bool|null $label): static

FieldDescriptor::getHelp()

public function getHelp(): TranslatableInterface|string|null

FieldDescriptor::setHelp()

public function setHelp(TranslatableInterface|string|null $help): static

FieldDescriptor::getTranslationParameters()

public function getTranslationParameters(): array

FieldDescriptor::setTranslationParameters()

public function setTranslationParameters(array $translationParameters): static

FieldDescriptor::getFormType()

public function getFormType(): ?string

FieldDescriptor::setFormType()

public function setFormType(?string $formTypeFqcn): static

FieldDescriptor::getFormTypeOptions()

public function getFormTypeOptions(): array

FieldDescriptor::setFormTypeOptions()

public function setFormTypeOptions(array $formTypeOptions): static

FieldDescriptor::getFormTypeOption()

public function getFormTypeOption(string $optionName, mixed $default = null): mixed

Option names support "." paths, e.g. "attr.autofocus".

FieldDescriptor::setFormTypeOption()

public function setFormTypeOption(string $optionName, mixed $optionValue): static

FieldDescriptor::setFormTypeOptionIfNotSet()

public function setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue): static

FieldDescriptor::isSortable()

public function isSortable(): ?bool

FieldDescriptor::setSortable()

public function setSortable(?bool $sortable): static

FieldDescriptor::isVirtual()

public function isVirtual(): ?bool

FieldDescriptor::setVirtual()

public function setVirtual(?bool $virtual): static

FieldDescriptor::isDisabled()

public function isDisabled(): ?bool

FieldDescriptor::setDisabled()

public function setDisabled(?bool $disabled): static

FieldDescriptor::isRequired()

public function isRequired(): ?bool

FieldDescriptor::setRequired()

public function setRequired(?bool $required): static

FieldDescriptor::getEmptyData()

public function getEmptyData(): mixed

FieldDescriptor::setEmptyData()

public function setEmptyData(mixed $emptyData): static

FieldDescriptor::getPermission()

public function getPermission(): string|Expression|null

FieldDescriptor::setPermission()

public function setPermission(string|Expression|null $permission): static

FieldDescriptor::getTextAlign()

public function getTextAlign(): ?string

FieldDescriptor::setTextAlign()

public function setTextAlign(?string $textAlign): static

FieldDescriptor::getCssClass()

public function getCssClass(): string

FieldDescriptor::setCssClass()

public function setCssClass(string $cssClass): static

FieldDescriptor::addCssClass()

public function addCssClass(string $cssClass): static

FieldDescriptor::getHtmlAttributes()

public function getHtmlAttributes(): array

FieldDescriptor::setHtmlAttributes()

public function setHtmlAttributes(array $htmlAttributes): static

FieldDescriptor::setHtmlAttribute()

public function setHtmlAttribute(string $attributeName, mixed $attributeValue): static

FieldDescriptor::getColumns()

public function getColumns(): null|int|string

FieldDescriptor::setColumns()

public function setColumns(null|int|string $columns): static

FieldDescriptor::getDefaultColumns()

public function getDefaultColumns(): null|int|string

FieldDescriptor::setDefaultColumns()

public function setDefaultColumns(null|int|string $defaultColumns): static

FieldDescriptor::getTemplateName()

public function getTemplateName(): ?string

FieldDescriptor::setTemplateName()

public function setTemplateName(?string $templateName): static

FieldDescriptor::getTemplatePath()

public function getTemplatePath(): ?string

FieldDescriptor::setTemplatePath()

public function setTemplatePath(?string $templatePath): static

FieldDescriptor::getFormThemes()

public function getFormThemes(): array

FieldDescriptor::addFormTheme()

public function addFormTheme(string ...$formThemePaths): static

FieldDescriptor::getCssAssets()

public function getCssAssets(): array

FieldDescriptor::addCssAsset()

public function addCssAsset(string $asset): static

FieldDescriptor::getJsAssets()

public function getJsAssets(): array

FieldDescriptor::addJsAsset()

public function addJsAsset(string $asset): static

FieldDescriptor::getWebpackEncoreEntries()

public function getWebpackEncoreEntries(): array

FieldDescriptor::addWebpackEncoreEntry()

public function addWebpackEncoreEntry(string $entry): static

FieldDescriptor::getHeadContents()

public function getHeadContents(): array

FieldDescriptor::addHtmlContentToHead()

public function addHtmlContentToHead(string $content): static

FieldDescriptor::getBodyContents()

public function getBodyContents(): array

FieldDescriptor::addHtmlContentToBody()

public function addHtmlContentToBody(string $content): static

FieldDescriptor::getCustomOptions()

public function getCustomOptions(): array

FieldDescriptor::setCustomOptions()

public function setCustomOptions(array $customOptions): static

FieldDescriptor::getCustomOption()

public function getCustomOption(string $optionName, mixed $default = null): mixed

FieldDescriptor::setCustomOption()

public function setCustomOption(string $optionName, mixed $optionValue): static

FieldDescriptor::getDoctrineMetadata()

public function getDoctrineMetadata(): array

FieldDescriptor::setDoctrineMetadata()

public function setDoctrineMetadata(array $doctrineMetadata): static

FieldDescriptor::getDisplayedOn()

public function getDisplayedOn(): array

FieldDescriptor::setDisplayedOn()

public function setDisplayedOn(array $pages): static

FieldDescriptor::displayOn()

public function displayOn(string ...$pages): static

FieldDescriptor::hideOn()

public function hideOn(string ...$pages): static

FieldDescriptor::isDisplayedOn()

public function isDisplayedOn(string $page): bool

FieldInterface interface

interface FieldInterface FieldInterface.php:7

FieldInterface::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null)

FieldInterface::getAsDto()

public function getAsDto(): FieldDescriptor

FieldInterface::__clone()

public function __clone(): void

FieldTrait trait

trait FieldTrait FieldTrait.php:15

Fluent configuration surface shared by every field.

Method names intentionally match the ones CRUD controllers already call, so porting a controller does not require rewriting configureFields(). All state lives in a single FieldDescriptor (see getAsDto()).

FieldTrait::__clone()

public function __clone(): void

FieldTrait::setFieldFqcn()

public function setFieldFqcn(string $fieldFqcn): static

FieldTrait::setProperty()

public function setProperty(string $propertyName): static

FieldTrait::setPropertySuffix()

public function setPropertySuffix(string $propertyNameSuffix): static

FieldTrait::setLabel()

public function setLabel(TranslatableInterface|string|bool|null $label): static

FieldTrait::setValue()

public function setValue(mixed $value): static

FieldTrait::setFormattedValue()

public function setFormattedValue(mixed $value): static

FieldTrait::formatValue()

public function formatValue(?callable $callable): static

FieldTrait::setVirtual()

public function setVirtual(bool $isVirtual): static

FieldTrait::setDisabled()

public function setDisabled(bool $disabled = true): static

FieldTrait::setRequired()

public function setRequired(bool $isRequired): static

FieldTrait::setEmptyData()

public function setEmptyData(mixed $emptyData = null): static

FieldTrait::setFormType()

public function setFormType(string $formTypeFqcn): static

FieldTrait::setFormTypeOptions()

public function setFormTypeOptions(array $options): static

FieldTrait::setFormTypeOption()

public function setFormTypeOption(string $optionName, mixed $optionValue): static

FieldTrait::setFormTypeOptionIfNotSet()

public function setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue): static

FieldTrait::setHtmlAttribute()

public function setHtmlAttribute(string $attributeName, mixed $attributeValue): static

FieldTrait::setHtmlAttributes()

public function setHtmlAttributes(array $attributes): static

FieldTrait::setSortable()

public function setSortable(bool $isSortable): static

FieldTrait::setPermission()

public function setPermission(string|Expression $permission): static

FieldTrait::setTextAlign()

public function setTextAlign(string $textAlign): static
$textAlign

one of "left", "center", "right"

FieldTrait::setHelp()

public function setHelp(TranslatableInterface|string $help): static

FieldTrait::addCssClass()

public function addCssClass(string $cssClass): static

FieldTrait::setCssClass()

public function setCssClass(string $cssClass): static

FieldTrait::setTranslationParameters()

public function setTranslationParameters(array $parameters): static

FieldTrait::setTemplateName()

public function setTemplateName(string $name): static

FieldTrait::setTemplatePath()

public function setTemplatePath(string $path): static

FieldTrait::addFormTheme()

public function addFormTheme(string ...$formThemePaths): static

FieldTrait::addWebpackEncoreEntries()

public function addWebpackEncoreEntries(string ...$entryNames): static

FieldTrait::addCssFiles()

public function addCssFiles(string ...$paths): static

FieldTrait::addJsFiles()

public function addJsFiles(string ...$paths): static

FieldTrait::addHtmlContentsToHead()

public function addHtmlContentsToHead(string ...$contents): static

FieldTrait::addHtmlContentsToBody()

public function addHtmlContentsToBody(string ...$contents): static

FieldTrait::setCustomOption()

public function setCustomOption(string $optionName, mixed $optionValue): static

FieldTrait::setCustomOptions()

public function setCustomOptions(array $options): static

FieldTrait::hideOnDetail()

public function hideOnDetail(): static

FieldTrait::hideOnForm()

public function hideOnForm(): static

FieldTrait::hideWhenCreating()

public function hideWhenCreating(): static

FieldTrait::hideWhenUpdating()

public function hideWhenUpdating(): static

FieldTrait::hideOnIndex()

public function hideOnIndex(): static

FieldTrait::showOnIndex()

public function showOnIndex(bool $show = true): static

FieldTrait::showOnDetail()

public function showOnDetail(bool $show = true): static

FieldTrait::onlyOnDetail()

public function onlyOnDetail(): static

FieldTrait::onlyOnForms()

public function onlyOnForms(): static

FieldTrait::onlyOnIndex()

public function onlyOnIndex(): static

FieldTrait::onlyWhenCreating()

public function onlyWhenCreating(): static

FieldTrait::onlyWhenUpdating()

public function onlyWhenUpdating(): static

FieldTrait::setColumns()

public function setColumns(int|string $cols): static
$cols

an integer 1..12 or a responsive spec like "col-md-6 col-xxl-3"

FieldTrait::setDefaultColumns()

public function setDefaultColumns(int|string $cols): static

FieldTrait::getAsDto()

public function getAsDto(): FieldDescriptor

FieldValueResolver class

class FieldValueResolver FieldValueResolver.php:16

Resolves a field's raw and formatted value for one entity instance: property access, then the field's formatValue() callable if any.

Returns a clone so one descriptor list can serve every row of an index.

const DISPLAY_USERNAME = 'username'

How a related entity should be labelled in a list/detail cell.

formatValue() above always yields __toString(), which for a User is the username - fine as a default, useless when the usernames are short handles ("NN") and the reader wants a person's actual name or just their face. Fields opt into one of these via setEntityDisplay(); see SelectField/AssociationField.

const DISPLAY_FULLNAME = 'fullname'
const DISPLAY_AVATAR = 'avatar'
const DEFAULT_IDENTIFIER_FIELDS = ['slug', 'uuid']

Fields that may stand in for the primary key in an admin URL when nothing is configured, most readable first.

Deliberately does NOT include "username": a username is an APPLICATION-level idea (an app may or may not have one, and may or may not want it in URLs), whereas the base app's User is identified by its id. An app that wants it opts in per entity:

admin:
    url_identifier:
        entities:
            App\Entity\User: ['username']

Set fields: [] to switch the whole admin back to plain numeric ids - the escape hatch for slugs long enough to make URLs unwieldy.

FieldValueResolver::__construct()

public function __construct(?PropertyAccessorInterface $accessor = null, ?array $identifierFields = null, array $identifierFieldsByEntity = [], bool $lowercaseIdentifiers = false, protected ?ManagerRegistry $doctrine = null)
$identifierFields

null = DEFAULT_IDENTIFIER_FIELDS

$identifierFieldsByEntity

per-class overrides

$lowercaseIdentifiers

see $this->lowercaseIdentifiers

$doctrine

says which identifier fields are columns, see isStoredField()

FieldValueResolver::resolve()

public function resolve(FieldDescriptor $descriptor, object $entity): FieldDescriptor

FieldValueResolver::formatValue()

public function formatValue(mixed $value): mixed

Default display formatting, done here rather than in Twig: templates cannot reliably type-check values behind entity magic methods (BaseTrait's __get makes any attribute look "defined"). Public so templates that must format individual items of a raw collection themselves (a SelectField's index badge, iterating real entity objects one by one) can reuse the exact same logic via the admin_display() twig function instead of duplicating it.

FieldValueResolver::entityLabel()

public function entityLabel(mixed $entity, string $mode = self::DISPLAY_USERNAME): mixed

The text to show for a related entity under the requested mode.

Every mode degrades rather than blanking the cell: an entity with no getFullname() (or one returning an empty string, which User does when both name parts are unset) falls back to the __toString() label, so switching a field to 'fullname' can never turn a populated column into empty cells. AVATAR returns the same text too - the templates use it for the alt/title and as the visible fallback when the entity has no avatar image.

FieldValueResolver::identifierFieldsFor()

public function identifierFieldsFor(object|string $entity): array

The identifier fields that apply to one entity class, honouring any per-class override. Shared with AbstractCrudController::findEntity(), which resolves a URL segment back to an entity by walking this same list - asking ONE method is what guarantees that every identifier the admin generates is one the admin can also resolve, under whatever configuration is in force.

An override configured on a PARENT class covers its subclasses (and therefore Doctrine's runtime proxies, which extend the entity), so configuring App\Entity\User does not have to be repeated for every discriminator subtype.

FieldValueResolver::resolvableIdentifierFieldsFor()

public function resolvableIdentifierFieldsFor(object|string $entity): array

Every field a URL segment may be RESOLVED from - deliberately wider than identifierFieldsFor(), which says only what we GENERATE.

Config decides what the admin emits; it must not decide what the admin still understands. Otherwise switching fields: [] to shorten URLs would 404 every slug link already sitting in someone's bookmarks, history or an email - a silent breakage of old links, which is exactly what the id fallback was designed to avoid.

The configured fields come FIRST so they win a tie; the rest are accepted afterwards. Candidates the entity does not actually map are skipped by the caller, so a wide list costs no extra queries.

FieldValueResolver::entityIdentifier()

public function entityIdentifier(object $entity): string|int|null

The identifier to put in an admin URL for this entity: the first populated configured field, else the numeric id.

A readable URL is the point ("/admin/articles/petit-cours-..." rather than "/admin/articles/1147", "/admin/users/marki" rather than "/admin/users/14"), and a slug is also stable across environments in a way a database id is not. The id is the last resort and remains valid everywhere, since resolution accepts all of these.

Two kinds of candidate are rejected rather than trusted:

  • Empty/whitespace-only, which would generate "/admin/articles/" and silently point at the collection instead of the record.
  • All-digits, which is genuinely AMBIGUOUS: resolution reads a numeric segment as a primary key first, so a user literally named "12345" (the username validator allows digits-only) would link to whichever account holds id 12345 - someone else's. Falling through to the real id keeps the URL unambiguous by construction.

And a field the entity does not STORE is not a candidate at all: a getSlug() computed from the title (no column behind it) reads well but cannot be looked up again - the address it gave answered 404. Such an entity is linked by its id (isStoredField()).

FieldValueResolver::entityAvatar()

public function entityAvatar(mixed $entity): ?string

The avatar URL for a related entity, or null when it has none (the templates then fall back to the label). getFormattedAvatar() is the app-side accessor that already resolves the stored file to a usable URL; getAvatar() is the raw column and only worth using when the formatted one isn't there.

FieldValueResolver::entityImage()

public function entityImage(mixed $entity): ?string

The raw STORAGE PATH of an entity's image, or null.

Deliberately the source and not a URL: callers hand it to the media pipeline (|thumbnail(w, h)), which is what resizes, caches and obfuscates. Handing them a built URL would make the pipeline fetch a full-size original just to draw a 96px chip - the exact cost this exists to avoid.

Only an ImageInterface counts. An entity whose getAvatar() already returns a rendered URL is a different contract (entityAvatar()), and treating its return value as a path would silently produce broken thumbnails.

FieldValueResolver::resolveAll()

public function resolveAll(iterable $fields, object $entity, ?string $page = null): array

FileField class

class FileField implements FieldInterface FileField.php:10

const OPTION_RENDER_FORMAT = 'renderFormat'
const OPTION_SHOWFIRST = 'showFirst'
const OPTION_ALLOW_URL = 'allow_url'
const OPTION_ALLOW_REUPLOAD = 'allow_reupload'
const OPTION_PREFERRED_DOWNLOAD_NAME = 'preferredDownloadName'

FileField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

FileField::setMaxSize()

public function setMaxSize(int $filesize)

FileField::setMaxFiles()

public function setMaxFiles(int $nFiles)

FileField::setMimeTypes()

public function setMimeTypes(array $mimeTypes)

FileField::allowDelete()

public function allowDelete(bool $allowDelete = true): self

FileField::downloadable()

public function downloadable(bool $allowDownload = true): self

FileField::noReupload()

public function noReupload(bool $noReupload = true): self

FileField::setPreferredDownloadName()

public function setPreferredDownloadName(string $targetName): self

FileField::setMultipleFiles()

public function setMultipleFiles(bool $multipleFiles = true): self

FileField::renderAsText()

public function renderAsText(): self

FileField::renderAsCount()

public function renderAsCount(): self

FileField::renderAsImage()

public function renderAsImage(): self

FileField::showFirst()

public function showFirst(bool $show = true): self

ForexField class

class ForexField extends SelectField implements FieldInterface ForexField.php:9

const OPTION_TARGET_FIELD_NAME = 'targetFieldName'

ForexField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

GenderField class

class GenderField extends SelectField implements FieldInterface GenderField.php:9

GenderField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

IconField class

class IconField extends SelectField implements FieldInterface IconField.php:10

const OPTION_TARGET_FIELD_NAME = 'targetFieldName'

IconField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

IconField::setTargetColor()

public function setTargetColor(string $fieldName)

IconField::setAdapter()

public function setAdapter(IconAdapterInterface|string $objectOrClass)

IdField class

final class IdField implements FieldInterface IdField.php:8

const OPTION_MAX_LENGTH = 'maxLength'
const OPTION_IMPERSONATE = 'impersonate'

IdField::new()

public static function new(string $propertyName = 'id', TranslatableInterface|string|bool|null $label = null): self

IdField::setMaxLength()

public function setMaxLength(int $length): self

Set maxLength to -1 to define an unlimited max length.

IdField::enableImpersonation()

public function enableImpersonation()

IdField::disableImpersonation()

public function disableImpersonation()
public function enableLink()
public function disableLink()

ImageField class

class ImageField extends FileField implements FieldInterface ImageField.php:10

const OPTION_RENDER_FORMAT = "renderFormat"

ImageField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

ImageField::setCropper()

public function setCropper(null|array|bool $cropper = true)

IntegerField class

class IntegerField implements FieldInterface IntegerField.php:8

IntegerField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

LocaleField class

class LocaleField implements FieldInterface LocaleField.php:11

const OPTION_SHOW_CODE = 'showCode'
const OPTION_SHOW_NAME = 'showName'
const OPTION_LOCALE_CODES_TO_KEEP = 'localeCodesToKeep'
const OPTION_LOCALE_CODES_TO_REMOVE = 'localeCodesToRemove'

LocaleField::new()

public static function new(string $propertyName, $label = null)

LocaleField::showCode()

public function showCode(bool $isShown = true)

LocaleField::showName()

public function showName(bool $isShown = true)

LocaleField::includeOnly()

public function includeOnly(array $countryCodesToKeep)

Restricts the list of locales shown by the field to the given list of locale codes.

e.g. ->includeOnly(['de', 'en', 'fr']).

LocaleField::remove()

public function remove(array $countryCodesToRemove)

Removes the given list of locale codes from the locales displayed by the field.

e.g. ->remove(['de', 'fr']).

MoneyField class

final class MoneyField implements FieldInterface MoneyField.php:9

const OPTION_CURRENCY = 'currency'
const OPTION_SWAP = 'use_swap'
const OPTION_CURRENCY_PROPERTY_PATH = 'currencyPropertyPath'
const OPTION_NUM_DECIMALS = 'numDecimals'
const OPTION_STORED_AS_CENTS = 'storedAsCents'

MoneyField::new()

public static function new(string $propertyName, $label = null): self

MoneyField::useSwap()

public function useSwap(bool $swap = true): self

MoneyField::setCurrency()

public function setCurrency(string $currencyCode): self

MoneyField::setCurrencyPropertyPath()

public function setCurrencyPropertyPath(string $propertyPath): self

MoneyField::showCurrencyCode()

public function showCurrencyCode(bool $show = true): self

MoneyField::setCurrencyList()

public function setCurrencyList(array $moneyList = []): self

MoneyField::setNumDecimals()

public function setNumDecimals(int $num): self

MoneyField::setStoredAsCents()

public function setStoredAsCents(bool $asCents = true): self

NumberField class

final class NumberField implements FieldInterface NumberField.php:7

const OPTION_MINIMUM = 'min'
const OPTION_MAXIMUM = 'max'
const OPTION_SUFFIX = 'suffix'
const OPTION_PREFIX = 'prefix'
const OPTION_DIVISOR = 'divisor'
const OPTION_NUM_DECIMALS = 'numDecimals'
const OPTION_ROUNDING_MODE = 'roundingMode'
const OPTION_STORED_AS_STRING = 'storedAsString'
const OPTION_THROTTLE = 'throttle'

NumberField::new()

public static function new(string $propertyName, $label = null): self

NumberField::percentage()

public function percentage(int $min, int $max): self

NumberField::setDivisor()

public function setDivisor(float $num): self

NumberField::setThrottle()

public function setThrottle(int $num): self

NumberField::setNumDecimals()

public function setNumDecimals(int $num): self

NumberField::setMinimum()

public function setMinimum(int $num): self

NumberField::setMaximum()

public function setMaximum(int $num): self

NumberField::setSuffix()

public function setSuffix(string $suffix): self

NumberField::setPrefix()

public function setPrefix(int $prefix): self

NumberField::step()

public function step(float $step)

NumberField::stepUp()

public function stepUp(float $stepUp)

NumberField::stepDown()

public function stepDown(float $stepDown)

NumberField::throttle()

public function throttle(float $throttle)

NumberField::throttleUp()

public function throttleUp(float $throttleUp)

NumberField::throttleDown()

public function throttleDown(float $throttleDown)

NumberField::setRoundingMode()

public function setRoundingMode(int $mode): self

NumberField::setStoredAsString()

public function setStoredAsString(bool $asString = true): self

PasswordField class

final class PasswordField implements FieldInterface PasswordField.php:8

PasswordField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

PasswordField::setRevealer()

public function setRevealer(bool $revealer): self

PasswordField::secure()

public function secure(bool $secure = true): self

PasswordField::setRepeater()

public function setRepeater(bool $repeater): self

PasswordField::showInline()

public function showInline(bool $inline = true): self

QuadrantField class

final class QuadrantField implements FieldInterface QuadrantField.php:9

const OPTION_RENDER_FORMAT = 'renderFormat'
const OPTION_ICON_ALIGN = 'iconAlign'
const OPTION_SHOW_FIRST = 'showFirst'
const OPTION_SHOW = 'show'
const NO_SHOW = 0
const SHOW_NAME_ONLY = 1
const SHOW_ICON_ONLY = 2
const SHOW_ALL = 3

QuadrantField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

QuadrantField::setTextAlign()

public function setTextAlign(string $textAlign)

QuadrantField::setIconAlign()

public function setIconAlign(string $iconAlign)

QuadrantField::show()

public function show(int $show = self::SHOW_ALL)

QuadrantField::showIconOnly()

public function showIconOnly()

QuadrantField::showNameOnly()

public function showNameOnly()

RoleField class

class RoleField extends SelectField RoleField.php:9

RoleField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

RouteField class

class RouteField extends SelectField implements FieldInterface RouteField.php:9

RouteField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

SelectField class

class SelectField implements FieldInterface SelectField.php:9

const OPTION_CONFIRMATION_MODAL_ON_CHECK = 'confirmationModalOnCheck'
const OPTION_CONFIRMATION_MODAL_ON_UNCHECK = 'confirmationModalOnUncheck'
const OPTION_AUTOCOMPLETE = 'autocomplete'
const OPTION_DEFAULT_CHOICE = 'default_choice'
const OPTION_CLASS = 'class'
const OPTION_CHOICES = 'choices'
const OPTION_ENUM_CLASS = 'enumClass'
const OPTION_ICONS = 'icons'
const OPTION_FILTER = 'choice_filter'
const OPTION_DISPLAY_LIMIT = 'displayLimit'
const OPTION_ENTITY_DISPLAY = 'entityDisplay'

How a related entity is labelled in the cell - one of FieldValueResolver::DISPLAY_* (username | fullname | avatar). Shares the option NAME with AssociationField on purpose: the two render through different templates but the choice means the same thing, and a single name keeps the templates and any future field consistent.

const OPTION_CRUD_CONTROLLER = 'crudControllerFqcn'

Makes each rendered entity a link to its own CRUD detail page. Same option name as AssociationField::OPTION_CRUD_CONTROLLER for the same reason - a SelectField over a real association (Comment::owners) had no way to be clickable at all before this.

const OPTION_ICON_ALIGN = 'iconAlign'
const OPTION_RENDER_FORMAT = 'renderFormat'
const OPTION_SHOW_FIRST = 'showFirst'
const OPTION_USE_COLOR = 'useColor'
const OPTION_SHOW = 'show'
const NO_SHOW = 0
const SHOW_NAME_ONLY = 1
const SHOW_ICON_ONLY = 2
const SHOW_ALL = 3

SelectField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

SelectField::useColor()

public function useColor(bool $useColor = true)

SelectField::useHtml()

public function useHtml(bool $useHtml = true)

SelectField::useAvatar()

public function useAvatar(bool $avatar = true)

Show entries as profile pictures rather than as their __iconize() icon, wherever one is available.

Off by default (see SelectType's avatar option): that icon carries meaning - for a User it is their role - and a photo silently replaces it only for the people who happen to have uploaded one. Worth turning on where telling individuals apart is the point, such as an article's authors.

SelectField::autocomplete()

public function autocomplete(string $endpoint)

SelectField::setTextAlign()

public function setTextAlign(string $textAlign)

SelectField::setIconAlign()

public function setIconAlign(string $iconAlign)
public function allowCrudLink(bool $allow = true)

SelectField::allowMultipleChoices()

public function allowMultipleChoices(bool $allow = true)

SelectField::allowDelete()

public function allowDelete(bool $allow = true)

SelectField::allowSearch()

public function allowSearch(bool $allow = true)

SelectField::turnHorizontal()

public function turnHorizontal(bool $horizontal)

SelectField::showVertical()

public function showVertical(bool $vertical = true)

SelectField::allowTags()

public function allowTags(bool|array $tokenSeparators = [])

SelectField::setChoices()

public function setChoices($choiceGenerator)

SelectField::setEntityDisplay()

public function setEntityDisplay(string $mode = FieldValueResolver::DISPLAY_USERNAME)
$mode

one of FieldValueResolver::DISPLAY_*

SelectField::setCrudController()

public function setCrudController(string $crudControllerFqcn)

SelectField::setEnumClass()

public function setEnumClass(string $class)

SelectField::setAutoFilter()

public function setAutoFilter()

SelectField::setFilter()

public function setFilter(...$filter)

SelectField::setDisplayLimit()

public function setDisplayLimit(int $limit = 2)

SelectField::setIcons()

public function setIcons(array $icons)

SelectField::setClass()

public function setClass(?string $class = null)

SelectField::showFirst()

public function showFirst(int $show = self::SHOW_ALL)

SelectField::show()

public function show(int $show = self::SHOW_ALL)

SelectField::showIconOnly()

public function showIconOnly()

SelectField::showNameOnly()

public function showNameOnly()

SelectField::renderAsCount()

public function renderAsCount()

SelectField::renderAsText()

public function renderAsText()

SelectField::setDefault()

public function setDefault($defaultChoices)

SelectField::withConfirmation()

public function withConfirmation(bool $onCheck = true, bool $onUncheck = true): self

SlugField class

final class SlugField implements FieldInterface SlugField.php:8

const OPTION_LEADING_HASH = 'leadingHash'
const OPTION_TARGET_FIELD_NAME = 'targetFieldName'
const OPTION_UNLOCK_CONFIRMATION_MESSAGE = 'unlockConfirmationMessage'

SlugField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

SlugField::setTargetFieldName()

public function setTargetFieldName(string $fieldName): self

SlugField::setSeparator()

public function setSeparator(string $separator): self

SlugField::keep()

public function keep(string $keep): self

SlugField::uppercase()

public function uppercase(bool $upper = true): self

SlugField::setUnlockConfirmationMessage()

public function setUnlockConfirmationMessage(string $message): self

SlugField::showLeadingHash()

public function showLeadingHash(bool $show = true): self

StateField class

class StateField extends SelectField StateField.php:10

const OPTION_CLASS = 'class'

StateField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

StockField class

final class StockField implements FieldInterface StockField.php:7

const OPTION_NUM_DECIMALS = 'numDecimals'
const OPTION_ROUNDING_MODE = 'roundingMode'
const OPTION_STORED_AS_STRING = 'storedAsString'
const OPTION_ALLOW_INFINITY = 'allowInfinity'
const OPTION_TARGET_FIELD_NAME = 'targetFieldName'

StockField::new()

public static function new(string $propertyName, $label = null): self

StockField::setTargetFieldName()

public function setTargetFieldName(string $fieldName): self

StockField::step()

public function step(float $step)

StockField::stepUp()

public function stepUp(float $stepUp)

StockField::stepDown()

public function stepDown(float $stepDown)

StockField::setNumDecimals()

public function setNumDecimals(int $num): self

StockField::setAllowInfinity()

public function setAllowInfinity(bool $nullable = true)

StockField::setRoundingMode()

public function setRoundingMode(int $mode): self

StockField::setStoredAsString()

public function setStoredAsString(bool $asString = true): self

TextField class

class TextField implements FieldInterface TextField.php:9

const OPTION_MAX_LENGTH = 'maxLength'
const OPTION_RENDER_AS_HTML = 'renderAsHtml'
const OPTION_RENDER_AS_BOOLEAN = 'renderAsBoolean'
const OPTION_STRIP_TAGS = 'stripTags'

TextField::new()

public static function new(string $propertyName, $label = null)

TextField::setMaxLength()

public function setMaxLength(int $length)

This option is ignored when using 'renderAsHtml()' to avoid truncating contents in the middle of an HTML tag.

TextField::renderAsHtml()

public function renderAsHtml(bool $asHtml = true)

TextField::renderAsBoolean()

public function renderAsBoolean(bool $asBool = true)

TextField::stripTags()

public function stripTags(bool $stripTags = true)

TextareaField class

class TextareaField implements FieldInterface TextareaField.php:8

const OPTION_MAX_LENGTH = 'maxLength'
const OPTION_NUM_OF_ROWS = 'numOfRows'

TextareaField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

TextareaField::setMaxLength()

public function setMaxLength(int $length): self

TextareaField::setNumOfRows()

public function setNumOfRows(int $rows): self

TranslationField class

class TranslationField implements FieldInterface TranslationField.php:10

const OPTION_MAX_LENGTH = 'maxLength'
const OPTION_RENDER_AS_HTML = 'renderAsHtml'
const OPTION_STRIP_TAGS = 'stripTags'

TranslationField::new()

public static function new(?string $propertyName = null, TranslatableInterface|string|bool|null $label = null): self

TranslationField::setMaxLength()

public function setMaxLength(int $length): self

TranslationField::autoload()

public function autoload($autoload = true): self

TranslationField::renderAsHtml()

public function renderAsHtml(bool $asHtml = true): self

TranslationField::stripTags()

public function stripTags(bool $stripTags = true): self

TranslationField::setFields()

public function setFields(array $fields): self

TranslationField::showOnIndex()

public function showOnIndex(?string $field = null): self

TranslationField::setRequired()

public function setRequired(bool $isRequired = true)

TranslationField::setExcludedFields()

public function setExcludedFields($excludedFields): self

TranslationField::setTranslationClass()

public function setTranslationClass($translationClass): self

TranslationField::setDefaultLocale()

public function setDefaultLocale(string $defaultLocale): self

TranslationField::renderSingleLocale()

public function renderSingleLocale(?string $singleLocale = null): self

VideoField class

class VideoField extends FileField implements FieldInterface VideoField.php:9

const OPTION_RENDER_FORMAT = 'renderFormat'

VideoField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

WysiwygField class

final class WysiwygField implements FieldInterface WysiwygField.php:8

const OPTION_SHORTEN_LENGTH = 'shortenStrLength'
const OPTION_SHORTEN_POSITION = 'shortenStrPosition'
const OPTION_SHORTEN_SEPARATOR = 'shortenStrSeparator'
const OPTION_STRIP_TAGS = 'stripTags'
const OPTION_RENDER_AS_BOOLEAN = 'renderAsBoolean'

WysiwygField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

WysiwygField::renderAsBoolean()

public function renderAsBoolean(bool $asBool = true)

WysiwygField::shorten()

public function shorten(int $length = 100, int $position = SHORTEN_BACK, string $separator = ' [..] '): self

WysiwygField::stripTags()

public function stripTags(bool $stripTags = true)

YearField class

final class YearField implements FieldInterface YearField.php:11

YearField::new()

public static function new(string $propertyName, TranslatableInterface|string|bool|null $label = null): self

Base\Field\Option

TextAlign class

final class TextAlign TextAlign.php:5

const LEFT = 'left'
const CENTER = 'center'
const RIGHT = 'right'

Base\Field\Type

ArrayType class

class ArrayType extends CollectionType ArrayType.php:22

ArrayType::__construct()

public function __construct(Environment $twig, TranslatorInterface $translator, AuthorizationChecker $authorizationChecker, AdminUrlGeneratorInterface $adminUrlGenerator, ?\Symfony\Component\HttpFoundation\RequestStack $requestStack = null, ?ClassMetadataManipulator $classMetadataManipulator = null)

The service definition inherits CollectionType's args (->parent(...)) and APPENDS its own - so this signature must mirror the parent's positionally. When the parent gained a RequestStack, this ctor received it as its 5th argument where it expected the manipulator, and every form using ArrayType 500'd (caught by the groups/new render test).

ArrayType::getBlockPrefix()

public function getBlockPrefix(): string

ArrayType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ArrayType::buildFormArray()

public function buildFormArray(FormBuilderInterface $builder, array $options)

ArrayType::buildFormAssociativeArray()

public function buildFormAssociativeArray(FormBuilderInterface $builder, array $options)

ArrayType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

{@inheritdoc}

ArrayType::getNumberOfArguments()

public function getNumberOfArguments($pattern): int

ArrayType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

AssociationFileType class

class AssociationFileType extends AbstractType implements DataMapperInterface AssociationFileType.php:36

AssociationFileType::getBlockPrefix()

public function getBlockPrefix(): string

AssociationFileType::__construct()

public function __construct(FormFactory $formFactory, ClassMetadataManipulator $classMetadataManipulator, EntityHydrator $entityHydrator, MediaService $mediaService, AdminUrlGeneratorInterface $adminUrlGenerator)

AssociationFileType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

AssociationFileType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

AssociationFileType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

AssociationFileType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

AssociationFileType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void
Throws

MappingException

AssociationType class

class AssociationType extends AbstractType implements DataMapperInterface AssociationType.php:38

AssociationType::getBlockPrefix()

public function getBlockPrefix(): string

AssociationType::__construct()

public function __construct(FormFactory $formFactory, ClassMetadataManipulator $classMetadataManipulator, EntityHydrator $entityHydrator, TranslatorInterface $translator)

AssociationType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

AssociationType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

AssociationType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

AssociationType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void
Throws

Exception

AssociationType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void
Throws

MappingException

AttributeType class

class AttributeType extends AbstractType implements DataMapperInterface AttributeType.php:45

AttributeType::getBlockPrefix()

public function getBlockPrefix(): string

AttributeType::__construct()

public function __construct(FormFactory $formFactory, ClassMetadataManipulator $classMetadataManipulator, Environment $twig)

AttributeType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

AttributeType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

AttributeType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

AttributeType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

AttributeType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void
Throws

MappingException

AudioType class

class AudioType extends FileType AudioType.php:10

AudioType::getBlockPrefix()

public function getBlockPrefix(): string

AudioType::getParent()

public function getParent(): ?string

AudioType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

AudioType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

AvatarType class

class AvatarType extends ImageType AvatarType.php:12

AvatarType::getBlockPrefix()

public function getBlockPrefix(): string

AvatarType::getParent()

public function getParent(): ?string

AvatarType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

AvatarType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

AvatarType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

BooleanType class

class BooleanType extends AbstractType BooleanType.php:12

BooleanType::__construct()

public function __construct(Environment $twig)

BooleanType::getBlockPrefix()

public function getBlockPrefix(): string

BooleanType::getParent()

public function getParent(): ?string

BooleanType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

BooleanType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

ButtonType class

class ButtonType extends BaseType implements SubmitButtonTypeInterface ButtonType.php:11

ButtonType::getParent()

public function getParent(): ?string

ButtonType::getBlockPrefix()

public function getBlockPrefix(): string

ButtonType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ButtonType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

CodeType class

final class CodeType extends AbstractType CodeType.php:22

A code of known length - a one-time code, a voucher, a PIN - typed one character per box. The boxes are presentation only: they feed a single hidden input that carries the field's real value, so the type is a plain TextType to the form (validation, data transformers, everything) and degrades to that hidden value when the script is not there.

Options: length (6), alphabet ('alnum' | 'digits' | 'alpha'), uppercase (true), submit_on_complete (false: submit the form once every box is filled - what a login code page wants).

CodeType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

CodeType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

CodeType::getParent()

public function getParent(): ?string

CodeType::getBlockPrefix()

public function getBlockPrefix(): string

CollectionType class

class CollectionType extends AbstractType CollectionType.php:23

CollectionType::__construct()

public function __construct(Environment $twig, TranslatorInterface $translator, AuthorizationChecker $authorizationChecker, AdminUrlGeneratorInterface $adminUrlGenerator, readonly ?\Symfony\Component\HttpFoundation\RequestStack $requestStack = null)

CollectionType::getBlockPrefix()

public function getBlockPrefix(): string

CollectionType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

CollectionType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

{@inheritdoc}

CollectionType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

{@inheritdoc}

CollectionType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

{@inheritdoc}

ColorPickerType class

final class ColorPickerType extends AbstractType ColorPickerType.php:17

const THEME_CLASSIC = 'classic'
const THEME_MONOLITH = 'monolith'
const THEME_NANO = 'nano'
const POSITION_TOP = 'top'
const POSITION_LEFT = 'left'
const POSITION_BOTTOM = 'bottom'
const POSITION_RIGHT = 'right'
const POSITION_START = 'start'
const POSITION_MIDDLE = 'middle'
const POSITION_END = 'end'
const COLOR_NAVY = '#001F3F'
const COLOR_BLUE = '#0074d9'
const COLOR_AQUA = '#7fdbff'
const COLOR_TEAL = '#39cccc'
const COLOR_OLIVE = '#3d9970'
const COLOR_GREEN = '#2ecc40'
const COLOR_LIME = '#01ff70'
const COLOR_YELLOW = '#ffdc00'
const COLOR_ORANGE = '#ff851b'
const COLOR_RED = '#ff4136'
const COLOR_MAROON = '#85144B'
const COLOR_FUCHSIA = '#f012be'
const COLOR_PURPLE = '#b10dc9'
const COLOR_BLACK = '#111111'
const COLOR_GRAY = '#AAAAAA'

ColorPickerType::__construct()

public function __construct(TranslatorInterface $translator)

ColorPickerType::getParent()

public function getParent(): ?string

ColorPickerType::getBlockPrefix()

public function getBlockPrefix(): string

ColorPickerType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ColorPickerType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

ColorPickerType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

ColorType class

final class ColorType extends AbstractType ColorType.php:20

ColorType::__construct()

public function __construct(Environment $twig, ParameterBagInterface $parameterBag)

ColorType::getBlockPrefix()

public function getBlockPrefix(): string

ColorType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ColorType::getParent()

public function getParent(): ?string

ColorType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

ColorType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

CountryType class

class CountryType extends SelectType implements SelectInterface CountryType.php:12

CountryType::addCountry()

public static function addCountry($code, $country)

CountryType::addCountries()

public static function addCountries($array)

CountryType::getName()

public static function getName(string $code)

CountryType::getNamesWithoutAddons()

public static function getNamesWithoutAddons()

CountryType::getNames()

public static function getNames($addons = false)

CountryType::getChoices()

public static function getChoices(): array

CountryType::getIcon()

public static function getIcon(string $id, int $index = -1): ?string

CountryType::getText()

public static function getText(string $id): ?string

CountryType::getHtml()

public static function getHtml(string $id): ?string

CountryType::getData()

public static function getData(string $id): ?array

CountryType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

CropperType class

class CropperType extends AbstractType implements DataMapperInterface CropperType.php:25

CropperType::getBlockPrefix()

public function getBlockPrefix(): string

CropperType::__construct()

public function __construct(FormFactory $formFactory, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, Environment $twig)

CropperType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

CropperType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

CropperType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

CropperType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

CropperType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

CropperType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void

CurrencyType class

class CurrencyType extends AbstractType CurrencyType.php:14

const DISPLAY_SYMBOL = "symbol"
const DISPLAY_CODE = "code"

CurrencyType::getParent()

public function getParent(): ?string

CurrencyType::getBlockPrefix()

public function getBlockPrefix(): string

CurrencyType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

DateTimePickerType class

class DateTimePickerType extends AbstractType DateTimePickerType.php:17

DateTimePickerType::__construct()

public function __construct(ParameterBagInterface $parameterBag, Environment $twig, LocalizerInterface $localizer)

DateTimePickerType::getParent()

public function getParent(): ?string

DateTimePickerType::getBlockPrefix()

public function getBlockPrefix(): string

DateTimePickerType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

DateTimePickerType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

DiscriminatorType class

class DiscriminatorType extends AbstractType DiscriminatorType.php:21

DiscriminatorType::__construct()

public function __construct(FormFactory $formFactory, ClassMetadataManipulator $classMetadataManipulator)

DiscriminatorType::getBlockPrefix()

public function getBlockPrefix(): string

DiscriminatorType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

DiscriminatorType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

DiscriminatorType::getFormattedValues()

public static function getFormattedValues($entry, $class = null, ?TranslatorInterface $translator = null, $format = FORMAT_TITLECASE)

DiscriminatorType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

EditorType class

class EditorType extends AbstractType EditorType.php:26

EditorType::__construct()

public function __construct(ParameterBagInterface $parameterBag, TranslatorInterface $translator, Environment $twig, AdvancedRouterInterface $router, CsrfTokenManagerInterface $csrfTokenManager, ObfuscatorInterface $obfuscator, MediaEnhancerInterface $mediaEnhancer, CollabRoomResolver $roomResolver, TokenStorageInterface $tokenStorage, ?CollabTicketFactory $ticketFactory = null)

EditorType::getParent()

public function getParent(): ?string

EditorType::getBlockPrefix()

public function getBlockPrefix(): string

EditorType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

EditorType::getFormID()

public function getFormID($view): ?string

EditorType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

EditorType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

EmojiPickerType class

final class EmojiPickerType extends AbstractType EmojiPickerType.php:13

EmojiPickerType::getBlockPrefix()

public function getBlockPrefix(): string

EmojiPickerType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

EmojiPickerType::getParent()

public function getParent(): ?string

EmojiPickerType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

EmojiPickerType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

FileType class

class FileType extends AbstractType implements DataMapperInterface FileType.php:36

FileType::__construct()

public function __construct(ParameterBagInterface $parameterBag, TranslatorInterface $translator, Environment $twig, ClassMetadataManipulator $classMetadataManipulator, CsrfTokenManagerInterface $csrfTokenManager, FormFactory $formFactory, AdvancedRouterInterface $router, MediaService $mediaService, ObfuscatorInterface $obfuscator, string $cacheDir)

FileType::getBlockPrefix()

public function getBlockPrefix(): string

{@inheritdoc}

FileType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

{@inheritdoc}

FileType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

FileType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

FileType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

FileType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void

ForexType class

class ForexType extends SelectType implements SelectInterface ForexType.php:11

ForexType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ForexType::getIcon()

public static function getIcon(string $id, int $index = -1): ?string

ForexType::getText()

public static function getText(string $id): ?string

ForexType::getHtml()

public static function getHtml(string $id): ?string

ForexType::getData()

public static function getData(string $id): ?array

GenderType class

class GenderType extends AbstractType GenderType.php:9

GenderType::getParent()

public function getParent(): ?string

GenderType::getBlockPrefix()

public function getBlockPrefix(): string

GenderType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

IconType class

class IconType extends SelectType implements SelectInterface IconType.php:12

public static mixed $iconProvider = null

IconType::__construct()

public function __construct(...$args)

IconType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

IconType::getIcon()

public static function getIcon(string $id, int $index = -1): ?string

IconType::getText()

public static function getText(string $id): ?string

IconType::getHtml()

public static function getHtml(string $id): ?string

IconType::getData()

public static function getData(string $id): ?array

ImageType class

class ImageType extends FileType ImageType.php:12

ImageType::getBlockPrefix()

public function getBlockPrefix(): string

ImageType::getParent()

public function getParent(): ?string

ImageType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ImageType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

ImageType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

MoneyType class

class MoneyType extends MoneyType MoneyType.php:16

const CODE_ONLY = 0
const LABEL_ONLY = 1
const LABELCODE_ONLY = 2

MoneyType::__construct()

public function __construct(TradingInterface $tradingMarket)

MoneyType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

{@inheritdoc}

MoneyType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

MoneyType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

NumberType class

class NumberType extends NumberType NumberType.php:14

NumberType::__construct()

public function __construct(Environment $twig)

NumberType::getBlockPrefix()

public function getBlockPrefix(): string

NumberType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

NumberType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

NumberType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

PasswordType class

class PasswordType extends AbstractType implements AutovalidateInterface, DataMapperInterface PasswordType.php:21

PasswordType::__construct()

public function __construct(TranslatorInterface $translator, Environment $twig)

PasswordType::getBlockPrefix()

public function getBlockPrefix(): string

PasswordType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

PasswordType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

PasswordType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

PasswordType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

PasswordType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void

QuadrantType class

class QuadrantType extends AbstractType implements DataMapperInterface QuadrantType.php:18

QuadrantType::getBlockPrefix()

public function getBlockPrefix(): string

QuadrantType::__construct()

public function __construct(Environment $twig)

QuadrantType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

QuadrantType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

QuadrantType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

QuadrantType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

QuadrantType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void

RoleType class

class RoleType extends AbstractType RoleType.php:10

RoleType::getParent()

public function getParent(): ?string

RoleType::getBlockPrefix()

public function getBlockPrefix(): string

RoleType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

RouteType class

class RouteType extends AbstractType RouteType.php:14

RouteType::getParent()

public function getParent(): ?string

RouteType::getBlockPrefix()

public function getBlockPrefix(): string

RouteType::__construct()

public function __construct(AdvancedRouterInterface $router, LocalizerInterface $localizer)

RouteType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SelectType class

class SelectType extends AbstractType implements DataMapperInterface SelectType.php:56

const REQUIRED_MESSAGE = 'This value should not be blank.'

What a required select sent empty answers (Symfony's NotBlank message, validators domain).

SelectType::__construct()

public function __construct(FormFactory $formFactory, EntityManagerInterface $entityManager, TranslatorInterface $translator, ClassMetadataManipulator $classMetadataManipulator, CsrfTokenManagerInterface $csrfTokenManager, Localizer $localizer, AdminUrlGeneratorInterface $adminUrlGenerator, Environment $twig, AuthorizationChecker $authorizationChecker, ObfuscatorInterface $obfuscator, ParameterBagInterface $parameterBag, RouterInterface $router, ?MediaServiceInterface $mediaService = null)

SelectType::getBlockPrefix()

public function getBlockPrefix(): string

SelectType::getIcons()

public static function getIcons(): array

SelectType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SelectType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SelectType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

SelectType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void
Throws

MappingException

SelectType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

SelectType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

The <select> the server prints holds its options and its selection.

The inner choice was drawn empty and filled by select2 alone from data-select2-options: on a page whose script did not run (blocked, failed, not loaded yet) there was nothing to choose, a product's availability arrived null, and a list that did print its options - a choice_loader's, the currencies - printed none of them selected, so the browser sent the first one (AFA) in place of the record's value.

  • The entries select2 receives - the choices of a static list, of an enum; the records already chosen of an autocompleted one - are printed as <option>s, groups as <optgroup>s, with the labels select2 shows. select2 empties the select before filling it from its data, as it always did: nothing is listed twice.
  • The value of the record is the selected option, for those and for the options a choice_loader gave.
  • A select of one value starts with an empty option carrying the placeholder: without it the browser - and select2, which asks for this very option - picks the first choice when the record has none.

SlugType class

final class SlugType extends AbstractType implements AutovalidateInterface SlugType.php:17

SlugType::__construct()

public function __construct(Environment $twig, ClassMetadataManipulator $classMetadataManipulator)

SlugType::getParent()

public function getParent(): ?string

SlugType::getBlockPrefix()

public function getBlockPrefix(): string

SlugType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SlugType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

StateType class

class StateType extends AbstractType StateType.php:9

StateType::getParent()

public function getParent(): ?string

StateType::getBlockPrefix()

public function getBlockPrefix(): string

StateType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

StockType class

class StockType extends NumberType StockType.php:12

StockType::getBlockPrefix()

public function getBlockPrefix(): string

{@inheritdoc}

StockType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

StockType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

StockType::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

SubmitType class

class SubmitType extends AbstractType implements SubmitButtonTypeInterface SubmitType.php:9

SubmitType::getBlockPrefix()

public function getBlockPrefix(): string

SubmitType::getParent()

public function getParent(): ?string

SubmitType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

TranslatableType class

class TranslatableType extends AbstractType TranslatableType.php:10

TranslatableType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

TranslatableType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

TranslationType class

class TranslationType extends AbstractType implements DataMapperInterface TranslationType.php:32

TranslationType::__construct()

public function __construct(ClassMetadataManipulator $classMetadataManipulator, LocalizerInterface $localizer, Environment $twig)

TranslationType::getBlockPrefix()

public function getBlockPrefix(): string

TranslationType::getDefaultLocale()

public function getDefaultLocale()

TranslationType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

{@inheritdoc}

TranslationType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

TranslationType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

TranslationType::getTranslationFields()

public function getTranslationFields(string $translationClass, array $options): array

TranslationType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

TranslationType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void

VideoType class

class VideoType extends FileType VideoType.php:10

VideoType::getBlockPrefix()

public function getBlockPrefix(): string

VideoType::getParent()

public function getParent(): ?string

VideoType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

VideoType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

WysiwygType class

class WysiwygType extends AbstractType WysiwygType.php:15

WysiwygType::__construct()

public function __construct(ParameterBagInterface $parameterBag, TranslatorInterface $translator, Environment $twig)

WysiwygType::getParent()

public function getParent(): ?string

WysiwygType::getBlockPrefix()

public function getBlockPrefix(): string

WysiwygType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

WysiwygType::getFormID()

public function getFormID($view): ?string

WysiwygType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

Base\Form

FormFactory class

class FormFactory extends SymfonyFormFactory implements FormFactoryInterface FormFactory.php:23

FormFactory::__construct()

public function __construct(FormRegistryInterface $registry, ValidatorInterface $validator, ClassMetadataManipulator $classMetadataManipulator, EntityHydratorInterface $entityHydrator)

FormFactory::createBuilder()

public function createBuilder(string $type = FormType::class, mixed $data = null, array $options = []): FormBuilderInterface

FormFactory::create()

public function create(string $type = FormType::class, mixed $data = null, array $options = [], array $listeners = []): FormInterface

FormFactoryInterface interface

interface FormFactoryInterface extends SymfonyFormFactoryInterface, FormGuessInterface FormFactoryInterface.php:8

FormProcessor class

class FormProcessor implements FormProcessorInterface FormProcessor.php:18

public array $flowSessions = []
public array $flowCallbacks = []

FormProcessor::__construct()

public function __construct(FormInterface $form)

FormProcessor::getForm()

public function getForm(): FormInterface

FormProcessor::getFormType()

public function getFormType(): string

FormProcessor::getOption()

public function getOption(string $name): mixed

FormProcessor::getOptions()

public function getOptions(): array

FormProcessor::getData()

public function getData(?string $childName = null): mixed

FormProcessor::setData()

public function setData(mixed $data): self

FormProcessor::hydrate()

public function hydrate(mixed $data): mixed

FormProcessor::onDefault()

public function onDefault(callable $callback): static

FormProcessor::onInvalid()

public function onInvalid(callable $callback): static

FormProcessor::onSubmit()

public function onSubmit(callable ...$callbacks): static

FormProcessor::hasResponse()

public function hasResponse(): bool

FormProcessor::getResponse()

public function getResponse(): Response

FormProcessor::getDto()

public function getDto(): ?FormModelInterface

FormProcessor::getEntity()

public function getEntity()

FormProcessor::handleRequest()

public function handleRequest(Request $request): static

FormProcessor::reset()

public function reset()

FormProcessor::getToken()

public function getToken()

FormProcessor::addStep()

public function addStep(callable $callback)

FormProcessor::addConfirmStep()

public function addConfirmStep()

FormProcessor::getPreviousStep()

public function getPreviousStep()

FormProcessor::getStepMax()

public function getStepMax()

FormProcessor::getNextStep()

public function getNextStep()

FormProcessor::setStep()

public function setStep($step)

FormProcessor::getStep()

public function getStep()

FormProcessorInterface interface

interface FormProcessorInterface FormProcessorInterface.php:9

FormProcessorInterface::handleRequest()

public function handleRequest(Request $request): static

FormProcessorInterface::hydrate()

public function hydrate(mixed $data): mixed

FormProcessorInterface::getForm()

public function getForm(): FormInterface

FormProcessorInterface::getData()

public function getData(): mixed

FormProcessorInterface::setData()

public function setData(mixed $data): self

FormProcessorInterface::getOption()

public function getOption(string $name): mixed

FormProcessorInterface::getOptions()

public function getOptions(): array

FormProcessorInterface::getFormType()

public function getFormType(): string

FormProcessorInterface::onDefault()

public function onDefault(callable $callback): static

FormProcessorInterface::onInvalid()

public function onInvalid(callable $callback): static

FormProcessorInterface::onSubmit()

public function onSubmit(callable ...$callbacks): static

FormProcessorInterface::getResponse()

public function getResponse(): Response

FormProxy class

class FormProxy implements FormProxyInterface, ResetInterface FormProxy.php:16

The forms of a request, by name. Reset between two requests (kernel.reset): a kernel that serves several - a test client's, a worker's - kept the sign-in form under "form:login", and the sign-up page, which asks for a processor of that name, rendered the sign-in form.

FormProxy::__construct()

public function __construct(FormFactoryInterface $formFactory)

FormProxy::all()

public function all()

FormProxy::empty()

public function empty(): bool

FormProxy::has()

public function has(string $name): bool

FormProxy::getData()

public function getData(string $name, ?string $childName = null): mixed

FormProxy::setData()

public function setData(string $name, mixed $data): self

FormProxy::get()

public function get(string $name): ?FormInterface

FormProxy::add()

public function add(string $name, ?FormInterface $form): self

FormProxy::remove()

public function remove(string $name): self

FormProxy::create()

public function create(string $name, string $type = FormType::class, mixed $data = null, array $options = [], array $listeners = []): FormInterface

FormProxy::submit()

public function submit(string $name, string|array|null $submittedData, bool $clearMissing = true): ?FormInterface

FormProxy::getProcessor()

public function getProcessor(string $name): ?FormProcessorInterface

FormProxy::createProcessor()

public function createProcessor(string $name, string $formTypeClass = FormType::class, array $options = [], array $listeners = []): ?FormProcessorInterface

FormProxy::reset()

public function reset(): void

FormProxyInterface interface

interface FormProxyInterface FormProxyInterface.php:8

FormProxyInterface::all()

public function all()

FormProxyInterface::add()

public function add(string $name, ?FormInterface $form): self

FormProxyInterface::remove()

public function remove(string $name): self

FormProxyInterface::has()

public function has(string $name): bool

FormProxyInterface::get()

public function get(string $name): ?FormInterface

FormProxyInterface::getProcessor()

public function getProcessor(string $name): ?FormProcessorInterface

FormProxyInterface::setData()

public function setData(string $name, mixed $data): self

FormProxyInterface::getData()

public function getData(string $name, ?string $childName): mixed

FormProxyInterface::create()

public function create(string $name, string $type = FormType::class, mixed $data = null, array $options = []): ?FormInterface

FormProxyInterface::createProcessor()

public function createProcessor(string $name, string $formTypeClass = FormType::class, array $options = []): ?FormProcessorInterface

FormProxyInterface::submit()

public function submit(string $name, string|array|null $submittedData, bool $clearMissing = true): ?FormInterface

Base\Form\Common

AbstractModel class

class AbstractModel implements FormModelInterface AbstractModel.php:5

AbstractModel::getTypeClass()

public static function getTypeClass(): string

AbstractType class

abstract class AbstractType extends AbstractType implements FormTypeInterface AbstractType.php:5

AbstractType::getModelClass()

public static function getModelClass(): string

FormModelInterface interface

interface FormModelInterface FormModelInterface.php:5

FormModelInterface::getTypeClass()

public static function getTypeClass(): string

FormTypeInterface interface

interface FormTypeInterface extends SymfonyFormTypeInterface FormTypeInterface.php:7

FormTypeInterface::getModelClass()

public static function getModelClass(): string

NativeEnum class

final class NativeEnum NativeEnum.php:13

A PHP enum as a list of choices: what a select holds for a case (its value, or its name when the enum is not backed), the case back from it, and the words that name it.

NativeEnum::is()

public static function is(mixed $class): bool

NativeEnum::id()

public static function id(\UnitEnum $case): string

What the select holds for a case: the backed value, else the case's name.

NativeEnum::of()

public static function of(string $class, mixed $id): ?\UnitEnum

The case a select's value names; null for anything else.

NativeEnum::ids()

public static function ids(string $class): array

NativeEnum::key()

public static function key(\UnitEnum $case): string

The translation key of a case in the "enums" domain: the enum's short name in snake case, then the select's value in lower case (Base\Enum\CommentState::PENDING is "comment_state.pending").

NativeEnum::label()

public static function label(\UnitEnum $case, ?TranslatorInterface $translator = null, ?string $locale = null): string

A case's label: what the enum says itself when it is translatable (Symfony's TranslatableInterface), else its key in the "enums" domain, else its name made readable (NOT_CONTRACTED: "Not contracted").

Base\Form\Extension

FormTypeBootstrapExtension class

class FormTypeBootstrapExtension extends AbstractTypeExtension FormTypeBootstrapExtension.php:14

FormTypeBootstrapExtension::__construct()

public function __construct(BaseService $baseService)

FormTypeBootstrapExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

FormTypeBootstrapExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeBootstrapExtension::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

FormTypeBootstrapExtension::browseView()

public function browseView(FormView $view, FormInterface $form, array $options)

FormTypeBootstrapExtension::applyBootstrap()

public function applyBootstrap(FormView $view, FormInterface $form, array $options)

FormTypeBootstrapExtension::addAttribute()

public static function addAttribute(FormView $view, $name, $value)

FormTypeBootstrapExtension::addRowAttribute()

public static function addRowAttribute(FormView $view, $name, $value)

FormTypeBootstrapExtension::addLabelAttribute()

public static function addLabelAttribute(FormView $view, $name, $value)

FormTypeCollabExtension class

class FormTypeCollabExtension extends AbstractTypeExtension FormTypeCollabExtension.php:38

This class activates real-time presence and autosave for any regular field: an input field, a select field, a select2 field, or another field type. This class is not specific to EditorType. This class adds a new collab form option, with three possible values: false (the default value), "autosave", or "live".

This class writes plain data-collab-* attributes. This class does not change form_div_layout.html.twig. Twig's own widget_attributes rendering already outputs the content of $view->vars["attr"], set by finishView(). Because of this, every field type receives these attributes automatically, including a field that uses select2_widget's own attribute merge.

The file form-type-collab-presence.js, inside assets/styles/js/forms/, is the client-side code for this feature. This file reuses the ux_editorjs_collabTicket action and the ux_editorjs_autosave action. EditorType uses these same two generic actions. This design follows the "one controller" decision in the collaboration plan.

FormTypeCollabExtension::__construct()

public function __construct(CollabRoomResolver $roomResolver, TokenStorageInterface $tokenStorage, CsrfTokenManagerInterface $csrfTokenManager, AdvancedRouterInterface $router, ?CollabTicketFactory $ticketFactory = null)

FormTypeCollabExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

FormTypeCollabExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeCollabExtension::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

FormTypeCollectionExtension class

class FormTypeCollectionExtension extends AbstractTypeExtension FormTypeCollectionExtension.php:14

FormTypeCollectionExtension::__construct()

public function __construct(ClassMetadataManipulator $classMetadataManipulator)

FormTypeCollectionExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

{@inheritdoc}

FormTypeCollectionExtension::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

FormTypeCollectionExtension::browseView()

public function browseView(FormView $view, FormInterface $form, array $options)

FormTypeCsrfExtension class

class FormTypeCsrfExtension extends AbstractTypeExtension FormTypeCsrfExtension.php:10

FormTypeCsrfExtension::__construct()

public function __construct(bool $defaultEnabled = false)

FormTypeCsrfExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeCsrfExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

{@inheritdoc}

FormTypeExtension class

class FormTypeExtension extends AbstractTypeExtension FormTypeExtension.php:24

FormTypeExtension::__construct()

public function __construct(AdvancedRouterInterface $router, AuthorizationCheckerInterface $authorizationChecker, ParameterBagInterface $parameterBag, FormFactory $formFactory, FormProxyInterface $formProxy, ClassMetadataManipulator $classMetadataManipulator, VersionManager $versionManager, $translator = null)

FormTypeExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

{@inheritdoc}

FormTypeExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeExtension::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

FormTypeExtension::browseView()

public function browseView(FormView $view, FormInterface $form, array $options)

FormTypeExtension::applyForm2()

public function applyForm2(FormView $view)

FormTypeExtension::applyEA()

public function applyEA(FormView $view, FormInterface $form)

FormTypeExtension::markAsDbColumns()

public function markAsDbColumns(FormView $view, FormInterface $form, array $options)

FormTypeExtension::markDbProperties()

public function markDbProperties(FormView $view, FormInterface $form, array $options)

FormTypeExtension::markVersionable()

public function markVersionable(FormView $view, FormInterface $form)

Hand each versioned field its own history, so form_div_layout can put a badge next to the label of the fields that actually have one.

Runs per form node rather than once at the root: an article's translated fields live on a ThreadIntl sub-form, one per locale, and each of those has to be matched against the locale-prefixed keys of the parent's revisions. VersionManager handles both the anchoring and the memoisation that keeps this from being one query per locale tab.

FormTypeExtension::markOptions()

public function markOptions(FormView $view, FormInterface $form, array $options)

FormTypeExtension::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

FormTypeGuardExtension class

class FormTypeGuardExtension extends AbstractTypeExtension FormTypeGuardExtension.php:49

The option guard of a root form: Base\Service\FormGuard's checks, in their order (docs/20-architecture/guard.md).

$this->createForm(ContactType::class, $model, ['guard' => true]); $this->createForm(ContactType::class, $model, ['guard' => ['action' => 'contact', 'min_delay' => 5]]);

It adds a trap (guard_website), the stamp of the time the form was shown (guard_opened) and - with glitchr/omnishield and a captcha configured - the captcha (guard_captcha); after the submission it refuses a trap filled, a form sent too fast, a sender the lists know. The captcha is checked by the guard, on its field - shown and asked only once the visitor's tries of this form were refused captcha_after times (base.guard.captcha_after, 3; 0: always): a refusal of the guard or an invalid form counts one, a form sent forgets them (FormGuard::failed(), succeeded()).

Where glitchr/ux-google already guards the form (its option captcha_protection: google.recaptcha.enable), no second captcha is added: the trap, the time, the lists and the classifier stay.

spam_protection - the classifier step, on by default as it always was outside the back office: a form whose data implement SpamProtectionInterface is scored (SpamChecker), its callback told, and blatant spam refused. It runs once the form is otherwise valid: nothing is sent to the classifier for a form already refused.

FormTypeGuardExtension::__construct()

public function __construct(protected readonly FormGuard $guard, protected readonly SpamCheckerInterface $spamChecker, protected readonly AdvancedRouterInterface $router, protected readonly ?TranslatorInterface $translator = null, protected readonly ?RequestStack $requests = null, protected readonly bool $spamByDefault = true)

FormTypeGuardExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

FormTypeGuardExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeGuardExtension::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

FormTypeGuardExtension::finishView()

public function finishView(\Symfony\Component\Form\FormView $view, \Symfony\Component\Form\FormInterface $form, array $options): void

The captcha that waits for consent: its widget kept inert in a <template> until omnibase/consent says yes to the feature CAPTCHA (Consent.use()), the fallback shown meanwhile and after a refusal.

Without omnibase/consent's script on the page, the fallback alone.

FormTypeTranslateExtension class

class FormTypeTranslateExtension extends AbstractTypeExtension FormTypeTranslateExtension.php:10

FormTypeTranslateExtension::__construct()

public function __construct(bool $defaultEnabled = false)

FormTypeTranslateExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeTranslateExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

{@inheritdoc}

FormTypeWebpackExtension class

class FormTypeWebpackExtension extends AbstractTypeExtension FormTypeWebpackExtension.php:14

FormTypeWebpackExtension::__construct()

public function __construct(FormProxyInterface $formProxy, WebpackTagRenderer $webpackTagRenderer)

FormTypeWebpackExtension::getExtendedTypes()

public static function getExtendedTypes(): iterable

{@inheritdoc}

FormTypeWebpackExtension::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

FormTypeWebpackExtension::finishView()

public function finishView(FormView $view, FormInterface $form, array $options): void

FormTypeWebpackExtension::browseView()

public function browseView(FormView $view, FormInterface $form, array $options)

Base\Form\Model

CommentModel class

class CommentModel implements SpamProtectionInterface CommentModel.php:18

What the comment form (Base\Form\Type\CommentType) edits - not the entity (omnibase's FormFactory refuses an entity as form data): the name, the e-mail, the site, the text. It implements SpamProtectionInterface so omnibase's FormTypeSpamExtension sends it to Akismet; the score lands here, and toComment() carries it onto the Comment to save.

public ?string $name = null
public ?string $email = null
public ?string $website = null
public ?string $content = null
public ?User $author = null
public ?int $spamScore = null

CommentModel::forUser()

public static function forUser(?User $user): static

CommentModel::getSpamBlameable()

public function getSpamBlameable(): ?User

CommentModel::getSpamText()

public function getSpamText(): ?string

CommentModel::getSpamDate()

public function getSpamDate(): \DateTime

CommentModel::getSpamCallback()

public function getSpamCallback(int $score): void

CommentModel::toComment()

public function toComment(?Thread $thread, bool $autoApprove, string $class = Comment::class): Comment

The entity to save, Akismet's score applied (the state follows from it and from $autoApprove).

$class

a subclass of Comment, for a bundle that extends it

ContactModel class

class ContactModel extends AbstractModel ContactModel.php:16

What the contact form (Base\Form\Type\ContactType) sends: a name, an e-mail, a message, and as the form is set up a phone, a subject, attachments. website is the trap: left empty by people, filled by the robots that fill every field (isRobot()).

public ?string $name = null
public ?string $email = null
public ?string $phone = null
public ?string $subject = null
public ?string $message = null
public ?string $website = null

Left empty by people; filled by the robots that fill every field.

public array $attachments = []

ContactModel::getRecipient()

public function getRecipient(): ?Recipient

ContactModel::setAttachments()

public function setAttachments(?array $attachments): void

A form sent with no file hands null to its model, not an empty list: written straight into the property, that null stopped the request ("Cannot assign null to property ... of type array") on every message without an attachment.

ContactModel::isRobot()

public function isRobot(): bool

The trap was filled: thank it all the same, and send nothing.

SecurityLoginModel class

class SecurityLoginModel extends AbstractModel SecurityLoginModel.php:11

public $identifier
public $password

SecurityLoginTokenModel class

class SecurityLoginTokenModel extends AbstractModel SecurityLoginTokenModel.php:11

public $email

SecurityRegistrationModel class

class SecurityRegistrationModel extends AbstractModel SecurityRegistrationModel.php:13

public $email
public $plainPassword
public bool $agreeTerms

SettingModel class

class SettingModel extends AbstractModel SettingModel.php:7

public mixed $value

ThreadSearchModel class

class ThreadSearchModel extends AbstractModel ThreadSearchModel.php:11

public $parent_id
public $generic
public $title
public $excerpt
public $content

UserEditModel class

class UserEditModel UserEditModel.php:10

public $avatar
public $username
public $email

UserProfileModel class

class UserProfileModel extends AbstractModel UserProfileModel.php:11

public $email
public $plainPassword
public $avatar

UserSearchModel class

class UserSearchModel UserSearchModel.php:10

public $username

Base\Form\Traits

FormGuessInterface interface

interface FormGuessInterface FormGuessInterface.php:9

const GUESS_FROM_FORM = "GUESS_FROM_FORM"
const GUESS_FROM_PHPDOC = "GUESS_FROM_PHPDOC"
const GUESS_FROM_DATA = "GUESS_FROM_DATA"
const GUESS_FROM_VIEW = "GUESS_FROM_VIEW"

FormGuessInterface::guessClass()

public function guessClass(FormInterface|FormEvent $form, ?array $options = null): ?string

FormGuessInterface::guessMultiple()

public function guessMultiple(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)

FormGuessInterface::guessSortable()

public function guessSortable(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)

FormGuessInterface::guessChoices()

public function guessChoices(FormInterface|FormBuilderInterface $form, ?array $options = null)

FormGuessInterface::guessChoiceAutocomplete()

public function guessChoiceAutocomplete(FormInterface|FormBuilderInterface $form, ?array $options = null)

FormGuessInterface::guessChoiceFilter()

public function guessChoiceFilter(FormInterface|FormBuilderInterface $form, ?array $options = null, $data = null)

FormGuessTrait trait

trait FormGuessTrait FormGuessTrait.php:18

FormGuessTrait::guessClass()

public function guessClass(FormInterface|FormEvent $form, ?array $options = null): ?string

FormGuessTrait::guessEnumOfProperty()

public function guessEnumOfProperty(?string $class, string $property): ?string

The PHP enum a class's property is typed with (private Status $status, ?Status), null for any other property.

FormGuessTrait::guessMultiple()

public function guessMultiple(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)
Throws

MappingException

FormGuessTrait::guessNullable()

public function guessNullable(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)
Throws

MappingException

FormGuessTrait::guessSortable()

public function guessSortable(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)
Throws

Exception

FormGuessTrait::guessOrderDirection()

public function guessOrderDirection(FormInterface|FormEvent|FormBuilderInterface $form, ?array $options = null)

Guess the order direction (ASC/DESC) for a sortable field, using OrderColumn or OrderBy mapping.

Throws

Exception

FormGuessTrait::guessChoices()

public function guessChoices(FormInterface|FormBuilderInterface $form, ?array $options = null)

FormGuessTrait::guessChoiceAutocomplete()

public function guessChoiceAutocomplete(FormInterface|FormBuilderInterface $form, ?array $options = null)
Throws

MappingException

FormGuessTrait::guessChoiceFilter()

public function guessChoiceFilter(FormInterface|FormBuilderInterface $form, ?array $options = null, $data = null)

FormProcessorTrait trait

trait FormProcessorTrait FormProcessorTrait.php:12

in favor of using Symfony Form Flows

FormProcessorTrait::killSession()

public function killSession(?SessionInterface $session = null)

Base\Form\Transformer

ScaleNumberTransformer class

class ScaleNumberTransformer implements DataTransformerInterface ScaleNumberTransformer.php:26

Transforms between a number type and a localized number with grouping (each thousand) and comma separators.

ScaleNumberTransformer::__construct()

public function __construct(float $divisor)

ScaleNumberTransformer::transform()

public function transform(mixed $value): float|int|null

Transforms a localized number into an integer or float.

$value

The localized value

Throws

TransformationFailedException if the given value is not a string or if the value cannot be transformed

ScaleNumberTransformer::reverseTransform()

public function reverseTransform(mixed $value): int|float|null

Transforms a localized money string into a normalized format.

$value

Localized money string

Throws

TransformationFailedException if the given value is not a string or if the value cannot be transformed

StrippedNumberToLocalizedStringTransformer class

class StrippedNumberToLocalizedStringTransformer extends NumberToLocalizedStringTransformer StrippedNumberToLocalizedStringTransformer.php:27

Transforms between a number type and a localized number with grouping (each thousand) and comma separators.

StrippedNumberToLocalizedStringTransformer::__construct()

public function __construct($prefix, $suffix, ...$args)

StrippedNumberToLocalizedStringTransformer::reverseTransform()

public function reverseTransform(mixed $value): int|float|null

Transforms a localized number into an integer or float.

$value

The localized value

Throws

TransformationFailedException if the given value is not a string or if the value cannot be transformed

Base\Form\Type

CommentType class

class CommentType extends AbstractType CommentType.php:27

The comment form - small: a name, a message, an e-mail if one wants to be answered - on Base\Form\Model\CommentModel, which omnibase's FormTypeSpamExtension sends to Akismet. On top of it, for the robots that never reach Akismet: a trap field (url, hidden from people, filled by robots), the time the form was opened (opened), and - when glitchr/ux-google is installed and recaptcha is on - Google reCAPTCHA v3. Base\Service\CommentGuard reads the trap and the time.

Options: signed_in (no name nor e-mail asked), recaptcha, max_length, placeholders (name, email, content: translation keys), trap_class.

CommentType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

CommentType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ContactType class

class ContactType extends AbstractType ContactType.php:40

The contact form, usable as it is by every site:

$form = $this->createForm(ContactType::class, $model = new ContactModel(), [ 'phone' => true, 'subject' => false, 'attachments' => false, 'buttons' => false, 'trap' => true, ]); if ($form->isSubmitted() && $form->isValid() && !$model->isRobot()) { ...send... }

Options: phone (off), subject (on), attachments (on), buttons - the submit and reset buttons (on), trap - the website field robots fill, off-screen for people (off). Labels: the "forms" domain's contact.fields.*, or a label given to form_row().

The data-protection notice (Base\Form\Type\PrivacyType, a privacy child, not mapped): privacy - true for omnibase's notice (@forms.privacy.notice), a translation key for the site's own, false for none (default); privacy_consent - the box to tick, the form invalid until it is (off); privacy_parameters - the notice's parameters, a link to the privacy page for instance:

['privacy' => '@messages.contact.privacy', 'privacy_parameters' => ['url' => $url], 'privacy_consent' => true]

ContactType::getBlockPrefix()

public function getBlockPrefix(): string

ContactType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ContactType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

LayoutSettingListType class

class LayoutSettingListType extends AbstractType implements DataMapperInterface LayoutSettingListType.php:29

LayoutSettingListType::__construct()

public function __construct(SettingBag $settingBag, Localizer $localizer, ClassMetadataManipulator $classMetadataManipulator)

LayoutSettingListType::getBlockPrefix()

public function getBlockPrefix(): string

LayoutSettingListType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

LayoutSettingListType::getFormattedData()

public function getFormattedData($data, $from = '.', $to = '-')
Throws

Exception

LayoutSettingListType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

LayoutSettingListType::mapDataToForms()

public function mapDataToForms($viewData, \Traversable $forms): void

LayoutSettingListType::mapFormsToData()

public function mapFormsToData(\Traversable $forms, &$viewData): void
Throws

Exception

LayoutWidgetListType class

class LayoutWidgetListType extends AbstractType implements DataMapperInterface LayoutWidgetListType.php:21

LayoutWidgetListType::getBlockPrefix()

public function getBlockPrefix(): string

LayoutWidgetListType::__construct()

public function __construct(WidgetProviderInterface $widgetProvider)

LayoutWidgetListType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

LayoutWidgetListType::getFormattedData()

public function getFormattedData($data, $from = ".", $to = "-")
Throws

Exception

LayoutWidgetListType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

LayoutWidgetListType::mapDataToForms()

public function mapDataToForms($viewData, Traversable $forms): void

LayoutWidgetListType::mapFormsToData()

public function mapFormsToData(Traversable $forms, &$viewData): void
Throws

Exception

Login2FAType class

class Login2FAType extends AbstractType Login2FAType.php:15

The six-digit code that confirms a new authenticator app (/settings/2fa): nothing is mapped, the controller checks the code against the pending secret.

Login2FAType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

Login2FAType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

PrivacyType class

class PrivacyType extends AbstractType PrivacyType.php:31

The data-protection notice (GDPR) under a form that collects personal data, and if asked the box to tick before sending - one place for every site and bundle rather than a checkbox and a sentence each:

$builder->add('privacy', PrivacyType::class, [ 'notice' => '@forms.privacy.notice', // a translation key, or false: no notice 'notice_parameters' => ['url' => $privacyPageUrl], 'consent' => true, // the box, required (IsTrue) 'consent_label' => '@forms.privacy.consent', ]);

Not mapped: nothing is stored on the model. With consent, the form is valid only once the box accept is ticked. The notice is a translation (trusted text: rendered as HTML, so it may link to the privacy page). ContactType adds it through its privacy options.

const NOTICE = '@forms.privacy.notice'

PrivacyType::getBlockPrefix()

public function getBlockPrefix(): string

PrivacyType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

PrivacyType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

PrivacyType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

SecurityLoginTokenType class

class SecurityLoginTokenType extends AbstractType SecurityLoginTokenType.php:16

SecurityLoginTokenType::getBlockPrefix()

public function getBlockPrefix(): string

SecurityLoginTokenType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SecurityLoginTokenType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

SecurityLoginTokenType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SecurityLoginTwoFactorType class

class SecurityLoginTwoFactorType extends AbstractType SecurityLoginTwoFactorType.php:13

SecurityLoginTwoFactorType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SecurityLoginTwoFactorType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SecurityLoginType class

class SecurityLoginType extends AbstractType SecurityLoginType.php:17

SecurityLoginType::getBlockPrefix()

public function getBlockPrefix(): string

SecurityLoginType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SecurityLoginType::buildView()

public function buildView(FormView $view, FormInterface $form, array $options): void

SecurityLoginType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SecurityRegistrationType class

class SecurityRegistrationType extends AbstractType SecurityRegistrationType.php:17

SecurityRegistrationType::getBlockPrefix()

public function getBlockPrefix(): string

SecurityRegistrationType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

SecurityRegistrationType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SecurityResetPasswordConfirmType class

class SecurityResetPasswordConfirmType extends AbstractType SecurityResetPasswordConfirmType.php:11

SecurityResetPasswordConfirmType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

SecurityResetPasswordType class

class SecurityResetPasswordType extends AbstractType SecurityResetPasswordType.php:12

SecurityResetPasswordType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

The forms' guard (Base\Service\FormGuard): a trap, the time, the captcha - no list: the page answers the same for every address, and asks nothing of the address but where to write.

SecurityResetPasswordType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

ThreadSearchType class

class ThreadSearchType extends AbstractType ThreadSearchType.php:12

ThreadSearchType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ThreadSearchType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

ThreadSearchbarType class

class ThreadSearchbarType extends AbstractType ThreadSearchbarType.php:13

ThreadSearchbarType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

ThreadSearchbarType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

UserProfileType class

class UserProfileType extends AbstractType UserProfileType.php:14

UserProfileType::getBlockPrefix()

public function getBlockPrefix(): string

UserProfileType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

UserProfileType::buildForm()

public function buildForm(FormBuilderInterface $builder, array $options): void

UserSearchType class

class UserSearchType extends AbstractType UserSearchType.php:10

UserSearchType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

UserSettingsType class

class UserSettingsType extends AbstractType UserSettingsType.php:10

UserSettingsType::configureOptions()

public function configureOptions(OptionsResolver $resolver): void

Base\Imagine

FilterInterface interface

interface FilterInterface extends FilterInterface FilterInterface.php:5

FilterInterface::__toString()

public function __toString()

Base\Imagine\Filter

FormatFilterInterface interface

interface FormatFilterInterface extends FilterInterface FormatFilterInterface.php:8

FormatFilterInterface::getStandardExtension()

public static function getStandardExtension(): string

FormatFilterInterface::getPath()

public function getPath(): ?string

FormatFilterInterface::setPath()

public function setPath(?string $path)

FormatFilterInterface::getFilters()

public function getFilters()

FormatFilterInterface::addFilter()

public function addFilter(FilterInterface $filter)

FormatFilterInterface::apply()

public function apply(ImageInterface $image): ImageInterface

Base\Imagine\Filter\Advanced

SanitizeFilter class

class SanitizeFilter implements FilterInterface SanitizeFilter.php:10

SanitizeFilter::__toString()

public function __toString()

SanitizeFilter::__construct()

public function __construct()

SanitizeFilter::apply()

public function apply(ImageInterface $image): ImageInterface

Base\Imagine\Filter\Basic

BackgroundFilter class

class BackgroundFilter implements FilterInterface BackgroundFilter.php:13

BackgroundFilter::__toString()

public function __toString()

BackgroundFilter::__construct()

public function __construct(ImagineInterface $imagine, array $options = [])

BackgroundFilter::getRGB()

public function getRGB($hashtag = true): string

BackgroundFilter::getAlpha()

public function getAlpha(): float

BackgroundFilter::getRGBA()

public function getRGBA($hashtag = true): string

BackgroundFilter::getPosition()

public function getPosition(): string

BackgroundFilter::getSize()

public function getSize(): ?array

BackgroundFilter::getXY()

public function getXY(ImageInterface $image): array

BackgroundFilter::apply()

public function apply(ImageInterface $image): ImageInterface

{@inheritdoc}

CropFilter class

class CropFilter implements FilterInterface CropFilter.php:13

CropFilter::__toString()

public function __toString()

CropFilter::__construct()

public function __construct(float $x = 0, float $y = 0, ?float $width = null, ?float $height = null, string $position = "lefttop")

CropFilter::isNormalized()

public function isNormalized(): bool

CropFilter::getPosition()

public function getPosition(): string

CropFilter::getSize()

public function getSize(?ImageInterface $image = null): array

CropFilter::getXY()

public function getXY(?ImageInterface $image = null): array

CropFilter::apply()

public function apply(ImageInterface $image): ImageInterface

DownscaleFilter class

class DownscaleFilter extends ScaleFilter DownscaleFilter.php:5

DownscaleFilter::__toString()

public function __toString()

DownscaleFilter::__construct()

public function __construct()

FixedFilter class

class FixedFilter implements FilterInterface FixedFilter.php:13

FixedFilter::__toString()

public function __toString()

FixedFilter::__construct()

public function __construct(array $options = [])

FixedFilter::apply()

public function apply(ImageInterface $image): ImageInterface

FlipFilter class

class FlipFilter implements FilterInterface FlipFilter.php:13

FlipFilter::__toString()

public function __toString()

FlipFilter::__construct()

public function __construct(array $options = [])

FlipFilter::apply()

public function apply(ImageInterface $image): ImageInterface

InterlaceFilter class

class InterlaceFilter implements FilterInterface InterlaceFilter.php:8

InterlaceFilter::__toString()

public function __toString()

InterlaceFilter::__construct()

public function __construct(string $mode = ImageInterface::INTERLACE_LINE)

InterlaceFilter::apply()

public function apply(ImageInterface $image): ImageInterface

PasteFilter class

class PasteFilter implements FilterInterface PasteFilter.php:10

PasteFilter::__toString()

public function __toString()

PasteFilter::__construct()

public function __construct(ImageInterface $destination, int $x = 0, int $y = 0)

PasteFilter::apply()

public function apply(ImageInterface $image): ImageInterface

ResampleFilter class

class ResampleFilter implements FilterInterface ResampleFilter.php:18

ResampleFilter::__toString()

public function __toString()

ResampleFilter::__construct()

public function __construct(ImagineInterface $imagine, array $options = [])

ResampleFilter::apply()

public function apply(ImageInterface $image): ImageInterface

ResizeFilter class

class ResizeFilter implements FilterInterface ResizeFilter.php:10

ResizeFilter::__toString()

public function __toString()

ResizeFilter::__construct()

public function __construct(?int $width = null, ?int $height = null)

ResizeFilter::getSize()

public function getSize(): array

ResizeFilter::apply()

public function apply(ImageInterface $image): ImageInterface

RotateFilter class

class RotateFilter implements FilterInterface RotateFilter.php:8

RotateFilter::__toString()

public function __toString()

RotateFilter::__construct()

public function __construct(int $angle = 0)

RotateFilter::apply()

public function apply(ImageInterface $image): ImageInterface

ScaleFilter class

class ScaleFilter implements FilterInterface ScaleFilter.php:11

ScaleFilter::__toString()

public function __toString()

ScaleFilter::__construct()

public function __construct(array $options = [], $dimensionKey = 'dim', $ratioKey = 'to', $absoluteRatio = true)

ScaleFilter::apply()

public function apply(ImageInterface $image): ImageInterface

ThumbnailFilter class

class ThumbnailFilter implements FilterInterface ThumbnailFilter.php:10

ThumbnailFilter::__construct()

public function __construct(?int $width = null, ?int $height = null, $mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

ThumbnailFilter::__toString()

public function __toString()

ThumbnailFilter::apply()

public function apply(ImageInterface $image): ImageInterface

ThumbnailFilter::getWidth()

public function getWidth()

ThumbnailFilter::getHeight()

public function getHeight()

ThumbnailFilter::getMode()

public function getMode()

ThumbnailFilter::resize()

public function resize(BoxInterface $imageSize)

UpscaleFilter class

class UpscaleFilter extends ScaleFilter UpscaleFilter.php:5

UpscaleFilter::__toString()

public function __toString()

UpscaleFilter::__construct()

public function __construct()

WatermarkFilter class

class WatermarkFilter implements FilterInterface WatermarkFilter.php:12

WatermarkFilter::__toString()

public function __toString()

WatermarkFilter::__construct()

public function __construct(ImagineInterface $imagine, ImageInterface $watermark, array $options = [])

WatermarkFilter::apply()

public function apply(ImageInterface $image): ImageInterface

Base\Imagine\Filter\Basic\Definition

FullHighDefinitionFilter class

class FullHighDefinitionFilter extends ThumbnailFilter FullHighDefinitionFilter.php:8

FullHighDefinitionFilter::__toString()

public function __toString()

FullHighDefinitionFilter::__construct()

public function __construct($mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

HighDefinitionFilter class

class HighDefinitionFilter extends ThumbnailFilter HighDefinitionFilter.php:8

HighDefinitionFilter::__toString()

public function __toString()

HighDefinitionFilter::__construct()

public function __construct($mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

QuadHighDefinitionFilter class

class QuadHighDefinitionFilter extends ThumbnailFilter QuadHighDefinitionFilter.php:8

QuadHighDefinitionFilter::__toString()

public function __toString()

QuadHighDefinitionFilter::__construct()

public function __construct($mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

StandardDefinitionFilter class

class StandardDefinitionFilter extends ThumbnailFilter StandardDefinitionFilter.php:8

StandardDefinitionFilter::__toString()

public function __toString()

StandardDefinitionFilter::__construct()

public function __construct($mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

UltraHighDefinitionFilter class

class UltraHighDefinitionFilter extends ThumbnailFilter UltraHighDefinitionFilter.php:8

UltraHighDefinitionFilter::__toString()

public function __toString()

UltraHighDefinitionFilter::__construct()

public function __construct($mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)

Base\Imagine\Filter\Format

BitmapFilter class

class BitmapFilter implements BitmapFilterInterface BitmapFilter.php:10

BitmapFilter::getStandardExtension()

public static function getStandardExtension(): string

BitmapFilter::__toString()

public function __toString()

BitmapFilter::__construct()

public function __construct(?string $path = null, array $options = [], array $filters = [])

BitmapFilter::getFilters()

public function getFilters()

BitmapFilter::addFilter()

public function addFilter(FilterInterface $filter)

BitmapFilter::getPath()

public function getPath(): ?string

BitmapFilter::setPath()

public function setPath(?string $path)

BitmapFilter::getExtension()

public function getExtension()

BitmapFilter::apply()

public function apply(ImageInterface $image): ImageInterface

BitmapFilterInterface interface

interface BitmapFilterInterface extends FormatFilterInterface BitmapFilterInterface.php:7

SvgFilter class

class SvgFilter implements SvgFilterInterface SvgFilter.php:11

SvgFilter::getStandardExtension()

public static function getStandardExtension(): string

SvgFilter::__toString()

public function __toString()

SvgFilter::__construct()

public function __construct(?string $path = null, array $options = [], array $filters = [])

SvgFilter::getFilters()

public function getFilters()

SvgFilter::addFilter()

public function addFilter(FilterInterface $filter)

SvgFilter::getPath()

public function getPath(): ?string

SvgFilter::setPath()

public function setPath(?string $path)

SvgFilter::getExtension()

public function getExtension()

SvgFilter::apply()

public function apply(ImageInterface $image): ImageInterface

SvgFilterInterface interface

interface SvgFilterInterface extends FormatFilterInterface SvgFilterInterface.php:7

WebpFilter class

class WebpFilter extends WebOptimization implements BitmapFilterInterface WebpFilter.php:11

WebpFilter::getStandardExtension()

public static function getStandardExtension(): string

WebpFilter::__toString()

public function __toString()

WebpFilter::getFilters()

public function getFilters()

WebpFilter::addFilter()

public function addFilter(FilterInterface $filter)

WebpFilter::__construct()

public function __construct(?string $path = null, array $options = [], array $filters = [])

WebpFilter::getPath()

public function getPath(): ?string

WebpFilter::setPath()

public function setPath(?string $path)

WebpFilter::apply()

public function apply(ImageInterface $image): ImageInterface

Base\Imagine\Svg

Box class

class Box implements ImageBoxInterface Box.php:11

const TYPE_ABSOLUTE = 0
const TYPE_ASPECT_RATIO = 1
const TYPE_NONE = 2

Box::__construct()

public function __construct(int $width, int $height, int $type = self::TYPE_ABSOLUTE)

Box::__toString()

public function __toString(): string

Box::createTypeAbsolute()

public static function createTypeAbsolute(int $width, int $height): self

Box::createTypeAspectRatio()

public static function createTypeAspectRatio(int $width, int $height): self

Box::createTypeNone()

public static function createTypeNone(): self

Box::getType()

public function getType(): int
Returns

one of the SvgImageBox::TYPE_* constants

Box::getWidth()

public function getWidth(): int

Box::getHeight()

public function getHeight(): int

Box::scale()

public function scale($ratio): self

Box::increase()

public function increase($size): self

Box::contains()

public function contains(ImageBoxInterface $box, PointInterface $start = null): bool

Box::square()

public function square(): int

Box::widen()

public function widen($width): self

Box::heighten()

public function heighten($height): self

Effects class

class Effects implements EffectsInterface Effects.php:16

Effects::__construct()

public function __construct(DOMDocument $document)

Effects::gamma()

public function gamma($correction): self

Effects::negative()

public function negative(): self

Effects::grayscale()

public function grayscale(): self

Effects::colorize()

public function colorize(ColorInterface $color): self

Effects::sharpen()

public function sharpen(): self

Effects::blur()

public function blur($sigma = 1): self

Effects::brightness()

public function brightness($brightness): self

Effects::convolve()

public function convolve(Matrix $matrix): self

Image class

class Image extends AbstractImage Image.php:26

Image::__construct()

public function __construct(DOMDocument $document, MetadataBag $metadata)

Image::__destruct()

public function __destruct()

Image::__toString()

public function __toString(): string

Image::__clone()

public function __clone()

Assures the DOM document instance will be cloned too.

Image::getDomDocument()

public function getDomDocument(): DOMDocument

Returns the DOM document.

Image::copy()

public function copy(): self

Image::crop()

public function crop(PointInterface $start, BoxInterface $size): self

Image::paste()

public function paste(ImageInterface $image, PointInterface $start, $alpha = 100): self

Image::sanitize()

public function sanitize()

Image::resize()

public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDEFINED): self

Image::thumbnail()

public function thumbnail(BoxInterface $size, $settings = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED): self

Image::rotate()

public function rotate($angle, ColorInterface $background = null): self

Image::save()

public function save($path = null, array $options = []): self

Image::show()

public function show($format, array $options = []): self

Image::get()

public function get($format, array $options = []): string

Image::flipHorizontally()

public function flipHorizontally(): self

Image::flipVertically()

public function flipVertically(): self

Image::strip()

public function strip(): self

Image::draw()

public function draw(): DrawerInterface

Image::effects()

public function effects(): Effects

Image::getSize()

public function getSize(): Box

Image::applyMask()

public function applyMask(ImageInterface $mask): self

Image::fill()

public function fill(FillInterface $fill): self

Image::mask()

public function mask(): self

Image::histogram()

public function histogram(): array

Image::getColorAt()

public function getColorAt(PointInterface $point): ColorInterface

Image::layers()

public function layers(): LayersInterface

Image::interlace()

public function interlace($scheme): self

Image::palette()

public function palette(): PaletteInterface

Image::profile()

public function profile(ProfileInterface $profile): self

Image::usePalette()

public function usePalette(PaletteInterface $palette): self

Imagine class

class Imagine extends AbstractImagine Imagine.php:17

Imagine::create()

public function create(ImageBoxInterface $size, ?ColorInterface $color = null): Image

Imagine::open()

public function open($path): Image

Imagine::load()

public function load($string): Image

Imagine::read()

public function read($resource): Image

Imagine::font()

public function font($file, $size, ColorInterface $color): FontInterface

Base\Inspector

DoctrineDataCollector class

class DoctrineDataCollector extends DataCollector DoctrineDataCollector.php:9

DoctrineDataCollector::__construct()

public function __construct(DoctrineDataCollector $innerCollector)

DoctrineDataCollector::collect()

public function collect(Request $request, Response $response, ?\Throwable $exception = null): void

DoctrineDataCollector::getName()

public function getName(): string

FileLinkFormatter class

class FileLinkFormatter extends SymfonyFileLinkFormatter FileLinkFormatter.php:7

FileLinkFormatter::format()

public function format(string $file, int $line): string|false

HtmlErrorRenderer class

class HtmlErrorRenderer extends SymfonyHtmlErrorRenderer HtmlErrorRenderer.php:8

HtmlErrorRenderer::__construct()

public function __construct(bool|callable $debug = false, ?string $charset = null, string|FileLinkFormatter|null $fileLinkFormat = null, ?string $projectDir = null, string|callable $outputBuffer = '', ?LoggerInterface $logger = null)

LocalizerDataCollector class

class LocalizerDataCollector extends AbstractDataCollector LocalizerDataCollector.php:12

LocalizerDataCollector::__construct()

public function __construct(LocalizerInterface $localizer)

LocalizerDataCollector::getName()

public function getName(): string

LocalizerDataCollector::getTemplate()

public static function getTemplate(): ?string

LocalizerDataCollector::getData()

public function getData(): array

LocalizerDataCollector::getLocale()

public function getLocale()

LocalizerDataCollector::collect()

public function collect(Request $request, Response $response, $exception = null): void

Base\Mailer

MailTrap class

class MailTrap MailTrap.php:27

A hold-everything switch for outgoing mail, meant for the minutes after a hotfix when you are not yet sure the site is sending the right things to the right people.

While it is armed nothing leaves: each message is written to disk instead, where it can be read, deleted, or released once you have decided. That is the difference from simply stopping the worker - a stopped worker holds mail you cannot see, and a purge then means emptying the whole queue rather than the three messages that were wrong.

Deliberately file-backed rather than a database table or a setting: this has to work in exactly the situations where you distrust the application - a bad migration, a half-applied hotfix, a broken cache - so it must not need the schema to be sound, and it must survive a cache:clear. var/ persists across deploys here; var/cache does not.

MailTrap::__construct()

public function __construct(readonly string $directory)

MailTrap::isBypassed()

public function isBypassed(): bool

MailTrap::bypass()

public function bypass(callable $send): mixed

MailTrap::isArmed()

public function isArmed(): bool

MailTrap::armedDetails()

public function armedDetails(): ?array

MailTrap::arm()

public function arm(?string $reason = null): void

MailTrap::disarm()

public function disarm(): void

MailTrap::capture()

public function capture(RawMessage $message, Envelope $envelope): string

Writes one message aside instead of sending it.

The serialized message is kept alongside a readable summary: the summary is what an operator scans under pressure, the serialized form is what release() needs to send the real thing rather than a reconstruction of it.

MailTrap::all()

public function all(): array

MailTrap::read()

public function read(string $id): ?array

The held message, rebuilt as a transport can send it.

MailTrap::forget()

public function forget(string $id): bool

MailTrap::getDirectory()

public function getDirectory(): string

Base\Notifier

NotificationLinkerInterface interface

interface NotificationLinkerInterface NotificationLinkerInterface.php:14

Turns a notification's target (class + id, see Notification::setTarget()) into a back-office URL. base-bundle ships a null implementation; the admin bundle replaces it with one that knows its CRUD routes, so a notification opened from the back-office lands on the record's edit page while the same notification on the front-end keeps its public URL.

NotificationLinkerInterface::adminUrl()

public function adminUrl(Notification $notification): ?string

Notifier class

class Notifier extends BaseNotifier implements NotifierInterface Notifier.php:15

Notifier::testEmail()

public function testEmail(User $user): Notification

Notifier::contactEmail()

public function contactEmail(ContactModel $contactModel)

Notifier::contactEmailConfirmation()

public function contactEmailConfirmation(ContactModel $contactModel)

Notifier::userAccountGoodbye()

public function userAccountGoodbye(User $user)

Notifier::userApprovalRequest()

public function userApprovalRequest(User $user)

Notifier::userApprovalConfirmation()

public function userApprovalConfirmation(User $user)

Notifier::accountCreated()

public function accountCreated(User $user, string $password)

An account made for someone (user:create): its username, its temporary password - to be changed at the first sign-in - and the way in.

Notifier::resetPasswordRequest()

public function resetPasswordRequest(User $user, Token $token)

Notifier::verificationEmail()

public function verificationEmail(User $user, Token $token)

Notifier::loginToken()

public function loginToken(User $user, Token $token)

Notifier::userWelcomeBack()

public function userWelcomeBack(User $user, Token $token)

NotifierInterface interface

interface NotifierInterface extends BaseNotifierInterface NotifierInterface.php:9

NotifierInterface::testEmail()

public function testEmail(User $user): Notification

NullNotificationLinker class

final class NullNotificationLinker implements NotificationLinkerInterface NullNotificationLinker.php:8

No back-office installed: there is no admin page to link to.

NullNotificationLinker::adminUrl()

public function adminUrl(Notification $notification): ?string

Base\Notifier\Abstract

BaseNotificationInterface interface

interface BaseNotificationInterface BaseNotificationInterface.php:8

BaseNotificationInterface::__toPrune()

public function __toPrune(?RecipientInterface $recipient = null): SymfonyNotification

BaseNotificationInterface::render()

public function render()

The notification as a page: Symfony's Response under Symfony (Base\Entity\User\Notification gives Base\Bridge\Symfony\NotificationMessages::response()). Untyped since step C3f of the plan "omnibase agnostique", so that the interface names nothing of the framework; an implementation typed : Response stays compatible.

BaseNotificationInterface::send()

public function send(string $importance, RecipientInterface ...$recipients)

BaseNotifier class

abstract class BaseNotifier implements BaseNotifierInterface, LoggerAwareInterface BaseNotifier.php:47

BaseNotifier::__call()

public function __call($method, $arguments): mixed

BaseNotifier::getOptions()

public function getOptions(): array

BaseNotifier::getTestRecipients()

public function getTestRecipients(): array

BaseNotifier::getEnvironment()

public function getEnvironment(): Environment

BaseNotifier::__construct()

public function __construct(SymfonyNotifierInterface $notifier, ChannelPolicyInterface $policy, EntityManagerInterface $entityManager, ParameterBagInterface $parameterBag, TranslatorInterface $translator, LocalizerInterface $localizer, AdvancedRouterInterface $router, Environment $twig, SettingBag $settingBag, bool $debug = false)

BaseNotifier::getPolicy()

public function getPolicy(): ChannelPolicyInterface

BaseNotifier::hasLoopback()

public function hasLoopback(): bool

BaseNotifier::isTest()

public function isTest(Recipient $recipient): bool

BaseNotifier::getAdminRecipient()

public function getAdminRecipient($i = 0): ?RecipientInterface

BaseNotifier::getAdminRecipients()

public function getAdminRecipients(): array

BaseNotifier::getTechnicalRecipient()

public function getTechnicalRecipient(): Recipient

BaseNotifier::isMarkAsAdmin()

public function isMarkAsAdmin()

BaseNotifier::markAsAdmin()

public function markAsAdmin(bool $markAsAdmin, ?Notification $notification = null)

BaseNotifier::enable()

public function enable()

BaseNotifier::disable()

public function disable()

BaseNotifier::getTranslator()

public function getTranslator(): TranslatorInterface

BaseNotifier::setTranslator()

public function setTranslator(TranslatorInterface $translator)

BaseNotifier::getRouter()

public function getRouter(): AdvancedRouterInterface

BaseNotifier::setRouter()

public function setRouter(AdvancedRouterInterface $router)

BaseNotifier::getDefaultChannels()

public function getDefaultChannels(string $importance)

BaseNotifier::send()

public function send(SymfonyNotification $notification, RecipientInterface ...$recipients): void

BaseNotifier::sendUsers()

public function sendUsers(Notification $notification, RecipientInterface ...$recipients)
Throws

Exception

BaseNotifier::sendUsersBy()

public function sendUsersBy(array $channels, Notification $notification, ...$recipients)

BaseNotifier::sendAdmins()

public function sendAdmins(Notification $notification)

BaseNotifierInterface interface

interface BaseNotifierInterface extends NotifierInterface BaseNotifierInterface.php:12

BaseNotifierInterface::sendUsers()

public function sendUsers(Notification $notification, Recipient ...$recipients)

BaseNotifierInterface::sendUsersBy()

public function sendUsersBy(array $channels, Notification $notification, Recipient ...$recipients)

BaseNotifierInterface::sendAdmins()

public function sendAdmins(Notification $notification)

BaseNotifierInterface::getTestRecipients()

public function getTestRecipients(): array

BaseNotifierInterface::getAdminRecipients()

public function getAdminRecipients(): array

BaseNotifierInterface::getTechnicalRecipient()

public function getTechnicalRecipient(): ?Recipient

BaseNotifierInterface::hasLoopback()

public function hasLoopback(): bool

BaseNotifierInterface::isTest()

public function isTest(Recipient $recipient): bool

BaseNotifierInterface::getPolicy()

public function getPolicy(): ChannelPolicyInterface

BaseNotifierInterface::getOptions()

public function getOptions(): array

BaseNotifierInterface::getTranslator()

public function getTranslator(): TranslatorInterface

BaseNotifierInterface::getEnvironment()

public function getEnvironment(): Environment

BaseNotifierInterface::enable()

public function enable()

BaseNotifierInterface::disable()

public function disable()

Base\Notifier\Channel

BrowserPlusChannel class

final class BrowserPlusChannel implements ChannelInterface BrowserPlusChannel.php:10

BrowserPlusChannel::__construct()

public function __construct(RequestStack $requestStack)

BrowserPlusChannel::supports()

public function supports(Notification $notification, RecipientInterface $recipient): bool

BrowserPlusChannel::notify()

public function notify(Notification $notification, RecipientInterface $recipient, ?string $transportName = null): void

EmailPlusChannel class

final class EmailPlusChannel extends EmailChannel EmailPlusChannel.php:16

InAppChannel class

class InAppChannel implements ChannelInterface InAppChannel.php:27

The "inapp" channel: keeps a copy of the notification in the recipient's notification list (userNotification), which is what the bell in the toolbar and the back-office reads. Nothing else in the notifier persists a Notification - it is built, sent over its channels and dropped - so this channel is the one place a notification becomes a row.

One row per user: the notifier calls a channel once per recipient with the same Notification object, so the object itself cannot be the row (it has a single user). A detached copy is stored instead, carrying only what the list needs. Recipients that are not users (anonymous newsletter subscribers) have no list to write to and are skipped.

InAppChannel::__construct()

public function __construct(protected readonly EntityManagerInterface $entityManager)

InAppChannel::supports()

public function supports(SymfonyNotification $notification, RecipientInterface $recipient): bool

Always true - see PushChannel::supports(). Symfony's Notifier throws on false instead of skipping the channel, so a recipient that is not a user (a plain newsletter e-mail address) would abort the whole send. notify() already ignores non-user recipients and foreign notification classes.

InAppChannel::notify()

public function notify(SymfonyNotification $notification, RecipientInterface $recipient, ?string $transportName = null): void

InAppChannel::userOf()

public function userOf(RecipientInterface $recipient): ?User

PushChannel class

class PushChannel implements ChannelInterface PushChannel.php:16

The "push" channel: a Web Push message to every browser the recipient enabled notifications in. Silent when VAPID keys are not configured or the recipient is not a user, so a policy can list it unconditionally.

PushChannel::__construct()

public function __construct(protected readonly WebPushService $webPush, protected readonly InAppChannel $inApp)

PushChannel::supports()

public function supports(SymfonyNotification $notification, RecipientInterface $recipient): bool

Always true, and that is the whole point of "silent".

Symfony's Notifier does not skip a channel whose supports() returns false: it throws LogicException('The "push" channel is not supported.') and aborts the ENTIRE send. This used to return isConfigured() && a user, so on a host without VAPID keys every "notify" send threw. In production that killed thread:publishable on every run - the announcement runs inside the cron's flush, the exception rolled the whole transaction back, and a scheduled article stayed unpublished, retried and rolled back every 5 minutes. The "nothing to do" cases are handled in notify() instead.

PushChannel::notify()

public function notify(SymfonyNotification $notification, RecipientInterface $recipient, ?string $transportName = null): void

Base\Notifier\Recipient

LocaleRecipientInterface interface

interface LocaleRecipientInterface extends RecipientInterface LocaleRecipientInterface.php:7

LocaleRecipientInterface::getLocale()

public function getLocale(): string

LocaleRecipientTrait trait

trait LocaleRecipientTrait LocaleRecipientTrait.php:5

LocaleRecipientTrait::getLocale()

public function getLocale(): string

Recipient class

class Recipient extends Recipient implements LocaleRecipientInterface, TimezoneRecipientInterface Recipient.php:7

Recipient::__toString()

public function __toString()

Recipient::__construct()

public function __construct(?string $email = null, ?string $phone = null, ?string $locale = null, ?string $timezone = null)

Recipient::locale()

public function locale(string $locale): self

Recipient::timezone()

public function timezone(string $timezone): self

TimezoneRecipientInterface interface

interface TimezoneRecipientInterface extends RecipientInterface TimezoneRecipientInterface.php:7

TimezoneRecipientInterface::getTimezone()

public function getTimezone(): string

TimezoneRecipientTrait trait

trait TimezoneRecipientTrait TimezoneRecipientTrait.php:5

TimezoneRecipientTrait::getTimezone()

public function getTimezone(): string

Base\Repository

ThreadIntlRepository class

class ThreadIntlRepository extends ServiceEntityRepository ThreadIntlRepository.php:15

ThreadRepository class

class ThreadRepository extends ServiceEntityRepository ThreadRepository.php:17

ThreadRepository::countForChildrenIn()

public function countForChildrenIn($thread)

ThreadRepository::cacheByInsensitiveIdentifier()

public function cacheByInsensitiveIdentifier($identifier, array $fields = [])

ThreadRepository::findByInsensitiveIdentifier()

public function findByInsensitiveIdentifier($identifier, array $fields = [], $cacheable = false)

UserRepository class

class UserRepository extends ServiceEntityRepository implements UserLoaderInterface, UserProviderInterface, PasswordUpgraderInterface UserRepository.php:22

UserRepository::supportsClass()

public function supportsClass(string $class): bool

UserRepository::loadUserByIdentifier()

public function loadUserByIdentifier(string $identifier): UserInterface

UserRepository::refreshUser()

public function refreshUser(UserInterface $user): UserInterface

UserRepository::upgradePassword()

public function upgradePassword(PasswordAuthenticatedUserInterface $user, string $newHashedPassword): void

UserRepository::findActiveAdmins()

public function findActiveAdmins(int $onlineDelay, ?int $excludeId = null): array

OTHER admins (own ROLE_ADMIN/ROLE_SUPERADMIN column, not group- inherited - a LIKE on the raw SET column can't see those without joining group membership, and this is a "who else is around right now" indicator, not a security check) active within the last $onlineDelay seconds, most recently active first. $excludeId is meant to be the current viewer - matches the one pre-existing precedent for this kind of query (the older, currently-inert AnalyticsSubscriber's findByIdNotEqualToAndActiveAtYoungerThan()).

UserRepository::cacheByInsensitiveIdentifier()

public function cacheByInsensitiveIdentifier($identifier, array $fields = [])

UserRepository::findByInsensitiveIdentifier()

public function findByInsensitiveIdentifier($identifier, array $fields = [], $cacheable = false)

Base\Repository\Analytics

PageViewRepository class

class PageViewRepository extends ServiceEntityRepository PageViewRepository.php:13

PageViewRepository::incrementView()

public function incrementView(string $path, \DateTimeImmutable $date, string $source = PageView::SOURCE_HUMAN): void

Atomic increment, not a load-modify-flush cycle - two concurrent requests hitting the same page the same HOUR must both count, not race and silently drop one. Native upsert rather than a Doctrine entity round-trip: ON DUPLICATE KEY UPDATE on MySQL/MariaDB (the applications' database), ON CONFLICT on SQLite and PostgreSQL (the omnibase harness runs on SQLite). $source is part of the unique key now (see PageView's docblock), so human/bot/ai hits on the same page the same hour land in three separate rows rather than one blended count.

$date is bucketed down to the top of its hour here (minutes/seconds zeroed) rather than trusting every caller to already pass an hour-aligned value - Analytics::track() passes the raw "now", not something pre-bucketed, same as it used to pass a raw "today" before PageView moved from daily to hourly grain.

PageViewRepository::countViews()

public function countViews(?string $path = null, ?\DateTimeImmutable $since = null, ?string $source = null): int

Sums the daily rows in range - $path null means every page (a site-wide total), $since null means all-time (no lower bound), $source null means every source (human + bot + ai combined, the pre-existing "total hits" semantics); pass a PageView::SOURCE_* constant to see just that bucket.

PageViewRepository::earliestDate()

public function earliestDate(): ?\DateTimeImmutable

The earliest recorded DAY, site-wide - what "all time" actually means for dailyBreakdown()'s $days=null case (there's no data before this, so generating a series further back would just be rows of zeroes). Null if nothing has ever been tracked.

Truncated to midnight even though the underlying column is now hour-grained - Analytics::dailyBreakdown()'s "all time" day-count (a plain calendar diff against today) would be thrown off by whatever hour the earliest row happens to carry otherwise.

PageViewRepository::dailyBreakdown()

public function dailyBreakdown(\DateTimeImmutable $since, string|array|null $path = null): array
$path

a single path (exact match), a list of paths (any-of match - e.g. every Article's own __toLink(), for a whole-class rollup rather than one instance), or null for site-wide

PageViewRepository::dailyBreakdownBySource()

public function dailyBreakdownBySource(\DateTimeImmutable $since, string|array|null $path = null): array
$path

see dailyBreakdown()'s own docblock

PageViewRepository::hourlyBreakdown()

public function hourlyBreakdown(\DateTimeImmutable $since, string|array|null $path = null): array
$path

see dailyBreakdown()'s own docblock

PageViewRepository::hourlyBreakdownBySource()

public function hourlyBreakdownBySource(\DateTimeImmutable $since, string|array|null $path = null): array
$path

see dailyBreakdown()'s own docblock

PageVisitRepository class

class PageVisitRepository extends ServiceEntityRepository PageVisitRepository.php:12

PageVisitRepository::recordPresence()

public function recordPresence(string $path, string $subjectType, string $subjectId, \DateTimeImmutable $date): void

Insert-if-absent, bucketed to the hour - same contract as VisitRepository::recordPresence(), with the page added.

PageVisitRepository::countUnique()

public function countUnique(?\DateTimeImmutable $since = null, string|array|null $path = null): int

Unique views over the window: distinct (page, subject) pairs. A reader reloading one page is one unique view; the same reader on two pages is two. Rows are hourly, so this counts DISTINCT pairs, never rows - over a DISTINCT subquery, since COUNT(DISTINCT a, b, c) is MySQL's alone.

PageVisitRepository::dailyBreakdown()

public function dailyBreakdown(\DateTimeImmutable $since, string|array|null $path = null): array

One entry per calendar day: distinct (page, subject) pairs seen that day. A reader coming back to the same page on another day counts again on that day - the right answer for a trend line, as with VisitRepository::dailyBreakdown().

Returns

date (Y-m-d) => unique views

PageVisitRepository::hourlyBreakdown()

public function hourlyBreakdown(\DateTimeImmutable $since, string|array|null $path = null): array
Returns

hour ("Y-m-d H:i:s") => unique views

VisitRepository class

class VisitRepository extends ServiceEntityRepository VisitRepository.php:12

VisitRepository::recordPresence()

public function recordPresence(string $subjectType, string $subjectId, \DateTimeImmutable $date): void

Insert-if-absent, not insert-or-update: a presence row only ever needs to exist once per (hour, subject) - a second sighting the same hour is a silent no-op, not an update. INSERT IGNORE (rather than a SELECT-then-INSERT round trip) makes that race-safe under concurrent requests from the same subject too.

$date is bucketed down to the top of its hour here, same reasoning as PageViewRepository::incrementView()'s own bucketing.

VisitRepository::insertIgnore()

public static function insertIgnore(\Doctrine\DBAL\Connection $connection, string $into): string

"INSERT IGNORE INTO $into" on MySQL/MariaDB; elsewhere (SQLite, the harness's database, and PostgreSQL) the same through ON CONFLICT DO NOTHING - one row per unique key, a duplicate silently skipped.

VisitRepository::countUnique()

public function countUnique(string $subjectType, ?\DateTimeImmutable $since = null): int

True unique count over the window (not an approximation): each subject contributes at most one row per day it was seen, so COUNT(DISTINCT subject_id) across the date range never double-counts a subject who returned on multiple days within it.

VisitRepository::returning()

public function returning(string $subjectType, \DateTimeImmutable $previousSince, \DateTimeImmutable $currentSince): array

Retention: of the subjects seen in [$previousSince, $currentSince), how many were seen again from $currentSince on.

Both numbers come from one scan rather than two queries, so they cannot disagree about who "previous" was. A subject first seen in the current window is not in either count - retention is about coming BACK, and a newcomer has nothing to come back to.

VisitRepository::dailyBreakdown()

public function dailyBreakdown(string $subjectType, \DateTimeImmutable $since): array

One row per calendar day in range - unlike countUnique() (a single total over the whole window), a subject seen on multiple days within range legitimately contributes to EACH of those days here; that's the correct semantics for "how many distinct subjects were active on day X", which is what a trend chart needs.

Raw SQL, same reason as PageViewRepository::dailyBreakdown(): folding this table's own hourly rows back down to one row per DAY needs DATE(date), which DQL has no built-in function for.

Returns

date (Y-m-d) => distinct subject count

VisitRepository::hourlyBreakdown()

public function hourlyBreakdown(string $subjectType, \DateTimeImmutable $since): array

One row per HOUR in range - the hourly counterpart to dailyBreakdown(), for the one range ("today") an hour-by-hour curve is actually legible for. No zero-fill here, same division of responsibility as PageViewRepository::hourlyBreakdown() vs Analytics::hourlyBreakdown().

Returns

hour ("Y-m-d H:i:s") => distinct subject count

Base\Repository\Extension

LogRepository class

class LogRepository extends ServiceEntityRepository LogRepository.php:14

OrderingRepository class

class OrderingRepository extends ServiceEntityRepository OrderingRepository.php:14

RevisionRepository class

class RevisionRepository extends ServiceEntityRepository RevisionRepository.php:14

RevisionRepository::history()

public function history(string $entityClass, int $entityId, ?int $limit = null): array

History of one entity, newest first.

Ordered by id, not createdAt: the id is the insertion sequence and is strictly monotonic, whereas two revisions written in the same second are otherwise unorderable - and #[Timestamp] has been seen to hand out timestamps that disagree with insertion order outright.

RevisionRepository::obsoleteIds()

public function obsoleteIds(string $entityClass, int $entityId, int $keep): array

Ids falling outside the newest $keep revisions of an entity.

Returns ids rather than entities so the caller can DELETE them in one statement: trimming runs on every versioned save, and hydrating a history only to discard it would make each save pay for the whole history it is about to shorten.

TrashBallRepository class

class TrashBallRepository extends ServiceEntityRepository TrashBallRepository.php:16

TrashBallRepository::contents()

public function contents(?string $entityClass = null, ?int $limit = null, int $offset = 0): array

Everything currently in the trash, newest first.

TrashBallRepository::countContents()

public function countContents(?string $entityClass = null): int

TrashBallRepository::expired()

public function expired(?DateTimeInterface $now = null, ?int $limit = null): array

Trash entries whose grace period has run out - what the purge destroys.

TrashBallRepository::forEntity()

public function forEntity(string $entityClass, int $entityId): ?TrashBall

The trash entry standing for one entity, if it is in the trash.

Base\Repository\Extension\Abstract

AbstractExtensionRepository class

abstract class AbstractExtensionRepository extends ServiceEntityRepository AbstractExtensionRepository.php:14

Base\Repository\Hours

ScopedWeekRepository class

class ScopedWeekRepository extends ServiceEntityRepository ScopedWeekRepository.php:12

ScopedWeekRepository::ofScope()

public function ofScope(string $scope): ?ScopedWeek

ScopedWeekRepository::week()

public function week(string $scope): ?array
Returns

the place's week, all seven days; null: it follows the site's

ScopedWeekRepository::save()

public function save(string $scope, array $week): ScopedWeek
$week

ISO day => hours

ScopedWeekRepository::forget()

public function forget(string $scope): void

Back to the site's week.

SpecialDayRepository class

class SpecialDayRepository extends ServiceEntityRepository SpecialDayRepository.php:12

SpecialDayRepository::upcoming()

public function upcoming(\DateTimeInterface $from, int $limit = 50, ?string $scope = null): array
$scope

the place's own; null: the whole site's

Returns

those not over by $from, soonest first

WeekDayHoursRepository class

class WeekDayHoursRepository extends ServiceEntityRepository WeekDayHoursRepository.php:12

WeekDayHoursRepository::week()

public function week(): array
Returns

ISO day => hours; empty when never set

WeekDayHoursRepository::save()

public function save(array $week): void
$week

all seven days, ISO day => hours

Base\Repository\Layout

AttributeRepository class

class AttributeRepository extends ServiceEntityRepository AttributeRepository.php:16

ImageCropRepository class

class ImageCropRepository extends ServiceEntityRepository ImageCropRepository.php:16

ImageCropRepository::__construct()

public function __construct(ManagerRegistry $registry)

ImageRepository class

class ImageRepository extends ServiceEntityRepository ImageRepository.php:16

ImageRepository::__construct()

public function __construct(ManagerRegistry $registry)

RedirectionRepository class

class RedirectionRepository extends ServiceEntityRepository RedirectionRepository.php:13

RedirectionRepository::forAddress()

public function forAddress(string $address): ?Redirection

The redirection for an address (Redirection::normalize()): the one written for it with its query, then for its path alone, then the longest prefix ("/a/b/*" before "/a/*") that covers it.

RedirectionRepository::hit()

public function hit(Redirection $redirection): void

One more visitor carried: counted in the database, whatever else the request holds.

SemanticRepository class

class SemanticRepository extends ServiceEntityRepository SemanticRepository.php:16

SettingRepository class

class SettingRepository extends ServiceEntityRepository SettingRepository.php:16

ShortLinkRepository class

class ShortLinkRepository extends ServiceEntityRepository ShortLinkRepository.php:16

TextOverrideRepository class

class TextOverrideRepository extends ServiceEntityRepository TextOverrideRepository.php:12

TextOverrideRepository::map()

public function map(): array
Returns

every rewritten text, by "domain|locale|key"

TooltipRepository class

class TooltipRepository extends ServiceEntityRepository TooltipRepository.php:16

WidgetRepository class

class WidgetRepository extends ServiceEntityRepository WidgetRepository.php:16

Base\Repository\Layout\Attribute

HyperlinkRepository class

class HyperlinkRepository extends AttributeRepository HyperlinkRepository.php:16

Base\Repository\Layout\Attribute\Adapter

ArrayAdapterRepository class

class ArrayAdapterRepository extends AbstractAdapterRepository ArrayAdapterRepository.php:16

ColorAdapterRepository class

class ColorAdapterRepository extends AbstractAdapterRepository ColorAdapterRepository.php:16

CountryAdapterRepository class

class CountryAdapterRepository extends AbstractAdapterRepository CountryAdapterRepository.php:16

DateRangeAdapterRepository class

class DateRangeAdapterRepository extends ServiceEntityRepository DateRangeAdapterRepository.php:14

DateTimeAdapterRepository class

class DateTimeAdapterRepository extends AbstractAdapterRepository DateTimeAdapterRepository.php:16

HyperpatternAdapterRepository class

class HyperpatternAdapterRepository extends AbstractAdapterRepository HyperpatternAdapterRepository.php:16

ImageAdapterRepository class

class ImageAdapterRepository extends AbstractAdapterRepository ImageAdapterRepository.php:16

MoneyAdapterRepository class

class MoneyAdapterRepository extends AbstractAdapterRepository MoneyAdapterRepository.php:16

NumberAdapterRepository class

class NumberAdapterRepository extends AbstractAdapterRepository NumberAdapterRepository.php:16

PercentAdapterRepository class

class PercentAdapterRepository extends AbstractAdapterRepository PercentAdapterRepository.php:16

ScalarAdapterRepository class

class ScalarAdapterRepository extends AbstractAdapterRepository ScalarAdapterRepository.php:16

ScoreAdapterRepository class

class ScoreAdapterRepository extends ServiceEntityRepository ScoreAdapterRepository.php:14

TextAdapterRepository class

class TextAdapterRepository extends AbstractAdapterRepository TextAdapterRepository.php:16

TextareaAdapterRepository class

class TextareaAdapterRepository extends AbstractAdapterRepository TextareaAdapterRepository.php:16

Base\Repository\Layout\Attribute\Adapter\Common

AbstractActionAdapterRepository class

class AbstractActionAdapterRepository extends AbstractAdapterRepository AbstractActionAdapterRepository.php:13

AbstractAdapterRepository class

class AbstractAdapterRepository extends ServiceEntityRepository AbstractAdapterRepository.php:16

AbstractRuleAdapterRepository class

class AbstractRuleAdapterRepository extends AbstractAdapterRepository AbstractRuleAdapterRepository.php:14

AbstractScopeAdapterRepository class

class AbstractScopeAdapterRepository extends AbstractAdapterRepository AbstractScopeAdapterRepository.php:14

Base\Repository\Layout\Attribute\Common

AbstractActionRepository class

class AbstractActionRepository extends ServiceEntityRepository AbstractActionRepository.php:16

AbstractAttributeRepository class

class AbstractAttributeRepository extends ServiceEntityRepository AbstractAttributeRepository.php:16

AbstractRuleRepository class

class AbstractRuleRepository extends ServiceEntityRepository AbstractRuleRepository.php:16

AbstractScopeRepository class

class AbstractScopeRepository extends ServiceEntityRepository AbstractScopeRepository.php:16

Base\Repository\Layout\Widget

AttachmentRepository class

class AttachmentRepository extends WidgetRepository AttachmentRepository.php:16

LinkRepository class

class LinkRepository extends WidgetRepository LinkRepository.php:16

PageRepository class

class PageRepository extends WidgetRepository PageRepository.php:16

RouteRepository class

class RouteRepository extends WidgetRepository RouteRepository.php:16

SlotRepository class

class SlotRepository extends WidgetRepository SlotRepository.php:15

Base\Repository\Layout\Widget\Set

BookRepository class

class BookRepository extends WidgetRepository BookRepository.php:16

LinksetRepository class

class LinksetRepository extends WidgetRepository LinksetRepository.php:16

MenuRepository class

class MenuRepository extends WidgetRepository MenuRepository.php:16

NetworkRepository class

class NetworkRepository extends WidgetRepository NetworkRepository.php:16

PaperclipRepository class

class PaperclipRepository extends WidgetRepository PaperclipRepository.php:16

Base\Repository\Thread

CommentRepository class

class CommentRepository extends ServiceEntityRepository CommentRepository.php:15

CommentRepository::findVisible()

public function findVisible(?Thread $thread, int $limit = 200): array

The comments online under a thread - or the visitors' book when $thread is null -, the top-level ones, newest first; their replies hang under each (Comment::getVisibleReplies()).

CommentRepository::countVisible()

public function countVisible(?Thread $thread): int

CommentRepository::countPending()

public function countPending(): int

CommentRepository::findPending()

public function findPending(int $limit = 20): array

CommentRepository::findLastFromIp()

public function findLastFromIp(string $ip): ?Comment

The last comment this address left, to hold the flood interval.

LikeRepository class

class LikeRepository extends ServiceEntityRepository LikeRepository.php:15

MentionRepository class

class MentionRepository extends ServiceEntityRepository MentionRepository.php:14

TagRepository class

class TagRepository extends ServiceEntityRepository TagRepository.php:14

TagRepository::cacheByInsensitiveIdentifier()

public function cacheByInsensitiveIdentifier($identifier, array $fields = [])

TagRepository::findByInsensitiveIdentifier()

public function findByInsensitiveIdentifier($identifier, array $fields = [], $cacheable = false)

TaxonRepository class

class TaxonRepository extends ServiceEntityRepository TaxonRepository.php:14

Base\Repository\User

AddressRepository class

class AddressRepository extends ServiceEntityRepository AddressRepository.php:15

ComplaintRepository class

class ComplaintRepository extends ServiceEntityRepository ComplaintRepository.php:14

ComplaintRepository::newest()

public function newest(?string $status = null, ?string $source = null, int $limit = 200): array

The newest complaints, of one status (and one source) or all.

ConnectionRepository class

class ConnectionRepository extends ServiceEntityRepository ConnectionRepository.php:17

ConnectionRepository::countFor()

public function countFor(User $user): int

How many browsers the account was signed into from, counted by the database.

GroupRepository class

class GroupRepository extends ServiceEntityRepository GroupRepository.php:14

NotificationRepository class

class NotificationRepository extends ServiceEntityRepository NotificationRepository.php:15

NotificationRepository::countUnreadFor()

public function countUnreadFor(User $user): int

A real COUNT. Not the inherited count()/countBy(): base-bundle's ServiceEntityRepository redefines count() to return an array and countBy() hydrates every row, and this runs on every page for the toolbar badge.

NotificationRepository::findVisibleFor()

public function findVisibleFor(User $user, int $limit = 100, int $offset = 0, bool $unreadOnly = false): array

The user's notifications that have something to show, newest first.

PasskeyRepository class

class PasskeyRepository extends ServiceEntityRepository implements CredentialRecordRepositoryInterface, CanSaveCredentialRecord PasskeyRepository.php:24

Only the current contract: the deprecated PublicKeyCredentialSourceRepositoryInterface alias that WebauthnExtension still registers is removed by WebauthnDeprecatedAliasPass, so nothing requires it here.

PasskeyRepository::findAllForUserEntity()

public function findAllForUserEntity(PublicKeyCredentialUserEntity $publicKeyCredentialUserEntity): array

PasskeyRepository::findOneByCredentialId()

public function findOneByCredentialId(string $publicKeyCredentialId): ?CredentialRecord

PasskeyRepository::saveCredentialRecord()

public function saveCredentialRecord(CredentialRecord $credentialRecord): void

The bundle's own AttestationResponseController always calls this with a freshly validated, plain CredentialRecord (never our subclass) - userHandle is the one piece of it that ties back to whoever registered, via WebauthnUserEntityRepository's (string) user id encoding. Resolve that user here and do the real persist.

PenaltyRepository class

class PenaltyRepository extends ServiceEntityRepository PenaltyRepository.php:14

PermissionRepository class

class PermissionRepository extends ServiceEntityRepository PermissionRepository.php:14

PushSubscriptionRepository class

class PushSubscriptionRepository extends ServiceEntityRepository PushSubscriptionRepository.php:14

PushSubscriptionRepository::countDistinctUsers()

public function countDistinctUsers(): int

Users who enabled push in at least one browser.

SanctionRepository class

class SanctionRepository extends ServiceEntityRepository SanctionRepository.php:16

TokenRepository class

class TokenRepository extends ServiceEntityRepository TokenRepository.php:14

Base\Repository\User\Attribute

GroupActionRepository class

class GroupActionRepository extends ServiceEntityRepository GroupActionRepository.php:14

GroupRuleRepository class

class GroupRuleRepository extends ServiceEntityRepository GroupRuleRepository.php:14

GroupScopeRepository class

class GroupScopeRepository extends ServiceEntityRepository GroupScopeRepository.php:14

Base\Repository\User\Attribute\Action

GrantPermissionAdapterRepository class

class GrantPermissionAdapterRepository extends ServiceEntityRepository GrantPermissionAdapterRepository.php:14

GrantRoleAdapterRepository class

class GrantRoleAdapterRepository extends ServiceEntityRepository GrantRoleAdapterRepository.php:14

Base\Repository\User\Attribute\Scope

GroupAdapterRepository class

class GroupAdapterRepository extends ServiceEntityRepository GroupAdapterRepository.php:14

UserAdapterRepository class

class UserAdapterRepository extends ServiceEntityRepository UserAdapterRepository.php:14

Base\Response

PdfResponse class

class PdfResponse extends Response PdfResponse.php:34

An HTML page answered as a PDF, rendered by dompdf/dompdf - a suggested package: composer require dompdf/dompdf.

return new PdfResponse($this->renderView('invoice.pdf.twig', [...])); return new PdfResponse($html, 200, [ 'filename' => 'facture-2026-041.pdf', 'stream' => ['Attachment' => true], // downloaded, not shown 'options' => ['isRemoteEnabled' => true], // Dompdf's options ]);

The PDF is the response's content (getContent(), testable, cacheable): nothing is sent before the kernel sends the response.

Remote resources are off by default: an <img>, a stylesheet or a font at an http(s) address is not fetched - the HTML often carries what a visitor wrote, and fetching what it names from the server is a request forgery waiting to happen. Embed images as data: URIs (the embed_base64 filter), fonts and styles in the page; or turn isRemoteEnabled on, knowingly.

Three keys of $headers are settings, not headers: options (Dompdf's), stream (Attachment, compress), filename, and debug (true: the HTML itself is answered, to look at it in a browser).

PdfResponse::__construct()

public function __construct(string|Response|null $data = null, int $status = 200, array $headers = [])

PdfResponse::render()

public static function render(string $html, array $options = [], array $output = []): string

The PDF of an HTML page, as a string.

$options

Dompdf's options, over ours (remote resources off, fonts not subset)

$output

Dompdf's output options (compress)

Throws

LogicException when dompdf/dompdf is not installed

PdfResponse::options()

public static function options(array $options = []): array

Dompdf's options as PdfResponse sets them, under the caller's: remote resources off, fonts embedded whole.

PdfResponse::fromPdfString()

public static function fromPdfString(string $source, int $status = 200, array $headers = []): Response

The same, as a factory: an HTML source answered as a PDF.

return PdfResponse::fromPdfString($html)->setSharedMaxAge(300);

PdfResponse::fromPdfFile()

public static function fromPdfFile(string $filename, int $status = 200, array $headers = []): Response

A PDF that already exists as a file.

XmlResponse class

class XmlResponse extends Response XmlResponse.php:8

XmlResponse::__construct()

public function __construct($data = null, int $status = 200, array $headers = [])

XmlResponse::fromXmlString()

public static function fromXmlString(string $source, ?int $options = null, int $status = 200, array $headers = []): Response

Factory method for chainability.

Example:

return JsonResponse::fromJsonString('{"key": "value"}') ->setSharedMaxAge(300);

$status

The response status code

$headers

An array of response headers

XmlResponse::fromXmlFile()

public static function fromXmlFile(string $filename, ?int $options = null, int $status = 200, array $headers = []): Response

Base\Routing

AdminUrlGeneratorInterface interface

interface AdminUrlGeneratorInterface AdminUrlGeneratorInterface.php:19

Contract for building back-office URLs.

base-bundle is usable on its own - a front-end-only install has no back-office at all - so it must never type-hint the admin's concrete generator. It depends on this interface instead; omnibase/admin supplies the real implementation when it is installed, and NullAdminUrlGenerator stands in when it is not.

The fluent methods clone on first mutation, so a partially-built URL never leaks between call sites.

AdminUrlGeneratorInterface::setController()

public function setController(string $controllerFqcn): static

AdminUrlGeneratorInterface::setAction()

public function setAction(string $action): static

AdminUrlGeneratorInterface::setEntityId()

public function setEntityId(mixed $entityId): static

AdminUrlGeneratorInterface::set()

public function set(string $paramName, mixed $paramValue): static

AdminUrlGeneratorInterface::unset()

public function unset(string $paramName): static

AdminUrlGeneratorInterface::unsetAll()

public function unsetAll(): static

AdminUrlGeneratorInterface::generateUrl()

public function generateUrl(int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string

AdvancedRouter class

class AdvancedRouter implements AdvancedRouterInterface AdvancedRouter.php:32

AdvancedRouter::getLocaleLang()

public function getLocaleLang(?string $lang = null): string

AdvancedRouter::getLocale()

public function getLocale(?string $locale = null): string

AdvancedRouter::getEnvironment()

public function getEnvironment(): string

AdvancedRouter::__construct()

public function __construct(Router $router, RequestStack $requestStack, FirewallMapInterface $firewallMap, ParameterBagInterface $parameterBag, LocalizerInterface $localizer, AssetExtension $assetTwigExtension, CacheInterface $cache, string $debug, string $environment)

AdvancedRouter::useAdvancedFeatures()

public function useAdvancedFeatures(): bool

AdvancedRouter::useFallbacks()

public function useFallbacks(): bool

AdvancedRouter::getCache()

public function getCache(): CacheInterface

AdvancedRouter::getCacheName()

public function getCacheName(): string

AdvancedRouter::getCacheRoutes()

public function getCacheRoutes()

AdvancedRouter::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

AdvancedRouter::isCli()

public function isCli(): bool

AdvancedRouter::isDebug()

public function isDebug(): bool

AdvancedRouter::isProfiler()

public function isProfiler(mixed $request = null): bool

AdvancedRouter::isUX()

public function isUX(mixed $request = null): bool

AdvancedRouter::isAPI()

public function isAPI(mixed $request = null): bool

AdvancedRouter::isMainApplication()

public function isMainApplication(mixed $request = null): bool

AdvancedRouter::isSecured()

public function isSecured(mixed $request = null): bool

AdvancedRouter::isWdt()

public function isWdt(mixed $request = null): bool

AdvancedRouter::isAdmin()

public function isAdmin(mixed $request = null): bool

AdvancedRouter::getUrl()

public function getUrl(?string $nameOrUrl = null, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string

AdvancedRouter::getAssetUrl()

public function getAssetUrl(?string $nameOrUrl = null, ?string $packageName = null): string

AdvancedRouter::getContext()

public function getContext(): RequestContext

AdvancedRouter::setContext()

public function setContext(RequestContext $context): void

AdvancedRouter::getGenerator()

public function getGenerator(): UrlGeneratorInterface

AdvancedRouter::generate()

public function generate(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string

AdvancedRouter::match()

public function match(string $pathinfo): array

AdvancedRouter::matchRequest()

public function matchRequest(Request $request): array

AdvancedRouter::getMatcher()

public function getMatcher(): UrlMatcherInterface

AdvancedRouter::getLocalizer()

public function getLocalizer(): LocalizerInterface

AdvancedRouter::getRouteCollection()

public function getRouteCollection(): RouteCollection

AdvancedRouter::getRequestUri()

public function getRequestUri(): ?string

AdvancedRouter::getRequest()

public function getRequest(): ?Request

AdvancedRouter::getMainRequest()

public function getMainRequest(): ?Request

AdvancedRouter::getRoute()

public function getRoute(?string $routeNameOrUrl = null): ?Route

AdvancedRouter::getScheme()

public function getScheme(?string $locale = null, ?string $environment = null): string

The scheme of the request being handled: get_url_scheme() of the main request (Request::isSecure(), so a trusted proxy's X-Forwarded-Proto, then HTTPS, USE_HTTPS, REQUEST_SCHEME), the scheme get_url() gives the visited address and the site's routes. A web request not yet on the stack: the same function on PHP's globals. A command, a worker or a test with no request: https, unless the site sets HTTPS (or USE_HTTPS) to a false value - PHP's globals say nothing of the scheme there.

It is the scheme of Symfony's own routes (_profiler, _wdt...), the one the host fallbacks' ports are filtered by (HTTPS_PORT or HTTP_PORT), the IP restriction's redirection and app.site.scheme. docs/decisions/router-scheme.md says why it read REQUEST_SCHEME as a boolean (always https) until 3.x and what following the request moved.

AdvancedRouter::getBaseDir()

public function getBaseDir(?string $locale = null, ?string $environment = null): string

AdvancedRouter::reducesOnFallback()

public function reducesOnFallback(?string $locale = null, ?string $environment = null): bool

AdvancedRouter::getHostFallback()

public function getHostFallback(?string $locale = null, ?string $environment = null): string

AdvancedRouter::getHost()

public function getHost(?string $locale = null, ?string $environment = null): string

AdvancedRouter::getPortFallbacks()

public function getPortFallbacks(?string $locale = null, ?string $environment = null): array

AdvancedRouter::getPortFallback()

public function getPortFallback(?string $locale = null, ?string $environment = null): ?int

AdvancedRouter::getPort()

public function getPort(?string $locale = null, ?string $environment = null): ?int

AdvancedRouter::getMachineFallbacks()

public function getMachineFallbacks(?string $locale = null, ?string $environment = null): array

AdvancedRouter::getMachineFallback()

public function getMachineFallback(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getMachine()

public function getMachine(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getSubdomainFallbacks()

public function getSubdomainFallbacks(?string $locale = null, ?string $environment = null): array

AdvancedRouter::getSubdomainFallback()

public function getSubdomainFallback(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getSubdomain()

public function getSubdomain(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getDomainFallbacks()

public function getDomainFallbacks(?string $locale = null, ?string $environment = null): array

AdvancedRouter::getDomainFallback()

public function getDomainFallback(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getDomain()

public function getDomain(?string $locale = null, ?string $environment = null): ?string

AdvancedRouter::getRouteIndex()

public function getRouteIndex(): string

AdvancedRouter::getUrlIndex()

public function getUrlIndex(): string

AdvancedRouter::getRouteName()

public function getRouteName(?string $routeUrl = null): ?string

AdvancedRouter::getRouteGroups()

public function getRouteGroups(string $routeNameOrUrl): array

AdvancedRouter::getRouteMatch()

public function getRouteMatch(?string $routeUrl = null): ?array

AdvancedRouter::getFirewallMap()

public function getFirewallMap(): FirewallMapInterface

AdvancedRouter::hasFirewall()

public function hasFirewall(?string $routeUrl = null): ?bool

AdvancedRouter::getRouteFirewall()

public function getRouteFirewall(?string $routeUrl = null): ?FirewallConfig

AdvancedRouter::getRouteHash()

public function getRouteHash(string $routeNameOrUrl): string

AdvancedRouter::redirect()

public function redirect(string $urlOrRoute, array $routeParameters = [], int $state = 302, array $headers = []): RedirectResponse

AdvancedRouter::redirectToRoute()

public function redirectToRoute(string $routeName, array $routeParameters = [], int $state = 302, array $headers = []): RedirectResponse

AdvancedRouter::redirectEvent()

public function redirectEvent(Event $event, string $routeName, array $routeParameters = [], int $state = 302, array $headers = []): bool

AdvancedRouter::reloadRequest()

public function reloadRequest(?Request $request = null): RedirectResponse

AdvancedRouterInterface interface

interface AdvancedRouterInterface extends SymfonyRouterInterface, RequestMatcherInterface, WarmableInterface AdvancedRouterInterface.php:18

AdvancedRouterInterface::getRouteIndex()

public function getRouteIndex(): string

AdvancedRouterInterface::getUrlIndex()

public function getUrlIndex(): string

AdvancedRouterInterface::useAdvancedFeatures()

public function useAdvancedFeatures(): bool

AdvancedRouterInterface::isProfiler()

public function isProfiler(mixed $request = null): bool

AdvancedRouterInterface::isUX()

public function isUX(mixed $request = null): bool

AdvancedRouterInterface::isAPI()

public function isAPI(mixed $request = null): bool

AdvancedRouterInterface::isMainApplication()

public function isMainApplication(mixed $request = null): bool

AdvancedRouterInterface::isWdt()

public function isWdt(mixed $request = null): bool

AdvancedRouterInterface::isSecured()

public function isSecured(mixed $request = null): bool

AdvancedRouterInterface::reducesOnFallback()

public function reducesOnFallback(?string $locale = null, ?string $environment = null): bool

AdvancedRouterInterface::getBaseDir()

public function getBaseDir(?string $locale = null, ?string $environment = null): string

AdvancedRouterInterface::getHost()

public function getHost(?string $locale = null, ?string $environment = null): string

AdvancedRouterInterface::getHostFallback()

public function getHostFallback(?string $locale = null, ?string $environment = null): string

AdvancedRouterInterface::getMachine()

public function getMachine(?string $locale = null, ?string $environment = null): ?string

AdvancedRouterInterface::getMachineFallback()

public function getMachineFallback(?string $locale = null, ?string $environment = null): mixed

AdvancedRouterInterface::getMachineFallbacks()

public function getMachineFallbacks(?string $locale = null, ?string $environment = null): ?array

AdvancedRouterInterface::getScheme()

public function getScheme(?string $locale = null, ?string $environment = null): string

AdvancedRouterInterface::getSubdomain()

public function getSubdomain(?string $locale = null, ?string $environment = null): ?string

AdvancedRouterInterface::getSubdomainFallback()

public function getSubdomainFallback(?string $locale = null, ?string $environment = null): mixed

AdvancedRouterInterface::getSubdomainFallbacks()

public function getSubdomainFallbacks(?string $locale = null, ?string $environment = null): ?array

AdvancedRouterInterface::getDomain()

public function getDomain(?string $locale = null, ?string $environment = null): ?string

AdvancedRouterInterface::getDomainFallback()

public function getDomainFallback(?string $locale = null, ?string $environment = null): mixed

AdvancedRouterInterface::getDomainFallbacks()

public function getDomainFallbacks(?string $locale = null, ?string $environment = null): ?array

AdvancedRouterInterface::getPort()

public function getPort(?string $locale = null, ?string $environment = null): ?int

AdvancedRouterInterface::getPortFallback()

public function getPortFallback(?string $locale = null, ?string $environment = null): mixed

AdvancedRouterInterface::getPortFallbacks()

public function getPortFallbacks(?string $locale = null, ?string $environment = null): ?array

AdvancedRouterInterface::getUrl()

public function getUrl(?string $nameOrUrl = null, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string

AdvancedRouterInterface::getAssetUrl()

public function getAssetUrl(string $nameOrUrl, ?string $packageName = null): string

AdvancedRouterInterface::getRequest()

public function getRequest(): ?Request

AdvancedRouterInterface::getEnvironment()

public function getEnvironment(): string

AdvancedRouterInterface::getLocale()

public function getLocale(?string $locale = null): string

AdvancedRouterInterface::getLocaleLang()

public function getLocaleLang(?string $lang = null): string

AdvancedRouterInterface::getContext()

public function getContext(): RequestContext

AdvancedRouterInterface::setContext()

public function setContext(RequestContext $context): void

AdvancedRouterInterface::getGenerator()

public function getGenerator(): UrlGeneratorInterface

AdvancedRouterInterface::getMatcher()

public function getMatcher(): UrlMatcherInterface|RequestMatcherInterface

AdvancedRouterInterface::isCli()

public function isCli(): bool

AdvancedRouterInterface::isDebug()

public function isDebug(): bool

AdvancedRouterInterface::isAdmin()

public function isAdmin(mixed $request = null): bool

AdvancedRouterInterface::hasFirewall()

public function hasFirewall(?string $routeUrl = null): ?bool

AdvancedRouterInterface::getCache()

public function getCache(): CacheInterface

AdvancedRouterInterface::getCacheRoutes()

public function getCacheRoutes()

AdvancedRouterInterface::getRoute()

public function getRoute(?string $routeNameOrUrl = null): ?Route

AdvancedRouterInterface::getRouteHash()

public function getRouteHash(string $routeNameOrUrl): string

AdvancedRouterInterface::getRouteName()

public function getRouteName(?string $routeUrl = null): ?string

AdvancedRouterInterface::getRouteMatch()

public function getRouteMatch(?string $routeUrl = null): ?array

AdvancedRouterInterface::getRouteGroups()

public function getRouteGroups(string $routeNameOrUrl): array

AdvancedRouterInterface::getRouteFirewall()

public function getRouteFirewall(?string $routeUrl = null): ?FirewallConfig

AdvancedRouterInterface::redirect()

public function redirect(string $urlOrRoute, array $routeParameters = [], int $state = 302, array $headers = []): RedirectResponse

AdvancedRouterInterface::redirectToRoute()

public function redirectToRoute(string $routeName, array $routeParameters = [], int $state = 302, array $headers = []): RedirectResponse

AdvancedRouterInterface::redirectEvent()

public function redirectEvent(Event $event, string $routeName, array $routeParameters = [], int $state = 302, array $headers = []): bool

AdvancedRouterInterface::reloadRequest()

public function reloadRequest(?Request $request = null): RedirectResponse

NullAdminUrlGenerator class

final class NullAdminUrlGenerator implements AdminUrlGeneratorInterface NullAdminUrlGenerator.php:15

Stand-in used when omnibase/admin is not installed.

Every call site in base-bundle builds its URL fluently and only then asks for the string, so the builder methods stay silent no-ops and the failure surfaces at generateUrl() - the one point where the caller genuinely needs a back-office that isn't there.

NullAdminUrlGenerator::setController()

public function setController(string $controllerFqcn): static

NullAdminUrlGenerator::setAction()

public function setAction(string $action): static

NullAdminUrlGenerator::setEntityId()

public function setEntityId(mixed $entityId): static

NullAdminUrlGenerator::set()

public function set(string $paramName, mixed $paramValue): static

NullAdminUrlGenerator::unset()

public function unset(string $paramName): static

NullAdminUrlGenerator::unsetAll()

public function unsetAll(): static

NullAdminUrlGenerator::generateUrl()

public function generateUrl(int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string

Base\Routing\Generator

AdvancedUrlGenerator class

class AdvancedUrlGenerator extends CompiledUrlGenerator AdvancedUrlGenerator.php:14

public static $router = null

AdvancedUrlGenerator::getCompiledRoutes()

public function getCompiledRoutes(): array

AdvancedUrlGenerator::__construct()

public function __construct(array $compiledRoutes, RequestContext $context, ?LoggerInterface $logger = null, ?string $defaultLocale = null)

AdvancedUrlGenerator::resolveParameters()

public function resolveParameters(?array $routeParameters = null): ?array

AdvancedUrlGenerator::generate()

public function generate(string $routeName, array $routeParameters = [], int $referenceType = self::ABSOLUTE_PATH): string

AdvancedUrlGenerator::groups()

public function groups(?string $routeName): array

Base\Routing\Loader

RouteTranslationsResourceLoader class

class RouteTranslationsResourceLoader extends FileLoader RouteTranslationsResourceLoader.php:22

Registers config/routes_paths.yaml as a tracked resource so Symfony's config-cache rebuilds routes when it changes. Base\Attributes\Attribute\Route reads that file directly (not through Symfony's routing loaders), so without this, editing it alone — without touching any controller file — would leave the compiled route cache stale: AttributeClassLoader's freshness tracking is per-controller-class, not aware of this file at all.

Registers no routes itself; loaded purely for its addResource() side effect. Extends FileLoader (not the bare Loader) specifically to reuse its FileLocator for resolving the resource path the same way YamlFileLoader and friends do (relative to the importing routes.yaml's directory).

const TYPE = "base_route_paths"

RouteTranslationsResourceLoader::load()

public function load(mixed $resource, ?string $type = null): RouteCollection

RouteTranslationsResourceLoader::supports()

public function supports(mixed $resource, ?string $type = null): bool

Base\Routing\Matcher

AdvancedUrlMatcher class

class AdvancedUrlMatcher extends CompiledUrlMatcher implements RedirectableUrlMatcherInterface AdvancedUrlMatcher.php:14

public static $router = null
public static int $i = 0

AdvancedUrlMatcher::__construct()

public function __construct(array $compiledRoutes, RequestContext $context)

AdvancedUrlMatcher::redirect()

public function redirect(string $path, string $route, ?string $scheme = null): array

AdvancedUrlMatcher::security()

public function security(string $pathinfo): bool

AdvancedUrlMatcher::firewall()

public function firewall(string $pathinfo): ?FirewallConfig

AdvancedUrlMatcher::getCompiledPath()

public function getCompiledPath(array $compiledRoute): ?string

AdvancedUrlMatcher::getCompiledHost()

public function getCompiledHost(array $compiledRoute): ?string

AdvancedUrlMatcher::getCompiledHostRegex()

public function getCompiledHostRegex(array $compiledRoute): ?string

AdvancedUrlMatcher::match()

public function match(string $pathinfo): array

Base\Screen

Author class

final readonly class Author implements Screen Author.php:11

Who wrote a story, a comment, a reply (lesringostars' authors): a name, the address of their page (a profile, a comment's website), an avatar's address; staff where a screen marks the site's own people (the blog's "author" pill), left out of the props where it does not.

public string $name
public ?string $profile
public ?string $avatar
public ?bool $staff

Author::__construct()

public function __construct(public string $name, public ?string $profile = null, public ?string $avatar = null, public ?bool $staff = null)

Author::toArray()

public function toArray(): array

Author::jsonSerialize()

public function jsonSerialize(): array

Card class

readonly class Card implements Screen Card.php:14

A story on a list (lesringostars' BlogPage::card()): its slug, title, excerpt, date, reading time, authors and tags, its address. likes, likeUrl and comments are null where the screen counts none (never 0: "none counted" and "zero" stay apart). Added for omnibase's blog: the line under the title (headline), the cover's address at the width the screen shows it, the taxa, and recent - published lately, by the screen's clock (a template compares no moment: it reads this).

public string $slug
public string $title
public string $url
public ?string $excerpt
public bool $hasContent
public ?string $publishedAt
public int $readingMinutes
public array $authors
public array $tags
public ?int $likes
public ?string $likeUrl
public ?int $comments
public ?string $headline
public ?string $cover
public array $taxa
public bool $recent

Card::__construct()

public function __construct(public string $slug, public string $title, public string $url, public ?string $excerpt = null, public bool $hasContent = false, public ?string $publishedAt = null, public int $readingMinutes = 0, public array $authors = [], public array $tags = [], public ?int $likes = null, public ?string $likeUrl = null, public ?int $comments = null, public ?string $headline = null, public ?string $cover = null, public array $taxa = [], public bool $recent = false)

Card::toArray()

public function toArray(): array

Card::jsonSerialize()

public function jsonSerialize(): array

Comment class

final readonly class Comment implements Screen Comment.php:11

A comment (lesringostars' comments): its id or uuid (at least one: a front end keys and anchors on the uuid, else the id), slug, date, authors, text (as written: a template breaks its lines), the address to follow it, its replies, and whether it is recent by the screen's clock.

public ?int $id
public ?string $uuid
public ?string $slug
public ?string $publishedAt
public array $authors
public ?string $content
public ?string $followUrl
public array $replies
public bool $recent

Comment::__construct()

public function __construct(public ?int $id, public ?string $uuid, public ?string $slug = null, public ?string $publishedAt = null, public array $authors = [], public ?string $content = null, public ?string $followUrl = null, public array $replies = [], public bool $recent = false)

Comment::toArray()

public function toArray(): array

Comment::jsonSerialize()

public function jsonSerialize(): array

Confidential interface

interface Confidential extends Screen Confidential.php:12

A screen carrying secrets of its viewer's session (plan "omnibase agnostique", C5): the tokens of its forms (Base\Screen\Account\Action), the token of its requests. Whoever answers it keeps it out of every cache - under Symfony, ScreenResponder gives Cache-Control: private, no-store and Vary: Cookie, the HTML as the JSON.

ContextProvider interface

interface ContextProvider ContextProvider.php:16

What a screen needs of the request it answers (plan "omnibase agnostique", C5): the frame around the page, the visitor signed in, the messages left for the page. Under Symfony Base\Bridge\Symfony\SymfonyScreenContext; a site decorates it to add its own frame fields; another framework fills it the same.

Not in it, on purpose: the forms a page carries (Symfony by nature, D3), the assets and the injections of the layout (the host's layout stays the host's), menus (a site's links go in the frame's extra).

ContextProvider::frame()

public function frame(array $extra = []): Frame

The frame of the page being answered; $extra the site's own fields.

ContextProvider::viewer()

public function viewer(): ?Viewer

The visitor signed in, null for nobody.

ContextProvider::flashes()

public function flashes(string $type): array

The messages left for the next page under that type, read - and so taken - now.

Discussion class

final readonly class Discussion implements Screen Discussion.php:14

The comments of a page and whether one may write (lesringostars' page comments and hasMoreComments, here comments and hasMore): one model, because the block is shown on pages that are no story too (a visitors' book, a host's home). open: a comment may be written here (the site's settings, the story's, the visitor); canReply: an answer to one may; signIn: the address of the sign-in page, for whoever may not; flashes: the messages left for this page, already read.

public array $comments
public bool $hasMore
public bool $open
public bool $canReply
public ?string $signIn
public array $flashes

Discussion::__construct()

public function __construct(public array $comments = [], public bool $hasMore = false, public bool $open = false, public bool $canReply = false, public ?string $signIn = null, public array $flashes = [])

Discussion::toArray()

public function toArray(): array

Discussion::jsonSerialize()

public function jsonSerialize(): array

Frame class

final readonly class Frame implements Screen Frame.php:16

What every page shows around its screen (lesringostars' App\Screen\Frame): the page's language, the site, the addresses of the menus, the visitor signed in and the colour scheme, and what a site adds of its own (extra: lesringostars' destination, destinations, last article, tags, map), merged in its props between site and links. Given per request by a ContextProvider.

host (the scheme, host and base path the page was asked at) serves the absolute addresses and the feed; it is not in the props.

const RESERVED = ['locale', 'site', 'links', 'viewer', 'theme']

The keys of the frame's own fields, which a site's extra may not take.

public string $locale
public Site $site

by name; locales the address of each language

public ?Viewer $viewer
public array $theme
public array $extra

the site's own fields

public string $host

Frame::__construct()

public function __construct(public string $locale, public Site $site = new Site(), public array $links = [], public ?Viewer $viewer = null, public array $theme = [], public array $extra = [], public string $host = '')
$links

by name; locales the address of each language

$extra

the site's own fields

Frame::with()

public function with(array $extra): self

A copy with the site's own fields added (a site's provider decorating the core's).

Frame::toArray()

public function toArray(): array

Frame::jsonSerialize()

public function jsonSerialize(): array

final readonly class Link implements Screen Link.php:11

Another story, as a page points to it (the one before, after, to read as well; a member's latest on their profile): its title, address and state; publishedAt where a page shows the date, left out of the props where it shows none.

Link::__construct()

public function __construct(public string $title, public string $url, public string $state, public ?string $publishedAt = null)
public function toArray(): array
public function jsonSerialize(): array

Reply class

final readonly class Reply implements Screen Reply.php:11

An answer to a comment (lesringostars' replies): its id or uuid (at least one: a front end keys and anchors on the uuid, else the id), date, authors, text, whether it was deleted, and whether it is recent by the screen's clock.

public ?int $id
public ?string $uuid
public ?string $publishedAt
public array $authors
public ?string $content
public bool $deleted
public bool $recent

Reply::__construct()

public function __construct(public ?int $id, public ?string $uuid, public ?string $publishedAt = null, public array $authors = [], public ?string $content = null, public bool $deleted = false, public bool $recent = false)

Reply::toArray()

public function toArray(): array

Reply::jsonSerialize()

public function jsonSerialize(): array

Screen interface

interface Screen extends JsonSerializable Screen.php:12

A view model (plan 0, rule 13; plan "omnibase agnostique", C5): what a screen shows, as plain data a view bridge renders - Twig reads the object's public properties, a front end (React) reads toArray() as its props. No entity, no service, no class of a framework inside: scalars, ISO 8601 moments, lists and other screens.

Screen::toArray()

public function toArray(): array
Returns

the props, nested arrays all the way down

Site class

final readonly class Site implements Screen Site.php:6

The site around every page: its name, its slogan, its logo's address, the year, its description (lesringostars' frame site).

public ?string $title
public ?string $slogan
public string $age
public ?string $description

Site::__construct()

public function __construct(public ?string $title = null, public ?string $slogan = null, public ?string $logo = null, public string $age = '', public ?string $description = null)

Site::toArray()

public function toArray(): array

Site::jsonSerialize()

public function jsonSerialize(): array

Story class

readonly class Story implements Screen Story.php:11

A story on its own page (lesringostars' StoryPage article): what its card says, with its id, its text (StoryText's html, editor and toc, flattened as there), its sounds' addresses, whether it takes comments, and its state.

The cover is at the width the page shows it.

public int $id
public string $slug
public string $title
public string $url
public string $state
public ?string $headline
public ?string $excerpt
public StoryText $text
public ?string $publishedAt
public int $readingMinutes
public array $authors
public array $tags
public array $audio
public ?int $likes
public ?string $likeUrl
public bool $commentable
public ?int $comments
public ?string $cover
public array $taxa
public bool $recent

Story::__construct()

public function __construct(public int $id, public string $slug, public string $title, public string $url, public string $state, public ?string $headline = null, public ?string $excerpt = null, public StoryText $text = new StoryText(), public ?string $publishedAt = null, public int $readingMinutes = 0, public array $authors = [], public array $tags = [], public array $audio = [], public ?int $likes = null, public ?string $likeUrl = null, public bool $commentable = false, public ?int $comments = null, public ?string $cover = null, public array $taxa = [], public bool $recent = false)

Story::getHtml()

public function getHtml(): string

The text's HTML (Twig: story.html, as the props say it).

Story::isEditor()

public function isEditor(): bool

Story::getToc()

public function getToc(): array

Story::hasContent()

public function hasContent(): bool

Story::toArray()

public function toArray(): array

Story::jsonSerialize()

public function jsonSerialize(): array

StoryText class

final readonly class StoryText implements Screen StoryText.php:10

A story's text as its page shows it (lesringostars' StoryText::render()): the HTML rendered, whether it was an Editor.js document, and its table of contents (each heading's tag, anchor and title, in the text's order).

public string $html
public bool $editor
public array $toc

StoryText::__construct()

public function __construct(public string $html = '', public bool $editor = false, public array $toc = [])

StoryText::toArray()

public function toArray(): array

StoryText::jsonSerialize()

public function jsonSerialize(): array

Tag class

final readonly class Tag implements Screen Tag.php:11

A tag, a taxon (lesringostars' tags): its slug, label, colour, icon and the address that lists what carries it; count in a cloud of tags, current in a navigation by tag (the one shown), each left out of the props where a screen has none.

public string $slug
public string $label
public string $url
public ?string $color
public ?string $icon
public ?int $count
public ?bool $current

Tag::__construct()

public function __construct(public string $slug, public string $label, public string $url, public ?string $color = null, public ?string $icon = null, public ?int $count = null, public ?bool $current = null)

Tag::toArray()

public function toArray(): array

Tag::jsonSerialize()

public function jsonSerialize(): array

View class

final readonly class View View.php:12

What a controller hands back (plan 0, rule 13): the template that draws the screen, the screen itself, the name of the component a front end draws it with (omnibridge/react's Page), and the status of the answer. The view bridge renders it: Twig with frame and screen, React with the frame's and the screen's props together.

public string $template
public Screen $screen
public ?string $component
public int $status

View::__construct()

public function __construct(public string $template, public Screen $screen, public ?string $component = null, public int $status = 200)

Viewer class

final readonly class Viewer implements Screen Viewer.php:10

The visitor signed in, as a page may show them: an id, a name, an avatar's address. Nothing else (no roles: what a screen needs of the visitor, its builder decides - may they reply, is the form open).

public ?int $id
public string $name
public ?string $avatar

Viewer::__construct()

public function __construct(public ?int $id, public string $name, public ?string $avatar = null)

Viewer::toArray()

public function toArray(): array

Viewer::jsonSerialize()

public function jsonSerialize(): array

Base\Screen\Account

AccountSummary class

final readonly class AccountSummary implements Screen AccountSummary.php:14

An account's security at a glance, on its profile, for its owner or an administrator: whether it has a second factor (null where two-factor is not available on the site), how many passkeys (null where passkeys are not - never 0 for "not counted"), the provider it signs in with (google), its language and time zone.

public ?bool $twoFactor
public ?int $passkeys
public ?string $identityProvider
public ?string $locale
public ?string $timezone

AccountSummary::__construct()

public function __construct(public ?bool $twoFactor = null, public ?int $passkeys = null, public ?string $identityProvider = null, public ?string $locale = null, public ?string $timezone = null)

AccountSummary::toArray()

public function toArray(): array

AccountSummary::jsonSerialize()

public function jsonSerialize(): array

Action class

final readonly class Action implements Screen Action.php:13

A POST a page sends (plan "omnibase agnostique", C5): the address it goes to and the token of its intent (Base\Contract\Tokens), which the action checks. Only on a confidential screen (Base\Screen\Confidential): its answers are stored by no cache.

public string $url
public string $token

Action::__construct()

public function __construct(public string $url, public string $token)

Action::toArray()

public function toArray(): array

Action::jsonSerialize()

public function jsonSerialize(): array

Member class

final readonly class Member implements Screen Member.php:16

A member as their profile shows them, to anyone who opens it: their number and name, their avatar - the stored one's address at 128 px, or the application's own rendering (avatarHtml: its User's getFormattedAvatar(), HTML) -, their roles (the names, which a template translates), whether they are online or were active lately (the account's own answers, by base.user.online_delay and active_delay), when they registered and were last seen, how many threads they own and likes they gave (counted).

public int $id
public string $name
public ?string $avatar
public ?string $avatarHtml
public array $roles
public bool $online
public bool $active
public ?string $registeredAt
public ?string $lastSeenAt
public int $threads
public int $likes

Member::__construct()

public function __construct(public int $id, public string $name, public ?string $avatar = null, public ?string $avatarHtml = null, public array $roles = [], public bool $online = false, public bool $active = false, public ?string $registeredAt = null, public ?string $lastSeenAt = null, public int $threads = 0, public int $likes = 0)

Member::toArray()

public function toArray(): array

Member::jsonSerialize()

public function jsonSerialize(): array

Notification class

final readonly class Notification implements Screen Notification.php:15

A notification in the member's list: the bell's item (NotificationController::serialize(): id, title - else the subject -, text without its tags - null when it has none -, address, back-office address, importance, read or not, when it was sent) and its group - today, yesterday, week or earlier, by the screen's clock in the page's time zone, so that no template compares a moment.

const GROUPS = ['today', 'yesterday', 'week', 'earlier']
public int $id
public string $title
public ?string $content
public ?string $url
public ?string $adminUrl
public ?string $importance
public bool $isRead
public ?string $sentAt
public string $group

Notification::__construct()

public function __construct(public int $id, public string $title = '', public ?string $content = null, public ?string $url = null, public ?string $adminUrl = null, public ?string $importance = null, public bool $isRead = false, public ?string $sentAt = null, public string $group = 'earlier')

Notification::toArray()

public function toArray(): array

Notification::jsonSerialize()

public function jsonSerialize(): array

NotificationsPage class

final readonly class NotificationsPage implements Confidential NotificationsPage.php:16

The member's notifications (/notifications): the latest with something to show (newest first; the unread ones alone when asked), how many are unread (counted), whether the page shows the unread ones alone and the address of all of them, the token every request of the page carries and the addresses of those requests (read, latest, delete, push subscribe and unsubscribe), whether push can be offered and its public key. Its token: confidential.

public array $notifications
public int $unread
public bool $unreadOnly
public string $allUrl
public string $token
public string $readUrl
public string $latestUrl
public string $deleteUrl
public string $subscribeUrl
public string $unsubscribeUrl
public bool $push
public ?string $pushKey

NotificationsPage::__construct()

public function __construct(public array $notifications, public int $unread, public bool $unreadOnly, public string $allUrl, public string $token, public string $readUrl, public string $latestUrl, public string $deleteUrl, public string $subscribeUrl, public string $unsubscribeUrl, public bool $push = false, public ?string $pushKey = null)

NotificationsPage::toArray()

public function toArray(): array

NotificationsPage::jsonSerialize()

public function jsonSerialize(): array

Passkey class

final readonly class Passkey implements Screen Passkey.php:8

A passkey of the account: its number, its label (null for none), when it was added and last used, the actions renaming and removing it.

public int $id
public Action $rename
public Action $delete
public ?string $label
public ?string $addedAt
public ?string $lastUsedAt

Passkey::__construct()

public function __construct(public int $id, public Action $rename, public Action $delete, public ?string $label = null, public ?string $addedAt = null, public ?string $lastUsedAt = null)

Passkey::toArray()

public function toArray(): array

Passkey::jsonSerialize()

public function jsonSerialize(): array

ProfilePage class

final readonly class ProfilePage implements Screen ProfilePage.php:20

A member's profile (/profile/{id}): the member, whether the viewer is that member, their five latest published threads (newest first, each dated by its publication, else its creation), the account's summary - only for its owner or an administrator, null for anyone else -, and the addresses its owner (or an administrator, for the edit) follows from there.

What a visitor's props carry is what the page shows that visitor: the header (number, name, avatar, roles, presence, dates, counts) and the threads; the account's summary and the owner's addresses stay null.

public Member $member
public bool $own
public array $recent
public ?AccountSummary $account
public ?string $editUrl
public ?string $settingsUrl
public ?string $logoutUrl

ProfilePage::__construct()

public function __construct(public Member $member, public bool $own = false, public array $recent = [], public ?AccountSummary $account = null, public ?string $editUrl = null, public ?string $settingsUrl = null, public ?string $logoutUrl = null)

ProfilePage::toArray()

public function toArray(): array

ProfilePage::jsonSerialize()

public function jsonSerialize(): array

Provider class

final readonly class Provider implements Screen Provider.php:8

A provider one may sign in with (google, "Google"): whether the account signs in with it, the address linking it (while it does not).

public string $name
public string $label
public bool $connected
public ?string $connectUrl

Provider::__construct()

public function __construct(public string $name, public string $label, public bool $connected = false, public ?string $connectUrl = null)

Provider::toArray()

public function toArray(): array

Provider::jsonSerialize()

public function jsonSerialize(): array

Session class

final readonly class Session implements Screen Session.php:13

One of the account's sessions (a connection): its number, the browser's own string and a readable label ("Safari - macOS"), the addresses it came from, when it was last seen, whether it is still open, and the action signing it out (while it is).

public int $id
public ?string $agent
public ?string $label
public array $ips
public ?string $updatedAt
public bool $valid
public ?Action $logout

Session::__construct()

public function __construct(public int $id, public ?string $agent = null, public ?string $label = null, public array $ips = [], public ?string $updatedAt = null, public bool $valid = false, public ?Action $logout = null)

Session::toArray()

public function toArray(): array

Session::jsonSerialize()

public function jsonSerialize(): array

SettingsPage class

final readonly class SettingsPage implements Confidential SettingsPage.php:18

The account's settings (/settings): its name (null for nobody signed in: the page shows its title alone), whether it is a demonstration account (changing nothing of its credentials), its second factor (null where two-factor is not available), its passkeys (null where passkeys are not) and the identifier a new one registers, the sign-in providers shown (those available, and the account's own), its latest sessions, its language (its locale, language: the frame owns locale) and time zone. Its actions carry their tokens: confidential.

public ?string $name
public bool $demo
public ?TwoFactor $twoFactor
public ?array $passkeys
public ?string $identifier
public array $providers
public array $sessions
public ?string $language
public ?string $timezone

SettingsPage::__construct()

public function __construct(public ?string $name = null, public bool $demo = false, public ?TwoFactor $twoFactor = null, public ?array $passkeys = null, public ?string $identifier = null, public array $providers = [], public array $sessions = [], public ?string $language = null, public ?string $timezone = null)

SettingsPage::toArray()

public function toArray(): array

SettingsPage::jsonSerialize()

public function jsonSerialize(): array

TwoFactor class

final readonly class TwoFactor implements Screen TwoFactor.php:17

An account's second factor on its settings page, as the security policy lets its owner change it: whether the administrator requires one (and the account still lacks it), the authenticator app - on or off, the address to switch it on (when it may be), the action switching it off (when it may be: on without it is locked by the administrator) -, the code by e-mail - on or off, locked (on, the only factor left, and required), the action toggling it (when not locked and the account may change its credentials) -, the backup codes left (null while the app is off).

public bool $mandatory
public bool $enrolmentRequired
public bool $totp
public ?string $totpEnable
public ?Action $totpDisable
public bool $email
public bool $emailLocked
public ?Action $emailToggle
public ?int $backupCodes

TwoFactor::__construct()

public function __construct(public bool $mandatory = false, public bool $enrolmentRequired = false, public bool $totp = false, public ?string $totpEnable = null, public ?Action $totpDisable = null, public bool $email = false, public bool $emailLocked = false, public ?Action $emailToggle = null, public ?int $backupCodes = null)

TwoFactor::toArray()

public function toArray(): array

TwoFactor::jsonSerialize()

public function jsonSerialize(): array

Base\Screen\Builder

Accounts class

final class Accounts Accounts.php:41

The account's pages as view models (plan "omnibase agnostique", C5): a member's profile, the account's settings, the member's notifications, from omnibase's entities (a User, its threads and passkeys, its connections, its notifications) and the site's security policy. Framework-free: the addresses through the Urls contract, the forms' tokens through Tokens (the ones given, else Runtime's), "now" from a PSR-20 clock; what only the framework knows (an avatar's thumbnail, the providers available, web push) the caller passes in.

Each page asks the policy and the entities what the template of before asked them, so the pages print the same.

const RECENT = 5

How many of a member's threads their profile lists.

const PROVIDERS = ['google' => 'Google']

The providers a settings page offers, by name: their label.

Accounts::__construct()

public function __construct(readonly ?SecurityPolicy $policy = null, readonly ?Urls $urls = null, readonly ?Tokens $tokens = null, readonly ?ClockInterface $clock = null)

Accounts::member()

public function member(User $user, ?string $avatar = null): Member

A member as their profile shows them.

$avatar

the stored avatar's address at 128 px; null when the account has none

Accounts::profile()

public function profile(User $user, bool $own = false, bool $admin = false, ?string $avatar = null): ProfilePage

A member's profile.

$own

the viewer is that member

$admin

the viewer is an administrator (sees the account's summary, edits the profile)

Accounts::recent()

public function recent(User $user): array
Returns

a member's latest published threads with a title, newest first (by publication, else creation)

Accounts::summary()

public function summary(User $user): AccountSummary

An account's security at a glance, for its owner or an administrator.

Accounts::settings()

public function settings(?User $user, iterable $sessions = [], array $available = []): SettingsPage

The account's settings; for nobody signed in, its title alone.

$sessions

the sessions listed, newest first

$available

whether each provider (self::PROVIDERS) can be linked on this site

Accounts::notifications()

public function notifications(iterable $notifications, int $unread, bool $unreadOnly = false, bool $push = false, ?string $pushKey = null, ?\Closure $adminUrl = null, ?\DateTimeZone $timezone = null): NotificationsPage

The member's notifications.

$notifications

newest first

$adminUrl

the back-office address of what one is about

$timezone

the page's (the days are its days); the machine's when none is given

Accounts::notification()

public function notification(NotificationEntity $notification, ?string $adminUrl = null, ?\DateTimeZone $timezone = null): Notification

Accounts::group()

public function group(?string $moment, ?\DateTimeZone $timezone = null): string

The day a moment falls in, by the clock, in the page's time zone: today, yesterday, within the week, earlier (and earlier for no moment).

Stories class

final class Stories Stories.php:33

omnibase's threads as view models (plan "omnibase agnostique", C5): a thread on a list (Card), on its own page (Story), pointed to (Link), its text (StoryText), its tags, taxa and owners, the comments left on it.

Framework-free: the addresses come from the caller (a closure per kind of link, made with the Urls contract or the framework's router), the images from the Pictures contract, the texts from the Texts contract, "now" from a PSR-20 clock (the one given, else Runtime's); the entities are read through their getters.

What a screen counts or shows beyond that (likes, a count of comments, a site's own reading time) it passes in; what it leaves out stays null.

Stories::__construct()

public function __construct(readonly ?Texts $texts = null, readonly ?Pictures $pictures = null, readonly ?ClockInterface $clock = null, readonly string $recently = '-2 days')

Stories::card()

public function card(Thread $thread, string $url, ?\Closure $tagUrl = null, ?\Closure $taxonUrl = null, ?string $cover = null, ?int $coverWidth = null, ?int $readingMinutes = null, ?int $likes = null, ?string $likeUrl = null, ?int $comments = null): Card

A thread on a list.

$tagUrl

the address listing a tag's stories

$taxonUrl

the address listing a taxon's

$cover

the stored image (null: none); given, the card's cover is its address at $coverWidth, '' when it has none

Stories::story()

public function story(Thread $thread, string $url, ?\Closure $tagUrl = null, ?\Closure $taxonUrl = null, ?string $cover = null, ?int $coverWidth = null, ?int $readingMinutes = null, array $textOptions = [], array $audio = [], ?int $likes = null, ?string $likeUrl = null, bool $commentable = false, ?int $comments = null): Story

A thread on its own page: its card's fields, its text through Texts.

$textOptions

the options of |wysiwyg

$audio

its sounds' addresses

public function link(?Thread $thread, ?string $url): ?Link

A thread pointed to (the one before, after, to read as well); null for none.

Stories::text()

public function text(?string $content, array $options = []): StoryText

A stored text as its page shows it, through the Texts contract.

$options

the options of |wysiwyg

Stories::tags()

public function tags(iterable $tags, \Closure $url, ?string $current = null, bool $marked = false): array

Tags or taxa (any entity with a slug and a label: Base\Entity\Thread\Tag, Taxon).

$current

the slug of the one shown, when the screen marks it

Stories::owners()

public function owners(Thread $thread): array
Returns

the thread's owners, in their order, by their names

Stories::comments()

public function comments(iterable $comments): array

Comments left on a thread (Base\Entity\Thread\Comment, or none for a visitors' book), each with its visible replies: signed by the account's name or the name typed, the website typed as the author's page, staff for an account holding a role besides ROLE_USER.

Stories::isRecent()

public function isRecent(?string $moment): bool

Whether a moment is within the recent window before now (the screen's clock).

Base\Security

AccessTokenHandler class

class AccessTokenHandler implements AccessTokenHandlerInterface AccessTokenHandler.php:10

AccessTokenHandler::__construct()

public function __construct(TokenRepository $tokenRepository)

AccessTokenHandler::getUserBadgeFrom()

public function getUserBadgeFrom(string $token): UserBadge

CookieAnswer class

final class CookieAnswer CookieAnswer.php:13

The visitor's answer about cookies, read on the server: the page's script (@glitchr/flowjs/cookie, which omnibase/consent configures) keeps it in the cookie "cookie-consent" - {"c": {"USER": 1, "LOCATION": 0}, ...}, one yes or no per category. For the few cookies the server writes itself: the script lets nothing be written under a refused category, and neither does the server.

The library's default name; a site that renames it (consent.options.record.name) has no answer here.

CookieAnswer::of()

public static function of(string $category, ?array $cookies = null): ?bool

true or false, null when the visitor has not answered for this category - or the answer is not in this cookie.

$cookies

the request's; PHP's own by default

CookieAnswer::refused()

public static function refused(string $category, ?array $cookies = null): bool

LoginFormAuthenticator class

class LoginFormAuthenticator extends AbstractLoginFormAuthenticator LoginFormAuthenticator.php:30

const LOGIN_ROUTE = 'security_login'
const LOGOUT_ROUTE = 'security_logout'
const LOGOUT_REQUEST_ROUTE = 'security_logoutRequest'

LoginFormAuthenticator::__construct()

public function __construct(ReferrerInterface $referrer, EntityManagerInterface $entityManager, AdvancedRouterInterface $router, AuthorizationCheckerInterface $authorizationChecker)

LoginFormAuthenticator::isSecurityRoute()

public static function isSecurityRoute(Request|string $routeNameOrRequest)

LoginFormAuthenticator::start()

public function start(Request $request, ?AuthenticationException $authException = null): Response

LoginFormAuthenticator::supports()

public function supports(Request $request): bool

LoginFormAuthenticator::authenticate()

public function authenticate(Request $request): Passport

LoginFormAuthenticator::onAuthenticationSuccess()

public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response

LoginRestrictionInterface interface

interface LoginRestrictionInterface LoginRestrictionInterface.php:5

RescueFormAuthenticator class

class RescueFormAuthenticator extends LoginFormAuthenticator RescueFormAuthenticator.php:5

const LOGIN_ROUTE = 'security_rescue'
const PENDING_ROUTE = 'security_pending'

SignInGuard class

class SignInGuard implements EventSubscriberInterface SignInGuard.php:32

The sign-in's captcha, after a few failures. Symfony's login_throttling is the first line (five tries a minute, per identifier and address); this one counts the failures from an address - whatever identifiers they tried - and from base.guard.sign_in_after of them on, the sign-in form carries the captcha (SecurityController::Login) and a sign-in without a valid token is refused before its password is even checked. A success forgets the count.

Only the site's own sign-in form (security_login): not the rescue door, not the demonstration's one click. Nothing where glitchr/ux-google's reCAPTCHA already guards the sign-in (google.recaptcha.enable), nor without glitchr/omnishield and a captcha.

const ACTION = 'login'
const MESSAGE = 'Please confirm that you are not a robot.'

SignInGuard::__construct()

public function __construct(protected readonly FormGuard $guard, protected readonly ?CacheItemPoolInterface $cache = null, protected readonly bool $google = false, protected readonly ?LoggerInterface $logger = null, protected readonly ?RequestStack $requests = null)

SignInGuard::getSubscribedEvents()

public static function getSubscribedEvents(): array

SignInGuard::required()

public function required(?Request $request): ?string

The captcha's gateway when a sign-in from this request must pass it; null otherwise.

SignInGuard::failures()

public function failures(string $ip): int

SignInGuard::onLoginFailure()

public function onLoginFailure(LoginFailureEvent $event): void

SignInGuard::onLoginSuccess()

public function onLoginSuccess(LoginSuccessEvent $event): void

SignInGuard::onCheckPassport()

public function onCheckPassport(CheckPassportEvent $event): void

UserChecker class

class UserChecker implements UserCheckerInterface UserChecker.php:14

UserChecker::__construct()

public function __construct(EntityManagerInterface $entityManager)

UserChecker::checkPreAuth()

public function checkPreAuth(UserInterface $user): void

UserChecker::checkPostAuth()

public function checkPostAuth(UserInterface $user, ?TokenInterface $token = null): void

UserProvider class

class UserProvider implements UserProviderInterface, PasswordUpgraderInterface, OAuthAwareUserProviderInterface UserProvider.php:17

UserProvider::__construct()

public function __construct(UserTracker $userTracker, UserRepository $userRepository)

UserProvider::loadUserByIdentifier()

public function loadUserByIdentifier($identifier): UserInterface

{@inheritdoc}

UserProvider::refreshUser()

public function refreshUser(UserInterface $user): UserInterface

Refreshes the user after being reloaded from the session.

The session holds a serialized copy of the User; what comes back from it is a detached object with the values of the moment it was stored. Re-reading the row is what makes a change made elsewhere (a level or a balance updated by a nightly command, a role changed in the admin) show on the member's next request instead of their next login - and what makes deleting an account actually end its sessions: no row, no user.

A transient user (the OAuth stub of loadUserByOAuthUserResponse(), id 0) has no row to re-read and is returned as it is.

If your firewall is "stateless: true" (for a pure API), this method is not called.

UserProvider::supportsClass()

public function supportsClass(string $class): bool

Tells Symfony to use this provider for this User class.

UserProvider::upgradePassword()

public function upgradePassword(PasswordAuthenticatedUserInterface $user, string $newHashedPassword): void

Upgrades the encoded password of a user, typically for using a better hash algorithm.

UserProvider::loadUserByOAuthUserResponse()

public function loadUserByOAuthUserResponse(UserResponseInterface $response): UserInterface

{@inheritdoc}

UserTracker class

class UserTracker UserTracker.php:13

const PHPUSERID = "PHPUSERID"

UserTracker::__construct()

public function __construct(EntityManagerInterface $entityManager, RequestStack $requestStack, AdvancedRouterInterface $router, ConnectionRepository $connectionRepository)

UserTracker::getUniqid()

public function getUniqid(): string

UserTracker::getCurrentConnection()

public function getCurrentConnection(?User $user = NULL, bool $allowNewConnection = true): ?Connection

UserTracker::createNewConnection()

public function createNewConnection(User $user): Connection

UserTracker::updateConnection()

public function updateConnection(User $user)

On every authenticated request (UserProvider::refreshUser): flushed only when the connection is new or something about it changed - it flushed the whole unit of work on every request, before the controller had even run.

WebauthnUserEntityRepository class

class WebauthnUserEntityRepository implements PublicKeyCredentialUserEntityRepositoryInterface WebauthnUserEntityRepository.php:9

WebauthnUserEntityRepository::__construct()

public function __construct(UserRepository $userRepository)

WebauthnUserEntityRepository::findOneByUsername()

public function findOneByUsername(string $username): ?PublicKeyCredentialUserEntity

WebauthnUserEntityRepository::findOneByUserHandle()

public function findOneByUserHandle(string $userHandle): ?PublicKeyCredentialUserEntity

Base\Security\Session

DynamicSessionStorage class

class DynamicSessionStorage extends NativeSessionStorage DynamicSessionStorage.php:7

DynamicSessionStorage::setOptions()

public function setOptions(array $options): void

DynamicSessionStorageFactory class

class DynamicSessionStorageFactory implements SessionStorageFactoryInterface DynamicSessionStorageFactory.php:27

DynamicSessionStorageFactory::__construct()

public function __construct(array $options = [], AbstractProxy|SessionHandlerInterface|null $handler = null, MetadataBag|null $metaBag = null, bool $secure = false)

DynamicSessionStorageFactory::createStorage()

public function createStorage(?Request $request): SessionStorageInterface

Base\Security\Voter

AccessVoter class

class AccessVoter extends Voter AccessVoter.php:17

const LAUNCH_ACCESS = "LAUNCH_ACCESS"
const MAINTENANCE_ACCESS = "MAINTENANCE_ACCESS"
const EXCEPTION_ACCESS = "EXCEPTION_ACCESS"
const ANONYMOUS_ACCESS = "ANONYMOUS_ACCESS"
const USER_ACCESS = "USER_ACCESS"
const ADMIN_ACCESS = "ADMIN_ACCESS"

AccessVoter::__construct()

public function __construct(RouterInterface $router, ParameterBagInterface $parameterBag, LocalizerInterface $localizer, MaintenanceProviderInterface $maintenanceProvider, LauncherInterface $launcher)

AdminVoter class

class AdminVoter extends Voter AdminVoter.php:10

const BACKEND = "BACKEND"

AdminVoter::__construct()

public function __construct(RouterInterface $router)

ComplaintVoter class

class ComplaintVoter extends Voter ComplaintVoter.php:27

Who reads and answers a complaint (Base\Entity\User\Complaint).

COMPLAINT_READ / COMPLAINT_HANDLE, with the complaint as subject (or none: may this user read complaints at all). PermissionVoter alone cannot say it - it matches tags and ignores what they are about - so this voter adds the rule that matters:

  • to read complaints at all: the reader role (ROLE_MODERATOR by default), or the permission tag COMPLAINT.READ / COMPLAINT.HANDLE given to a user or a group (Permission, GrantPermissionAdapter);
  • a complaint about somebody of the staff is only for those who OUTRANK them: whose reachable roles hold all of theirs and more (the role hierarchy decides, not a list here) - moderators do not judge a moderator;
  • nobody reads a complaint about themselves, except the top role (ROLE_SUPERADMIN by default), which reads them all: somebody has to read the ones about the top.
const READ = "COMPLAINT_READ"
const HANDLE = "COMPLAINT_HANDLE"

ComplaintVoter::__construct()

public function __construct(readonly AccessDecisionManagerInterface $decisions, readonly RoleHierarchyInterface $hierarchy, readonly string $readerRole = "ROLE_MODERATOR", readonly string $topRole = "ROLE_SUPERADMIN")

PermissionVoter class

class PermissionVoter extends Voter PermissionVoter.php:21

Custom fine-grained permission names, backed by Base\Entity\User\Permission and granted through group membership (or directly on the user). This is the "customizable by base or app classes" extensibility a plain ROLE_* hierarchy can't offer: base-bundle-admin's own SecurityVoter already delegates every permission string through isGranted(), so registering this voter is all that's needed for Actions::setPermission()/ Crud::setEntityPermission()/MenuItem::setPermission() to accept a custom tag like "ARTICLE.PUBLISH" alongside a plain ROLE_* string - no changes to base-bundle-admin required.

Base\Serializer

Aco class

class Aco Aco.php:13

const BYTE_SIZE = 8
const VERSION_V1 = 1
const VERSION_V2 = 2
const RGB = 0
const HSB = 1
const CMYK = 2
const LAB = 7
const GRAYSCALE = 8
const WideCMYK = 9

Aco::parseFile()

public static function parseFile(string $filename, int $flags = self::VERSION_V2): array

Aco::parse()

public static function parse($handle, int $flags = self::VERSION_V2): array
Throws

Exception

Aco::dump()

public static function dump($input, int $flags = 0): string

Aco::getHeader()

public static function getHeader($handle)

Aco::getBlock()

public static function getBlock($handle, int $version)
Throws

Exception

Aco::sortByColor()

public static function sortByColor($array)

Aco::getClosest()

public function getClosest($rgb, $colors)

Excel class

class Excel Excel.php:23

const AS_COLLECTION_KEY = CsvEncoder::AS_COLLECTION_KEY
const HEADERS_IN_BOLD_KEY = 'headers_in_bold'
const HEADERS_HORIZONTAL_ALIGNMENT_KEY = 'headers_horizontal_alignment'
const COLUMNS_AUTOSIZE_KEY = 'columns_autosize'
const COLUMNS_MAXSIZE_KEY = 'columns_maxsize'

Excel::__construct()

public function __construct(mixed $data, string $format, array $context = [])

Excel::dump()

public function dump(): string

Excel::extension()

public static function extension(string $path)

Excel::parseFile()

public static function parseFile(string $filename, array $context = []): mixed

Excel::parse()

public static function parse(string $data, string $format, array $context = []): mixed

Base\Serializer\Encoder

AcoEncoder class

class AcoEncoder implements EncoderInterface, DecoderInterface AcoEncoder.php:9

const FORMAT = 'aco'

AcoEncoder::supportsEncoding()

public function supportsEncoding(string $format, array $context = []): bool

AcoEncoder::encode()

public function encode(mixed $data, string $format, array $context = []): string

AcoEncoder::supportsDecoding()

public function supportsDecoding(string $format, array $context = []): bool

AcoEncoder::decode()

public function decode(string $data, string $format, array $context = []): mixed

ExcelEncoder class

class ExcelEncoder implements EncoderInterface, DecoderInterface ExcelEncoder.php:9

const XLS = 'xls'

Formats constants.

const XLSX = 'xlsx'
const XLSM = 'xlsm'

ExcelEncoder::supportsEncoding()

public function supportsEncoding(string $format, array $context = []): bool

ExcelEncoder::encode()

public function encode(mixed $data, string $format, array $context = []): string

ExcelEncoder::supportsDecoding()

public function supportsDecoding(string $format, array $context = []): bool

ExcelEncoder::decode()

public function decode(string $data, string $format, array $context = []): mixed

Base\Service

Analytics class

class Analytics Analytics.php:24

Single entry point for this app's traffic counters: page views (a raw hit count per path) plus two independent unique-subject counters - anonymous "visitors" (cookie-identified, see the consent note on trackVisitor()) and authenticated "users" (Base\Entity\User ids) - both sliceable by the same time windows (today/24h, 7 days, 30 days, all time) because they're built on the exact same underlying mechanism (Base\Entity\Analytics\Visit's daily presence rows), just keyed differently. Storage/aggregation strategy lives in the two repositories; this class is the only thing application code (a request subscriber, an admin sidebar widget, ...) needs to know about.

Analytics::__construct()

public function __construct(readonly PageViewRepository $pageViews, readonly VisitRepository $visits, readonly UserAgentClassifier $userAgentClassifier, readonly ?PageVisitRepository $pageVisits = null)

Analytics::track()

public function track(string $path, ?string $visitorId = null, ?string $userId = null, ?string $userAgent = null): void

Call once per trackable request. $visitorId is the ANALYTICS/ VISITOR_ID cookie value if present - deliberately never generated or set here: that cookie is written client-side via Cookie.set("ANALYTICS", "VISITOR_ID", ...) (see @glitchr/flowjs/cookie), which silently no-ops without consent. A visit with no visitor cookie still counts toward pageViews() (an anonymous hit, no identity involved) but never toward uniqueVisitors() - consent is what turns a hit into a de-duplicated visitor, not the other way around. $userId has no such gating: it's the already-authenticated session's own account.

$userAgent decides which PageView::SOURCE_* bucket the hit lands in (via UserAgentClassifier) - null (the default, used by callers that never had an HTTP request to read a header from, e.g. this class's own test suite) is treated as SOURCE_HUMAN rather than run through the classifier, which would otherwise classify a truly empty/missing User-Agent as SOURCE_BOT. A hit classified as anything other than SOURCE_HUMAN never reaches the visitor/user presence tables below - a crawler's stray cookie or session should never count as a real unique visitor.

Analytics::pageViews()

public function pageViews(?string $path = null, ?string $window = null, ?string $source = null): int

Total hits. $path null = every page (site-wide). $source null = every source combined (human + bot + ai); pass a PageView::SOURCE_* constant to see just that bucket's hits.

Analytics::uniqueVisitors()

public function uniqueVisitors(?string $window = null): int

Distinct anonymous (cookie-consented) visitors.

Analytics::uniqueViews()

public function uniqueViews(?string $window = null, ?string $path = null): int

Unique views: distinct (page, identified subject) pairs in the window.

pageViews() counts hits - a reload is a view. This counts a person on a page once. Only identified subjects can be told apart, so the two are not comparable as "x% of views were unique": an anonymous visitor who declined the cookie produces views and no unique view at all.

Analytics::retention()

public function retention(?int $days = 7): array

Retention over two back-to-back windows of $days days, the second ending today: the share of subjects active in the earlier window who came back in the later one, per subject type, as a percentage.

Same day boundaries as dailyBreakdown(), so "7" means the same seven days the chart shows. Null when nobody was active in the earlier window (no base to be a share of), or when $days is null - "all time" has no earlier window.

Analytics::uniqueUsers()

public function uniqueUsers(?string $window = null): int

Distinct authenticated user accounts active in the window.

Analytics::summary()

public function summary(): array

The set of numbers an admin sidebar widget wants at a glance - every counter across every standard window in one round trip's worth of queries (9 small aggregate queries, all against the tiny daily-rollup tables - cheap regardless of how much traffic has accumulated behind them).

Analytics::dailyBreakdown()

public function dailyBreakdown(?int $days = 14, string|array|null $path = null): array

Day-by-day series for the last $days calendar days (oldest first, today included) - the raw data a dashboard trend chart plots directly. Unlike summary()'s window totals, a day with genuinely zero activity is filled in as 0 rather than omitted, so a chart never has to guess at a gap in the x-axis.

$days = null means "all time": since the earliest day anything was ever tracked (today, if nothing ever was - a 1-day series rather than an empty one, so callers never have to special-case "no data yet" separately from "no data in this window").

$path null means every page summed together (the original, site- wide semantics); pass an exact path to scope the PAGE-VIEW columns to one page instead (e.g. a single Article's own traffic trend), or a list of paths to scope to any of them (e.g. every Article's own __toLink(), for a whole-class rollup - there's no single stable path PREFIX shared by every instance of a class in this app's routing, so "all articles" means the exact set of their own generated links, not a LIKE pattern). uniqueVisitors/uniqueUsers stay SITE-WIDE regardless of $path - the underlying presence records (Visit) have no path of their own at all (see Visit's own docblock), so "unique visitors to this one page" isn't a question this data model can answer yet. A $path- scoped caller should simply not read those two columns rather than this method fabricating a page-specific number it can't back up.

Analytics::hourlyBreakdown()

public function hourlyBreakdown(string|array|null $path = null): array

Hour-by-hour series for TODAY only (hour 0 through the current hour, oldest first) - the one range short enough that a per-hour curve is actually legible, unlike dailyBreakdown()'s calendar-day grain. No hours past "now" are included (an all-zero flat tail for the rest of the day would just read as "no traffic yet", not as "hasn't happened yet" - the two look identical on a chart, so there's no honest way to zero-fill them).

Same $path convention as dailyBreakdown().

Analytics::periodOverPeriodChange()

public function periodOverPeriodChange(?int $days): array

This $days-day window vs the $days days before it, as a signed percentage per counter - the "up/down vs the prior period" badge a dashboard trend card needs, generalized from what used to be a hardcoded 7-vs-7 (see weekOverWeekChange(), now just this with $days=7 - kept as its own method since existing callers already expect that exact contract). Reuses dailyBreakdown($days*2) rather than four more window queries: the same rows already answer both halves. $days=null (an "all time" window has no prior period to compare against) short-circuits to every counter null, same shape as the "prior period was zero" case below.

Returns

null when the prior period was zero (no meaningful percentage to show) or $days is null

Analytics::weekOverWeekChange()

public function weekOverWeekChange(): array

Analytics::displayBucket()

public static function displayBucket(string $bucket): \DateTimeImmutable

A bucket key from dailyBreakdown()/hourlyBreakdown(), as a date to show.

Hourly keys ("Y-m-d H:i:s", UTC) are shifted to the viewer's own timezone, so 11:00 UTC reads 13:00 in Paris. Daily keys ("Y-m-d") are UTC calendar days and are shown as they are: shifting their midnight would move the date back a day for anyone west of Greenwich.

ArrayParameterBag class

class ArrayParameterBag implements ParameterBagInterface ArrayParameterBag.php:16

The application's parameters given as an array, by their full names ("base.attributes.use_custom" => true), read by a dotted path as Base\Service\ParameterBag reads the container's: omnibase's ParameterBagInterface where there is no container (an entity manager built by hand, Base\Bridge\Doctrine\Mapping). A path names a value or the values under it ("base.attributes" is ['use_custom' => true, ...]).

ArrayParameterBag::__construct()

public function __construct(array $parameters = [])

ArrayParameterBag::get()

public function get(string $key = "", ?array $bag = null): array|bool|string|int|float|UnitEnum|null

ArrayParameterBag::set()

public function set(string $path, array|bool|string|int|float|UnitEnum|null $value, ?array &$bag = null): void

ArrayParameterBag::has()

public function has(string $path, ?array $bag = null): bool

ArrayParameterBag::all()

public function all(): array

BaseService class

class BaseService implements RuntimeExtensionInterface BaseService.php:59

BaseService::getContainer()

public function getContainer($name)

BaseService::getAvailableServices()

public function getAvailableServices(): array

BaseService::__construct()

public function __construct(KernelInterface $kernel, RequestStack $requestStack, FirewallMapInterface $firewallMap, Environment $twig, SluggerInterface $slugger, ManagerRegistry $doctrine, AuthorizationCheckerInterface $authorizationChecker, TokenStorageInterface $tokenStorage, CsrfTokenManagerInterface $csrfTokenManager, ParameterBagInterface $parameterBag, NotifierInterface $notifier, FormFactoryInterface $formFactory, LocalizerInterface $localizer, TradingInterface $tradingMarket, Obfuscator $obfuscator, SettingBag $settingBag, MediaService $mediaService, IconProvider $iconProvider, TranslatorInterface $translator, AdvancedRouterInterface $router, EntityHydratorInterface $entityHydrator, ClassMetadataManipulator $classMetadataManipulator, ?Profiler $profiler)

BaseService::getRouteIndex()

public function getRouteIndex(): string

BaseService::getSite()

public function getSite()

BaseService::getAdmin()

public function getAdmin()

BaseService::getEmail()

public function getEmail()

BaseService::getMeta()

public function getMeta(?string $locale = null): array

BaseService::exec()

public function exec(string $command, array $arguments = [])
Throws

Exception

BaseService::settings()

public function settings()

BaseService::getExecutionTime()

public function getExecutionTime(): float

BaseService::startTime()

public function startTime(?float $startTime = null)

BaseService::hasGet()

public function hasGet()

BaseService::hasPost()

public function hasPost()

BaseService::hasSession()

public function hasSession()

BaseService::addSession()

public function addSession($name, $value)

BaseService::removeSession()

public function removeSession($name)

BaseService::getSession()

public function getSession($name = null)

BaseService::createForm()

public function createForm($type, $data = null, array $options = []): FormInterface

BaseService::getLocale()

public function getLocale(?string $locale = null)

BaseService::getSalt()

public function getSalt()

BaseService::getSecret()

public function getSecret()

BaseService::getProfiler()

public function getProfiler(): ?Profiler

BaseService::getProfile()

public function getProfile($response = null)

BaseService::getParameter()

public function getParameter(string $name): array|bool|string|int|float|null

BaseService::hasParameter()

public function hasParameter(string $name): bool

BaseService::setParameter()

public function setParameter(string $name, array|bool|string|int|float|null $value)

BaseService::getAsset()

public function getAsset(string $url): string

BaseService::getRequest()

public function getRequest(): ?Request

BaseService::getCurrentRequest()

public function getCurrentRequest(): ?Request

BaseService::getRoute()

public function getRoute(?string $url): ?Route

BaseService::getCurrentRoute()

public function getCurrentRoute(): ?Route

BaseService::getRouteName()

public function getRouteName(?string $url): ?string

BaseService::getCurrentRouteName()

public function getCurrentRouteName(): ?string

BaseService::generateUrl()

public function generateUrl(string $routeName, array $routeParameters = []): string

BaseService::redirect()

public function redirect(string $urlOrRoute, array $routeParameters = [], int $state = 302, array $headers = []): RedirectResponse

BaseService::redirectToRoute()

public function redirectToRoute(string $routeName, array $routeParameters = [], int $state = 302, array $headers = []): ?RedirectResponse

BaseService::refresh()

public function refresh(?Request $request = null): RedirectResponse

BaseService::isDevelopment()

public function isDevelopment()

BaseService::isProduction()

public function isProduction()

BaseService::isCli()

public function isCli()

BaseService::isDebug()

public function isDebug()

BaseService::isAdmin()

public function isAdmin()

BaseService::isProfiler()

public function isProfiler()

BaseService::isEntity()

public function isEntity(mixed $entityOrClassOrMetadata): bool

BaseService::setUserIdentifier()

public function setUserIdentifier(string $userIdentifier)

Security container related methods

BaseService::isCsrfTokenValid()

public function isCsrfTokenValid(string $id, $tokenOrForm, ?Request $request = null, string $csrfFieldId = "_csrf_token"): bool
Throws

Exception

BaseService::getToken()

public function getToken()
Throws

Exception

BaseService::getUser()

public function getUser()
Throws

Exception

BaseService::isGranted()

public function isGranted($attribute, $subject = null): bool
Throws

Exception

BaseService::inDoctrine()

public function inDoctrine($entity): bool

Doctrine related methods

BaseService::inDoctrineStack()

public function inDoctrineStack()

BaseService::getOriginalEntityData()

public function getOriginalEntityData($eventOrEntity, bool $inDoctrineStack = false, bool $reopen = false)
Throws

Exception

BaseService::getOriginalEntity()

public function getOriginalEntity($eventOrEntity, bool $inDoctrineStack = false, bool $reopen = false)
Throws

Exception

Breadgrinder class

class Breadgrinder implements BreadgrinderInterface Breadgrinder.php:8

Breadgrinder::__construct()

public function __construct(RouterInterface $router, TranslatorInterface $translator, ParameterBagInterface $parameterBag)

Breadgrinder::has()

public function has(string $name): bool

Breadgrinder::grind()

public function grind(string $name, array $options = [], ?string $template = null): Breadcrumb

BreadgrinderInterface interface

interface BreadgrinderInterface BreadgrinderInterface.php:7

BreadgrinderInterface::grind()

public function grind(string $name): Breadcrumb

ColorExtractor class

class ColorExtractor ColorExtractor.php:9

ColorExtractor::__construct()

public function __construct(Palette $palette)

ColorExtractor::extract()

public function extract(int $colorCount = 1): array

CommentGuard class

class CommentGuard CommentGuard.php:20

The comment forms' face of Base\Service\FormGuard, kept for the bundles that ask it (omnibase/blog, omnibase/video): the trap filled, a form sent faster than a person types, a second comment from the same address within the flood interval (base.comments.min_delay, base.comments.flood_interval).

Each answers with a reason the controller turns into a form error - except the trap, which should be thanked and dropped so the robot learns nothing.

Reads the form Base\Form\Type\CommentType builds: its url trap and its opened time - or the fields the option guard adds.

const TRAPPED = FormGuard::TRAPPED
const TOO_FAST = FormGuard::TOO_FAST
const FLOOD = FormGuard::FLOOD

CommentGuard::__construct()

public function __construct(protected readonly FormGuard $guard, protected readonly int $minDelay = 4, protected readonly int $floodInterval = 60)

CommentGuard::check()

public function check(FormInterface $form, Request $request, ?int $minDelay = null, ?int $floodInterval = null): ?string

null when the comment may go on to Akismet.

class DownloadLinks DownloadLinks.php:22

Signed download links: a route's absolute URL, signed by Symfony's UriSigner and valid for a while (base.download_links.ttl seconds unless told otherwise). Whoever holds one within that time gets the file - who may was checked when it was handed out (a licence, an entitlement, a voter). The one place for it: omnibase/forge's artifacts and omnibase/classroom's resources sign theirs here.

$url = $links->sign('forge_download_file', ['id' => 7, 'filename' => 'app.zip', 'license' => 3], 900); // in the download action: if (!$links->verify($request)) { throw $this->createAccessDeniedException(); }

DownloadLinks::__construct()

public function __construct(protected readonly UriSigner $signer, protected readonly UrlGeneratorInterface $router, protected readonly int $ttl = 600)
public function sign(string $route, array $parameters = [], ?int $ttl = null): string
$parameters

the route's parameters, and who the link was issued to

public function verify(Request $request): bool

The request's URL is one this site signed, and it has not run out.

public function ttl(): int

EditorEnhancer class

class EditorEnhancer extends WysiwygEnhancer implements EditorEnhancerInterface EditorEnhancer.php:8

EditorEnhancer::supports()

public function supports(mixed $json): bool

EditorEnhancer::render()

public function render(mixed $json, array $options = []): string

EditorEnhancer::getTableOfContents()

public function getTableOfContents(mixed $json, ?int $maxLevel = null): array

EditorEnhancer::enhanceHeadings()

public function enhanceHeadings(mixed $json, ?int $maxLevel = null, array $attrs = []): mixed

EditorEnhancer::enhanceSemantics()

public function enhanceSemantics(mixed $json, null|array|string $words = null, array $attrs = []): mixed

EditorEnhancer::enhanceMentions()

public function enhanceMentions(mixed $json, array $attrs = []): mixed
public function enhanceLinks(mixed $json, array $attrs = []): mixed

EditorEnhancer::enhanceMedia()

public function enhanceMedia(mixed $json, array $config = [], FilterInterface|array $filters = [], array $attrs = []): mixed

EditorEnhancerInterface interface

interface EditorEnhancerInterface extends WysiwygEnhancerInterface EditorEnhancerInterface.php:5

Embeds class

class Embeds Embeds.php:25

An address (a video, a song, a board, a slideshow) turned into what a page can frame - the Twig function embed_url():

{% set frame = embed_url(link) %} {% if frame and frame.src %}<iframe src="{{ frame.src }}" style="aspect-ratio: {{ frame.ratio }}"…>{% endif %}

The providers known to allow framing are read from the address itself, without a request (KNOWN: YouTube in its no-cookie form, Vimeo, Canva, Padlet, LearningApps, Genially, Google Slides). Anything else is asked to its own site through the embed/embed library (oEmbed, Open Graph), once a day per address, when the library is installed; its iframe's address is kept, never its script. Nothing found: null - a plain link on the page.

const KNOWN = ['Canva', 'Padlet', 'YouTube', 'Vimeo', 'LearningApps', 'Genially', 'Google Slides']

Embeds::__construct()

public function __construct(protected readonly ?CacheInterface $cache = null, protected readonly ?LoggerInterface $logger = null, protected readonly bool $remote = true)

Embeds::resolve()

public function resolve(?string $url, bool $remote = true): ?array

Embeds::known()

public function known(string $url): ?array
Returns

the providers read from the address alone

FileService class

class FileService implements FileServiceInterface FileService.php:14

const USE_SHORT = Obfuscator::USE_SHORT

FileService::__construct()

public function __construct(Environment $twig, AdvancedRouterInterface $router, ObfuscatorInterface $obfuscator, FlysystemInterface $flysystem, ParameterBagInterface $parameterBag)

FileService::getProjectDir()

public function getProjectDir()

FileService::getPublicDir()

public function getPublicDir()

FileService::getExtension()

public function getExtension(null|string|array $fileOrMimetypeOrArray): ?string

FileService::getExtensions()

public function getExtensions(null|string|array $fileOrMimetypeOrArray): array

FileService::getMimeType()

public function getMimeType(null|string|array $fileOrContentsOrArray): null|string|array

FileService::linkable()

public function linkable(array|string|null $path, array $config = []): array|string|null

FileService::downloadable()

public function downloadable(array|string|null $path, array $config = []): array|string|null

FileService::public()

public function public(array|string|null $path, ?string $storage = null): array|string|null

FileService::asset()

public function asset(string $path, ?string $packageName = null): ?string

FileService::isEmpty()

public function isEmpty(?string $file)

FileService::isImage()

public function isImage(?string $file)

FileService::isSvg()

public function isSvg(?string $file)

FileService::filesize()

public function filesize($size, array $unitPrefix = DECIMAL_PREFIX): string

FileService::obfuscate()

public function obfuscate(string|null $path, array $config = []): ?string

FileService::generate()

public function generate(string $proxyRoute, array $proxyRouteParameters = [], ?string $path = null, array $config = []): ?string

FileService::resolve()

public function resolve(string $data): ?array

FileService::serve()

public function serve(?string $path, int $status = 200, array $headers = []): ?Response

FileService::serveContents()

public function serveContents(?string $contents, int $status = 200, array $headers = []): ?Response

FileServiceInterface interface

interface FileServiceInterface FileServiceInterface.php:7

FileServiceInterface::getExtension()

public function getExtension(null|string|array $fileOrMimetypeOrArray): ?string

FileServiceInterface::getExtensions()

public function getExtensions(null|string|array $fileOrMimetypeOrArray): null|string|array

FileServiceInterface::getMimeType()

public function getMimeType(null|string|array $fileOrContentsOrArray): null|string|array

FileServiceInterface::generate()

public function generate(string $proxyRoute, array $proxyRouteParameters, ?string $path, array $config = []): ?string

FileServiceInterface::resolve()

public function resolve(string $data): ?array

FileServiceInterface::serve()

public function serve(?string $path, int $status = 200, array $headers = []): null|bool|Response

FileServiceInterface::serveContents()

public function serveContents(?string $contents, int $status = 200, array $headers = []): null|bool|Response

Flysystem class

class Flysystem extends LazyFactory implements FlysystemInterface Flysystem.php:28

Flysystem::getProjectDir()

public static function getProjectDir()

Flysystem::getPublicDir()

public static function getPublicDir()

Flysystem::__construct()

public function __construct(...$args)

Flysystem::createStorage()

public function createStorage(string $source, ?string $storageName = null): \League\Flysystem\FilesystemOperator
Throws

ContainerExceptionInterface

Throws

NotFoundExceptionInterface

Flysystem::hasStorage()

public function hasStorage(string $storageName): bool

Flysystem::getStorageNames()

public function getStorageNames(bool $public = true): array

Flysystem::getDefaultStorage()

public function getDefaultStorage(): FilesystemOperator

Flysystem::setDefaultStorage()

public function setDefaultStorage(FilesystemOperator|string $operator)

Flysystem::getOperator()

public function getOperator(FilesystemOperator|string|null $operator = null): FilesystemOperator

Flysystem::getAdapter()

public function getAdapter(FilesystemOperator|string|null $operator = null): FilesystemAdapter

Flysystem::getConnectionOptions()

public function getConnectionOptions(FilesystemOperator|string|null $operator = null): ?array

Flysystem::prefixPath()

public function prefixPath(string $path, FilesystemOperator|string|null $operator = null)

Flysystem::stripPrefix()

public function stripPrefix(string $path, FilesystemOperator|string|null $operator = null)

Flysystem::read()

public function read(string $path, FilesystemOperator|string|null $operator = null): ?string

Flysystem::write()

public function write(string $path, string $contents, FilesystemOperator|string|null $operator = null, array $config = []): bool

Flysystem::delete()

public function delete(string $path, FilesystemOperator|string|null $operator = null): bool

Flysystem::fileExists()

public function fileExists(string $path, FilesystemOperator|string|null $operator = null): bool

Flysystem::mkdir()

public function mkdir(string $path, FilesystemOperator|string|null $operator = null, array $config = []): bool

Flysystem::mimeType()

public function mimeType(string $path, FilesystemOperator|string|null $operator = null): ?string

Flysystem::get()

public function get(mixed $path, FilesystemOperator|string|null $operator = null)

Flysystem::getPublicRoot()

public function getPublicRoot(FilesystemOperator|string|null $operator = null): ?string

Flysystem::isRemote()

public function isRemote(FilesystemOperator|string|null $operator = null)

Flysystem::getPublic()

public function getPublic(mixed $path, FilesystemOperator|string|null $operator = null)

FlysystemInterface interface

interface FlysystemInterface FlysystemInterface.php:8

FlysystemInterface::getProjectDir()

public static function getProjectDir()

FlysystemInterface::getPublicDir()

public static function getPublicDir()

FlysystemInterface::hasStorage()

public function hasStorage(string $storageName): bool

FlysystemInterface::getStorageNames()

public function getStorageNames(bool $public = true): array

FlysystemInterface::getDefaultStorage()

public function getDefaultStorage(): FilesystemOperator

FlysystemInterface::setDefaultStorage()

public function setDefaultStorage(FilesystemOperator|string $operator)

FlysystemInterface::getPublic()

public function getPublic(mixed $path, FilesystemOperator|string|null $operator = null)

FlysystemInterface::getPublicRoot()

public function getPublicRoot(FilesystemOperator|string|null $operator = null): ?string

FlysystemInterface::getOperator()

public function getOperator(FilesystemOperator|string|null $operator = null): FilesystemOperator

FlysystemInterface::getAdapter()

public function getAdapter(FilesystemOperator|string|null $operator = null): FilesystemAdapter

FlysystemInterface::prefixPath()

public function prefixPath(string $path, FilesystemOperator|string|null $operator = null)

FlysystemInterface::stripPrefix()

public function stripPrefix(string $path, FilesystemOperator|string|null $operator = null)

FlysystemInterface::read()

public function read(string $path, FilesystemOperator|string|null $operator = null): ?string

FlysystemInterface::write()

public function write(string $path, string $contents, FilesystemOperator|string|null $operator = null, array $config = []): bool

FlysystemInterface::delete()

public function delete(string $path, FilesystemOperator|string|null $operator = null): bool

FlysystemInterface::fileExists()

public function fileExists(string $path, FilesystemOperator|string|null $operator = null): bool

FlysystemInterface::isRemote()

public function isRemote(FilesystemOperator|string|null $operator = null)

FlysystemInterface::mkdir()

public function mkdir(string $path, FilesystemOperator|string|null $operator = null, array $config = []): bool

FlysystemInterface::mimeType()

public function mimeType(string $path, FilesystemOperator|string|null $operator = null): ?string

FlysystemInterface::get()

public function get(mixed $path, FilesystemOperator|string|null $operator = null)

FormGuard class

class FormGuard FormGuard.php:43

What stands between a form and a robot, in the order it is asked (docs/20-architecture/guard.md):

1. the trap - a field off-screen for people, filled by robots; 2. the time - a form sent faster than a person reads it, by a stamp signed with the application's secret when it was shown; 3. the lists - whoever sends it (address, e-mail, name) asked of the gateways of base.guard.reputation: disposable e-mail domains, StopForumSpam; 4. the captcha - a field of glitchr/omnishield (ChallengeType) on the gateway of base.guard.challenge, checked by the guard - shown and asked only from base.guard.captcha_after refused tries of this form from this visitor (counted in cache.app for 15 minutes, forgotten after a form sent); 5. what was written - the classifier behind SpamChecker (Akismet), for the data that implement SpamProtectionInterface.

Without glitchr/omnishield, or without a gateway, the trap and the time alone. The option guard of a form asks for it (Base\Form\Extension\FormTypeGuardExtension); CommentGuard is the comment forms' face of it, with their flood interval.

Each answer is a reason, a translation key of the "forms" domain (guard.<reason>) - but the trap, which a controller may rather thank and forget, so that the robot learns nothing.

const TRAPPED = 'trapped'
const TOO_FAST = 'too_fast'
const STALE = 'stale'
const FLOOD = 'flood'
const KNOWN = 'known'
const DISPOSABLE = 'disposable'
const UNREACHABLE = 'unreachable'
const SPAM = 'spam'
const CHALLENGE_MISSING = 'challenge_missing'

The captcha's answers: no token, a token refused, a provider that did not answer.

const CHALLENGE_FAILED = 'challenge_failed'
const CHALLENGE_UNREACHABLE = 'challenge_unreachable'
const CHALLENGE_MESSAGES = [self::CHALLENGE_MISSING => 'Please confirm that you are not a robot.', self::CHALLENGE_FAILED => 'The check that you are not a robot did not pass. Please tr…

What they say: glitchr/omnishield's own sentences (PassesChallenge), translated in the "validators" domain.

const TRAP_FIELD = 'guard_website'

The fields the option guard adds to a form: the trap, the stamp, the captcha.

const STAMP_FIELD = 'guard_opened'
const CHALLENGE_FIELD = 'guard_captcha'
const FALLBACK_FIELD = 'guard_captcha_fallback'

The captcha that reaches nobody, shown while the visitor has not agreed to the one that does.

const ATTEMPT_WINDOW = 900

Seconds a refused try of a form is remembered (base.guard.captcha_after).

FormGuard::__construct()

public function __construct(protected readonly string $secret, protected readonly array $config = [], protected readonly ?Registry $registry = null, protected readonly ?CommentRepository $comments = null, protected readonly ?string $defaultChallenge = null, protected readonly ?LoggerInterface $logger = null, protected readonly bool $acceptUnreachableChallenge = false, protected readonly ?CacheItemPoolInterface $cache = null)
$config

base.guard

$defaultChallenge

omnishield.challenge.gateway, when glitchr/omnishield is installed (GuardPass)

$cache

where a form's refused tries are counted; without it, the captcha is always asked

FormGuard::hasOmnishield()

public function hasOmnishield(): bool

Whether glitchr/omnishield is here, with its gateways.

FormGuard::getRegistry()

public function getRegistry(): ?Registry

FormGuard::minDelay()

public function minDelay(): int

FormGuard::signInAfter()

public function signInAfter(): int

Failed sign-ins from an address before the sign-in form asks the captcha. 0: never.

FormGuard::captchaAfter()

public function captchaAfter(): int

Refused tries of a guarded form, from a visitor, before its captcha is shown and asked. 0: always.

FormGuard::captchaAsked()

public function captchaAsked(string $form, int $after, ?Request $request): bool

Whether the captcha of the form $form is shown and asked of this visitor: always when $after is 0, or when their tries cannot be counted (no cache, no address, no session); otherwise from $after tries refused.

FormGuard::failures()

public function failures(string $form, ?Request $request): ?int

The refused tries of the form $form from this visitor in the last 15 minutes; null when they cannot be counted.

FormGuard::failed()

public function failed(string $form, ?Request $request): void

One more refused try: the guard said no (trap, time, lists, captcha, spam), or the form is invalid.

FormGuard::succeeded()

public function succeeded(string $form, ?Request $request): void

A form sent: its tries are forgotten.

FormGuard::challengeGateway()

public function challengeGateway(): ?string

The captcha's gateway: base.guard.challenge, else omnishield's default - null when there is none, or when omnishield's form field is missing.

FormGuard::fallbackGateway()

public function fallbackGateway(): ?string

The captcha shown to a visitor who refused the third party the default one reaches.

FormGuard::reputationGateways()

public function reputationGateways(): array
Returns

the lists asked about whoever submits, those configured in omnishield

FormGuard::classifierGateway()

public function classifierGateway(): ?string

FormGuard::rejectsUnreachable()

public function rejectsUnreachable(): bool

FormGuard::stamp()

public function stamp(?int $time = null): string

When the form was shown, signed: "<time>.<signature>".

FormGuard::elapsed()

public function elapsed(?string $stamp): ?int

Seconds since the stamp was made; null for one that is not ours (forged, cut, missing).

FormGuard::inspect()

public function inspect(FormInterface $form, ?Request $request, ?int $minDelay = null, string $emailField = 'email', string $nameField = 'name', bool $lists = true): ?array

The trap and the time of a guarded form (the fields the option guard added), then the lists. Null when the form may go on to its captcha and its classifier.

Returns

the reason, and the field it is about (null: the form)

FormGuard::reputation()

public function reputation(Identity $identity): ?string

What the lists of base.guard.reputation say of whoever submits: null when none knows them; DISPOSABLE for an e-mail of a throwaway domain; KNOWN otherwise; UNREACHABLE for a list that did not answer when base.guard.unreachable is "reject".

FormGuard::challenge()

public function challenge(string $gateway, ?string $token, ?Request $request, ?string $action = null): ?string

The captcha's token, asked of its gateway - once, after the trap, the time and the lists: a robot they caught spends nothing at the provider.

Null when it holds; otherwise one of CHALLENGE_*. A provider that does not answer follows omnishield.challenge.unreachable; a key refused is the site's error, let through and logged.

FormGuard::check()

public function check(FormInterface $form, Request $request, ?int $minDelay = null, int $floodInterval = 0): ?string

The comment forms' check (Base\Form\Type\CommentType: its url trap, its opened time; or the fields the option guard adds), and a second comment from the same address within $floodInterval. Null when the comment may go on to its classifier.

GroupManager class

class GroupManager GroupManager.php:32

The one service that turns a score into an actual capability.

Everything up to here computes and grants nothing: Group::isOpenTo() says whether somebody qualifies and Group::awardsFor() says what they would get, both without touching them. Something has to close the gap, and in fr.latoucheoriginale.www that something is a single service - MarketplaceManager - which evaluates every candidate's scopes and rules, then applies what its actions return. This is the same thing for people.

The evaluation loop is deliberately the same shape as getPromotion()'s, including its short-circuits, with one difference that matters: a promotion stops at the first candidate that fits, because a product gets one promotion. A person can qualify for several groups at once, so nothing breaks out of the candidate loop here.

Permission tags are resolved to rows here rather than in the adapter, which is the whole reason GrantPermissionAdapter returns strings: an entity that queries is an entity you cannot evaluate offline, so the lookup belongs in the only layer that already has a repository.

GroupManager::__construct()

public function __construct(protected readonly GroupRepository $groupRepository, protected readonly PermissionRepository $permissionRepository, protected readonly EntityManagerInterface $entityManager)

GroupManager::getEligibleGroups()

public function getEligibleGroups(User $user): array

Every group that would admit this user as things stand.

Includes ones they already belong to: this answers "do they qualify", not "what is new", because a group they qualified for yesterday and no longer do is exactly what a caller checking for revocation needs to see missing from this list.

GroupManager::getAwards()

public function getAwards(User $user): array

What those groups would award, merged across all of them.

GroupManager::synchronize()

public function synchronize(User $user, bool $join = true): array

Bring the user in line with what they have earned, and report what actually changed.

Additive by design. Nothing here removes a role, a permission or a membership, because "no longer eligible" and "should be stripped" are different decisions: a punitive score dip should not silently cost somebody a rank they were given, and deciding otherwise is a policy call for the caller rather than a side effect of a sync. getAwards() above is what a caller compares against to make that call.

Returns only the differences, so an unchanged user yields empty arrays and a caller can flush, notify or log on that alone.

HotParameterBag class

class HotParameterBag extends ParameterBag implements HotParameterBagInterface HotParameterBag.php:8

const HOT_N_READY = false

HotParameterBag::add()

public function add(array $parameters): void

HotParameterBag::all()

public function all(): array

HotParameterBag::has()

public function has(string $path, ?array $bag = null, bool $useHotBag = true): bool

HotParameterBag::get()

public function get(string $path = "", ?array $bag = null, bool $useHotBag = true): array|bool|string|int|float|null

HotParameterBag::isReady()

public function isReady(): bool

HotParameterBag::markAsReady()

public function markAsReady(bool $ready = true)

HotParameterBagInterface interface

interface HotParameterBagInterface extends ParameterBagInterface HotParameterBagInterface.php:7

HotParameterBagInterface::add()

public function add(array $parameters): void

HotParameterBagInterface::get()

public function get(string $path = "", ?array $bag = null, bool $useHotBag = true): array|bool|string|int|float|null

HotParameterBagInterface::has()

public function has(string $path, ?array $bag = null, bool $useHotBag = true): bool

HotParameterBagInterface::markAsReady()

public function markAsReady(bool $ready = true)

HotParameterBagInterface::isReady()

public function isReady(): bool

IconProvider class

class IconProvider extends AbstractLocalCache IconProvider.php:15

IconProvider::__construct()

public function __construct(AttributeReader $attributeReader, MediaServiceInterface $mediaService, LocalizerInterface $localizer, AdvancedRouterInterface $router, string $cacheDir, ?string $buildDir = null)

IconProvider::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

IconProvider::getRouteIcons()

public function getRouteIcons(?string $route = null)

IconProvider::getAdapters()

public function getAdapters()

IconProvider::getAdapter()

public function getAdapter(string $idOrClass): ?IconAdapterInterface

IconProvider::addAdapter()

public function addAdapter(IconAdapterInterface $provider): self

IconProvider::removeAdapter()

public function removeAdapter(IconAdapterInterface $provider): self

IconProvider::iconify()

public function iconify(null|string|array|EnumType|IconizeInterface $icon, array $attributes = [], bool $wrap = true): null|string|array

Invitations class

class Invitations Invitations.php:19

Invitation by token: nobody signs up, someone is invited. The token is random, sent once and never stored - only its SHA-256 is kept, so a leaked table opens nothing. Following the link creates the account (the link proved the address) or attaches the one that exists.

A bundle extends it to say what an invitation opens and what accepting does (omnibase/estate's Invitations); the token, the lookup, the expiry and the account are here.

const TOKEN_BYTES = 24

Invitations::__construct()

public function __construct(protected readonly EntityManagerInterface $entityManager, protected readonly string $userClass = 'App\Entity\User')

Invitations::token()

public static function token(): string

A new token: 48 hexadecimal characters.

Invitations::hash()

public static function hash(string $token): string

Invitations::expiry()

public static function expiry(int $days): \DateTimeImmutable

Invitations::save()

public function save(Invitation $invitation): Invitation

Saved, its token's hash only.

Invitations::findOpen()

public function findOpen(string $class, string $token): ?Invitation

The open invitation a token belongs to; null once accepted or run out.

Invitations::markAccepted()

public function markAccepted(Invitation $invitation): void

Marked accepted. What it opens is the extending bundle's business.

Invitations::createUser()

public function createUser(Invitation $invitation, string $username, string $plainPassword): User

A new account for an invitation's e-mail, verified: the link proved the address.

Invitations::existingUser()

public function existingUser(Invitation $invitation): ?User

The account that already has the invitation's e-mail, if any.

Launcher class

class Launcher implements LauncherInterface Launcher.php:13

Launcher::__construct()

public function __construct(AdvancedRouterInterface $router, ParameterBagInterface $parameterBag, SettingBagInterface $settingBag, AuthorizationCheckerInterface $authorizationChecker, TokenStorageInterface $tokenStorage)

Launcher::getLaunchdate()

public function getLaunchdate(?string $locale = null): ?DateTime

Launcher::isLaunched()

public function isLaunched(?string $locale = null): ?bool

Launcher::since()

public function since(?string $locale = null): string

Launcher::redirectOnDeny()

public function redirectOnDeny(?RequestEvent $event = null, ?string $locale = null): bool

LauncherInterface interface

interface LauncherInterface LauncherInterface.php:8

LauncherInterface::getLaunchdate()

public function getLaunchdate(?string $locale = null): ?DateTime

LauncherInterface::isLaunched()

public function isLaunched(?string $locale = null): ?bool

LauncherInterface::since()

public function since(?string $locale = null): string

LauncherInterface::redirectOnDeny()

public function redirectOnDeny(?RequestEvent $event = null): bool

LocalBusiness class

class LocalBusiness LocalBusiness.php:21

schema.org's LocalBusiness for the page's JSON-LD: who the business is, where, how to reach it, when it is open. Search engines read the address, the phone and the hours (the days off too) from there.

Each property is taken, in this order, from what the caller gives, from the back office's settings (base.settings.title, .slogan, .phone, .address.*), from the configuration (base.local_business.*). The hours are Base\Service\OpeningHours::schema(), for the whole site or for one place. A property nobody gives is left out.

In a template: {{ local_business_jsonld() }} (docs/40-commons/local-business.md).

const JSON_FLAGS = \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE | \JSON_HEX_TAG | \JSON_HEX_AMP

LocalBusiness::__construct()

public function __construct(protected readonly OpeningHours $hours, protected readonly ?SettingBagInterface $settings = null, protected readonly ?RequestStack $requests = null, protected readonly array $config = [])
$config

base.local_business

LocalBusiness::schema()

public function schema(array $overrides = [], string|object|null $scope = null): array
$overrides

schema.org properties that win over everything (null removes one)

$scope

one place's hours (OpeningHours::for()); null: the site's

LocalBusiness::jsonLd()

public function jsonLd(array $overrides = [], string|object|null $scope = null): string

The <script type="application/ld+json"> of the page.

Localizer class

class Localizer extends AbstractLocalCache implements LocalizerInterface Localizer.php:18

const LOCALE_FORMAT = "xx-XX"
const SEPARATOR = "-"
const MAX_CACHED_LOCALES = 256

Upper bound for the normalizeLocale() memo; see the check in that method.

Localizer::isLate()

public static function isLate(): bool

Localizer::markAsLate()

public static function markAsLate(?string $location = null)

Localizer::forgetRequestState()

public static function forgetRequestState(): void

isLate records that the locale has been resolved for THE CURRENT request (LocalizerSubscriber::onKernelRequest). As a static it outlives that request in any long-running process - FrankenPHP worker mode, a messenger consumer - and would claim "already resolved" for every request after the first. Cleared at the start of each main request by Base\Subscriber\RequestScopedStateSubscriber.

Localizer::localeHasChanged()

public function localeHasChanged()

Localizer::markAsChanged()

public function markAsChanged()

Localizer::__construct()

public function __construct(ParameterBagInterface $parameterBag, TranslatorInterface $translator, string $cacheDir, ?string $buildDir = null)

Localizer::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

Localizer::__toLocale()

public static function __toLocale(string $locale, ?string $separator = self::SEPARATOR): string

Localizer::__toLocaleLang()

public static function __toLocaleLang(string $locale): string

Localizer::__toLocaleCountry()

public static function __toLocaleCountry(string $locale): string

Localizer::getLocales()

public static function getLocales()

Localizer::compatibleLocale()

public function compatibleLocale(string $locale, string $preferredLocale, ?array $availableLocales = null): bool

Localizer::getLocale()

public function getLocale(?string $locale = null): string

Localizer::setLocale()

public function setLocale(string $locale, ?Request $request = null)
Throws

Exception

Localizer::setDefaultLocale()

public function setDefaultLocale(?string $defaultLocale)

Localizer::getDefaultLocale()

public static function getDefaultLocale(): ?string

Localizer::getFallbackLocales()

public static function getFallbackLocales(): array

Localizer::getAvailableLocales()

public static function getAvailableLocales(): array

Localizer::getDefaultLocaleLang()

public static function getDefaultLocaleLang(): ?string

Localizer::getFallbackLocaleLangs()

public static function getFallbackLocaleLangs(): array

Localizer::getAvailableLocaleLangs()

public static function getAvailableLocaleLangs(): array

Localizer::getDefaultLocaleCountry()

public static function getDefaultLocaleCountry(): ?string

Localizer::getFallbackLocaleCountries()

public static function getFallbackLocaleCountries(): array

Localizer::getAvailableLocaleCountries()

public static function getAvailableLocaleCountries(): array

Localizer::getLocaleLangName()

public function getLocaleLangName(?string $locale = null): ?string

Localizer::getLocaleLang()

public function getLocaleLang(?string $locale = null): string

Localizer::getLocaleCountryName()

public function getLocaleCountryName(?string $locale = null): string

Localizer::getLocaleCountry()

public function getLocaleCountry(?string $locale = null): string

Localizer::normalizeLocale()

public static function normalizeLocale(string|array $locale, string $separator = self::SEPARATOR): string|array

Localizer::getTimezone()

public function getTimezone(): string

Localizer::setTimezone()

public function setTimezone(string $timezone): self

Localizer::getDefaultTimezone()

public static function getDefaultTimezone(): string

Localizer::getAvailableTimezones()

public static function getAvailableTimezones(): array

Localizer::__toGMT()

public static function __toGMT(string $timezone): string

Localizer::__toTimezone()

public static function __toTimezone(string $countryCode)

Localizer::getCountry()

public function getCountry(): string

Localizer::getCountryName()

public function getCountryName(?string $countryCode, ?string $displayLocale = null): string

A country's name from its ISO 3166-1 code (alpha-2, "JP"; alpha-3, "JPN", is read too), in the current language or in $displayLocale ("fr", "fr-FR", "fr_FR"): JP is "Japon" on a French page. This is the |country_name filter; a locale ("fr-BE") is not a country, the filter used to read one and named Japan "Belgique". An unknown code is returned as given, an empty one as "".

Localizer::setCountry()

public function setCountry(string $countryCode): self

Localizer::__toSymbol()

public static function __toSymbol(string $currency)

Localizer::getCurrency()

public function getCurrency(): string

Localizer::setCurrency()

public function setCurrency(string $currency): self

LocalizerInterface interface

interface LocalizerInterface LocalizerInterface.php:5

LocalizerInterface::__toLocale()

public static function __toLocale(string $locale, ?string $separator = Localizer::SEPARATOR): string

LocalizerInterface::__toLocaleLang()

public static function __toLocaleLang(string $locale): string

LocalizerInterface::__toLocaleCountry()

public static function __toLocaleCountry(string $locale): string

LocalizerInterface::normalizeLocale()

public static function normalizeLocale(string|array $locale, string $separator = Localizer::SEPARATOR): string|array

LocalizerInterface::getDefaultLocale()

public static function getDefaultLocale(): ?string

LocalizerInterface::getDefaultLocaleLang()

public static function getDefaultLocaleLang(): ?string

LocalizerInterface::getDefaultLocaleCountry()

public static function getDefaultLocaleCountry(): ?string

LocalizerInterface::getFallbackLocales()

public static function getFallbackLocales(): array

LocalizerInterface::getFallbackLocaleLangs()

public static function getFallbackLocaleLangs(): array

LocalizerInterface::getFallbackLocaleCountries()

public static function getFallbackLocaleCountries(): array

LocalizerInterface::getAvailableLocaleLangs()

public static function getAvailableLocaleLangs(): array

LocalizerInterface::getAvailableLocaleCountries()

public static function getAvailableLocaleCountries(): array

LocalizerInterface::getAvailableLocales()

public static function getAvailableLocales(): array

LocalizerInterface::markAsLate()

public static function markAsLate()

LocalizerInterface::markAsChanged()

public function markAsChanged()

LocalizerInterface::setCountry()

public function setCountry(string $countryCode): self

LocalizerInterface::setTimezone()

public function setTimezone(string $timezone): self

LocalizerInterface::getLocale()

public function getLocale(?string $locale = null): string

LocalizerInterface::setLocale()

public function setLocale(string $locale)

LocalizerInterface::compatibleLocale()

public function compatibleLocale(string $locale, string $preferredLocale, ?array $availableLocales = null): bool

LocalizerInterface::getLocaleLang()

public function getLocaleLang(?string $locale = null): string

LocalizerInterface::getLocaleLangName()

public function getLocaleLangName(?string $locale = null): ?string

LocalizerInterface::getLocaleCountry()

public function getLocaleCountry(?string $locale = null): string

LocalizerInterface::getLocaleCountryName()

public function getLocaleCountryName(?string $locale = null): string

LocalizerInterface::getCountryName()

public function getCountryName(?string $countryCode, ?string $displayLocale = null): string

LocalizerInterface::getDefaultTimezone()

public static function getDefaultTimezone(): string

LocalizerInterface::getAvailableTimezones()

public static function getAvailableTimezones(): array

LocalizerInterface::getTimezone()

public function getTimezone(): string

MaintenanceProvider class

class MaintenanceProvider implements MaintenanceProviderInterface MaintenanceProvider.php:11

MaintenanceProvider::__construct()

public function __construct(AdvancedRouterInterface $router, SettingBagInterface $settingBag, AuthorizationCheckerInterface $authorizationChecker, ParameterBagInterface $parameterBag, LocalizerInterface $localizer, TokenStorageInterface $tokenStorage)

MaintenanceProvider::getRemainingTime()

public function getRemainingTime(): int

MaintenanceProvider::getPercentage()

public function getPercentage(): int

MaintenanceProvider::getDowntime()

public function getDowntime(): int

MaintenanceProvider::getUptime()

public function getUptime(): int

MaintenanceProvider::isUnderMaintenance()

public function isUnderMaintenance(): bool

MaintenanceProvider::redirectOnDeny()

public function redirectOnDeny(?RequestEvent $event = null): bool

MaintenanceProviderInterface interface

interface MaintenanceProviderInterface MaintenanceProviderInterface.php:7

MaintenanceProviderInterface::getRemainingTime()

public function getRemainingTime(): int

MaintenanceProviderInterface::getPercentage()

public function getPercentage(): int

MaintenanceProviderInterface::getDowntime()

public function getDowntime(): int

MaintenanceProviderInterface::getUptime()

public function getUptime(): int

MaintenanceProviderInterface::isUnderMaintenance()

public function isUnderMaintenance(): bool

MaintenanceProviderInterface::redirectOnDeny()

public function redirectOnDeny(?RequestEvent $event = null): bool

MediaService class

class MediaService extends FileService implements MediaServiceInterface MediaService.php:33

MediaService::__construct()

public function __construct(Environment $twig, AdvancedRouterInterface $router, ObfuscatorInterface $obfuscator, FlysystemInterface $flysystem, ParameterBagInterface $parameterBag, ImagineInterface $imagineBitmap, ImagineInterface $imagineSvg, ?Profiler $profiler, ?LoggerInterface $logger = null)

MediaService::setController()

public function setController(MediaController $mediaController)

MediaService::getMaximumQuality()

public function getMaximumQuality()

MediaService::isWebpEnabled()

public function isWebpEnabled()

MediaService::audio()

public function audio(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::video()

public function video(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::soundify()

public function soundify(null|array|string $path, array $attributes = []): ?string

MediaService::vidify()

public function vidify(null|array|string $path, array $attributes = []): ?string

MediaService::image()

public function image(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::imageBase64()

public function imageBase64(null|array|string $path): null|array|string

MediaService::imageSet()

public function imageSet(null|array|string $path, ...$srcset): null|array|string

MediaService::imagify()

public function imagify(null|array|string $path, array $attributes = [], ...$srcset): null|array|string

MediaService::crop()

public function crop(array|string|null $path, int $x = 0, int $y = 0, ?int $width = null, ?int $height = null, string $position = "leftop", array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::thumbnailInset()

public function thumbnailInset(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::thumbnailOutbound()

public function thumbnailOutbound(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::thumbnailNoclone()

public function thumbnailNoclone(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::thumbnailUpscale()

public function thumbnailUpscale(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::thumbnail()

public function thumbnail(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaService::obfuscate()

public function obfuscate(string|null $path, array $config = [], FilterInterface|array $filters = []): ?string

MediaService::lightbox()

public function lightbox(null|array|string $path, array $attributes = [], null|array|string $lightboxId = null, null|array|string $lightboxTitle = null, array $lightboxAttributes = [], ...$srcset): null|array|string

MediaService::generate()

public function generate(string $proxyRoute, array $proxyRouteParameters = [], ?string $path = null, array $config = []): ?string

MediaService::resolve()

public function resolve(string $data, FilterInterface|array $filters = []): array

MediaService::serve()

public function serve(?string $file, int $status = 200, array $headers = []): ?Response

MediaService::isCached()

public function isCached(?string $path, array $config = [], FilterInterface|array $filters = []): bool

MediaService::filter()

public function filter(?string $path, array $config = [], FilterInterface|array $filters = []): ?string

MediaService::getNoImage()

public function getNoImage(null|string|FormatFilterInterface $extensionOrFormatter = null)
Throws

Exception

MediaServiceInterface interface

interface MediaServiceInterface extends FileServiceInterface MediaServiceInterface.php:9

MediaServiceInterface::isCached()

public function isCached(?string $path, array $config = [], FilterInterface|array $filters = []): bool

MediaServiceInterface::resolve()

public function resolve(string $data): array

MediaServiceInterface::image()

public function image(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaServiceInterface::filter()

public function filter(?string $path, array $config = [], FilterInterface|array $filters = []): ?string

MediaServiceInterface::thumbnail()

public function thumbnail(array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaServiceInterface::audio()

public function audio(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaServiceInterface::video()

public function video(array|string|null $path, array $config = [], FilterInterface|array $filters = []): array|string|null

MediaServiceInterface::setController()

public function setController(MediaController $mediaController)

Obfuscator class

class Obfuscator extends AbstractLocalCache implements ObfuscatorInterface Obfuscator.php:13

Obfuscator::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

Obfuscator::__construct()

public function __construct(ParameterBagInterface $parameterBag, string $cacheDir, ?string $buildDir = null)

Obfuscator::addCompression()

public function addCompression(CompressionInterface $compression): self

Obfuscator::removeCompression()

public function removeCompression(CompressionInterface $compression): self

Obfuscator::getCompressions()

public function getCompressions(): array

Obfuscator::getCompression()

public function getCompression(string $idOrClass): ?CompressionInterface

Obfuscator::getUuid()

public function getUuid(string $name): ?UuidV5

Obfuscator::encode()

public function encode(array $value, bool $short = Obfuscator::NO_SHORT): string

Obfuscator::decode()

public function decode(string $hash, bool $short = Obfuscator::NO_SHORT): ?array

ObfuscatorInterface interface

interface ObfuscatorInterface ObfuscatorInterface.php:5

const NO_SHORT = false
const USE_SHORT = true

ObfuscatorInterface::encode()

public function encode(array $value, bool $short = Obfuscator::NO_SHORT): string

ObfuscatorInterface::decode()

public function decode(string $hash, bool $short = Obfuscator::NO_SHORT): ?array

OpeningHours class

class OpeningHours implements ResetInterface OpeningHours.php:28

When the place is open - one service for the footer, a banner, the time slots a customer may wish for, the day an order is for and the page's JSON-LD.

The usual week is the one saved (Base\Entity\Hours\WeekDayHours), else the one configured (base.opening_hours.week); special days (Base\Entity\Hours\SpecialDay) close a date or open it at other hours. Generalised from Nakaya's App\Service\OpeningHours.

A site with several places asks for one of them: for('store:12'), or for($store), is the same service for that place - its own week (Base\Entity\Hours\ScopedWeek) when it has one, else the site's; its own special days, which win over the site's on the same date. The service itself stays the whole site's.

OpeningHours::__construct()

public function __construct(protected readonly ?SpecialDayRepository $specialDays = null, protected readonly ?WeekDayHoursRepository $weekDays = null, string $timezone = 'Europe/Paris', protected readonly array $defaultWeek = [], protected readonly ?string $cutoff = null, protected readonly ?ScopedWeekRepository $scopedWeeks = null)
$defaultWeek

ISO day => hours, until a week is saved

OpeningHours::for()

public function for(string|object|null $scope): static

The same service for one place: a scope key ("store:12") or an entity (scopeOf()). Null or '': the whole site. A new instance each time - the shared service is never scoped.

OpeningHours::scope()

public function scope(): ?string

The place this instance answers for; null: the whole site.

OpeningHours::scopeOf()

public static function scopeOf(object $place): string

An entity as a scope key: its class and its id ("App\Entity\Store:12").

OpeningHours::reset()

public function reset(): void

A worker serves many requests: each reads the hours again.

OpeningHours::timezone()

public function timezone(): \DateTimeZone

OpeningHours::week()

public function week(): array
Returns

the usual week, all seven days, ISO day => hours

OpeningHours::withWeek()

public function withWeek(array $week): static
$week
  • for tests, or after a change in this request

OpeningHours::withSpecialDays()

public function withSpecialDays(array $days): static
$days
  • for tests, or after a change in this request

OpeningHours::specialDays()

public function specialDays(): array
Returns

the special days still to come (or running today): for a place, its own first (they win on a shared date), then the site's

OpeningHours::specialOn()

public function specialOn(\DateTimeInterface $day): ?SpecialDay

OpeningHours::hoursOn()

public function hoursOn(\DateTimeInterface $day): array
Returns

the day's opening hours, special days included

OpeningHours::notices()

public function notices(?\DateTimeInterface $at = null, int $days = 14, int $limit = 3): array

The special days visitors should hear about: running today, or starting within $days.

OpeningHours::schema()

public function schema(): array

schema.org's openingHoursSpecification and specialOpeningHoursSpecification, to merge into the page's LocalBusiness JSON-LD: Google Search reads the special days from there.

OpeningHours::summary()

public function summary(): array

The footer's lines: the open days, those in a row with the same hours together ("Wednesday to Friday", "Saturday", "Sunday").

Returns

ISO days

OpeningHours::isOpenDay()

public function isOpenDay(\DateTimeInterface $day): bool

OpeningHours::isOpenAt()

public function isOpenAt(?\DateTimeInterface $at = null): bool

OpeningHours::nextOpenDay()

public function nextOpenDay(\DateTimeInterface $day): ?\DateTimeImmutable

The next day the place opens, $day itself when it does. Null: closed for a year.

OpeningHours::orderDay()

public function orderDay(?\DateTimeInterface $at = null): \DateTimeImmutable

The day an order (a reservation, a pick-up) made now is for: today until the cut-off (base.opening_hours.cutoff; without one, until the day's last closing), then the next day the place opens.

OpeningHours::slots()

public function slots(\DateTimeInterface $day, ?\DateTimeInterface $at = null, int $step = 30, int $notice = 30): array

Windows of $step minutes a customer may wish for on $day ("12:00-12:30"), inside the opening hours and not before $at plus $notice minutes.

Paginator class

class Paginator implements PaginatorInterface Paginator.php:10

Paginator::__construct()

public function __construct(RouterInterface $router, ParameterBagInterface $parameterBag)

Paginator::paginate()

public function paginate(array|Query $query, int $page = 1, int $pageSize = 0, int $pageRange = 0): ?Pagination

PaginatorInterface interface

interface PaginatorInterface PaginatorInterface.php:7

PaginatorInterface::paginate()

public function paginate(Query $query, int $page = 0, int $pageSize = 0, int $pageRange = 0)

ParameterBag class

class ParameterBag extends ContainerBag implements ParameterBagInterface ParameterBag.php:14

The Symfony adapter of omnibase's Base\Service\ParameterBagInterface: the container's parameters (it decorates parameter_bag), read by a dotted path, and DependencyInjection's ParameterBagInterface as well (through ContainerBag) for the code that types that one.

ParameterBag::normalizeAll()

public function normalizeAll(): array

ParameterBag::get()

public function get(string $path = "", ?array $bag = null): array|bool|string|int|float|null

ParameterBag::set()

public function set(string $path, $value, ?array &$bag = null): void

ParameterBag::has()

public function has(string $path, ?array $bag = null): bool

ParameterBagInterface interface

interface ParameterBagInterface ParameterBagInterface.php:21

The parameters of the application, read by a dotted path ("base.uploader.storage"), as omnibase's code asks for them: the core's contract, with no class of the framework (plan "omnibase agnostique", step C3c).

Under Symfony it is the container's parameters: Base\Service\ParameterBag (and HotParameterBag, with the settings stored in the database) is the adapter - it extends DependencyInjection's ContainerBag, decorates parameter_bag and so is DependencyInjection's ParameterBagInterface as well, its other methods (resolveValue(), add()...) there for the code that types that one. This interface no longer extends it: a class that reads the parameters through omnibase's contract (AbstractAttribute, AttributeReader) loads nothing of the framework.

ParameterBagInterface::get()

public function get(string $key = "", ?array $bag = null): array|bool|string|int|float|UnitEnum|null

ParameterBagInterface::set()

public function set(string $path, array|bool|string|int|float|UnitEnum|null $value, ?array &$bag = null): void

ParameterBagInterface::has()

public function has(string $path, ?array $bag = null): bool

ParameterBagInterface::all()

public function all(): array

Every parameter, by its full name.

Redirections class

class Redirections Redirections.php:17

Where an address that is not found leads now (Base\Entity\Layout\Redirection).

$redirections->responseFor($request); // a RedirectResponse, or null: really not found $redirections->add('/produit/enseigne-lumineuse/', '/savoir-faire/enseigne');

Redirections::__construct()

public function __construct(protected readonly RedirectionRepository $repository, protected readonly ?LoggerInterface $logger = null)

Redirections::responseFor()

public function responseFor(Request $request): ?RedirectResponse

Redirections::add()

public function add(string $source, string $target, int $status = Redirection::PERMANENT, bool $flush = true): Redirection

Adds a redirection, or changes the one already written for that source.

Referrer class

class Referrer implements ReferrerInterface Referrer.php:11

Referrer::__toString()

public function __toString(): string

Referrer::__construct()

public function __construct(RequestStack $requestStack, AdvancedRouterInterface $router)

Referrer::redirect()

public function redirect(array $headers = []): RedirectResponse

Referrer::isVetoed()

public function isVetoed(?string $routeName)

Referrer::clear()

public function clear()

Referrer::setUrl()

public function setUrl(?string $url)

Referrer::sameSite()

public function sameSite(): bool

Referrer::getUrl()

public function getUrl(): ?string

ReferrerInterface interface

interface ReferrerInterface ReferrerInterface.php:5

ReferrerInterface::getUrl()

public function getUrl(): ?string

ReferrerInterface::setUrl()

public function setUrl(?string $url)

ReferrerInterface::clear()

public function clear()

ReferrerInterface::sameSite()

public function sameSite(): bool

SecurityPolicy class

class SecurityPolicy SecurityPolicy.php:43

The site-wide account-security policy an administrator sets, and the single place that decides what a *user* is then allowed to change about their own account.

The rule the whole class exists to express: the administrator wins. A user may switch two-factor authentication on whenever the feature is available, but may only switch it back off while the administrator has not made it mandatory. Every "can the user do X" question below is asked from the settings page and from the controller that performs X, so a hidden button and a hand-crafted POST are refused by the same predicate.

Defaults matter here. A setting the administrator has never saved has no row at all, and SettingBag::getScalar() returns null for it - which filter_var() reads as false. Defaulting everything to false would silently switch passkeys and TOTP off for every existing account the moment this class shipped, so each flag below carries its own explicit default and only a real stored value overrides it.

Besides "everyone or no one" (the administrator's setting), the application may require a second factor of some roles only (base.security.two_factor.required_roles: [ROLE_STAFF]): whoever holds one of them, directly or through the role hierarchy, is asked to enrol and cannot switch the factor back off; everyone else stays free to choose. Hence the optional $user of the questions below: without one they answer for the whole site, with one for that account.

In the demo environment a demonstration account (Base\Demo) is shared by every visitor: nothing is required of it - not the second factor of its role, not the administrator's "mandatory" - and it may change none of its credentials (isDemoAccount(), canChangeCredentials()).

const TWO_FACTOR = 'base.settings.security.two_factor'
const TWO_FACTOR_MANDATORY = 'base.settings.security.two_factor.mandatory'
const PASSKEYS = 'base.settings.security.passkeys'
const NEW_DEVICE_EMAIL = 'base.settings.security.new_device_email'
const NEW_DEVICE_PROMPT = 'base.settings.security.new_device_prompt'
const SESSION_NEW_DEVICE_PROMPT = 'security_new_device_prompt'

Session key set by a sign-in from a browser this account has never used, on an account with no second factor: the next page shows, once, the optional offer to set up a one-time code. Cleared when answered.

Cookie remembering that the offer above was declined - it is never repeated.

const SESSION_ENROLMENT_SKIPPED = 'security_2fa_enrolment_skipped'

Session key holding a "not now" answer to the enrolment prompt.

SecurityPolicy::__construct()

public function __construct(SettingBagInterface $settingBag, ?RoleHierarchyInterface $roleHierarchy = null, array $requiredRoles = [], bool $postpone = true, ?DemoMode $demoMode = null, ?DemoAccountRegistry $demoAccounts = null)
$requiredRoles

roles whose holders must have a second factor (base.security.two_factor.required_roles)

$postpone

whether the enrolment prompt offers a "not now" (base.security.two_factor.postpone)

SecurityPolicy::isDemoAccount()

public function isDemoAccount(?UserInterface $user): bool

Is this one of the declared demonstration accounts, in the demo environment? Never true anywhere else: in dev and test the same accounts are ordinary ones.

SecurityPolicy::canChangeCredentials()

public function canChangeCredentials(?UserInterface $user): bool

May this account change its password, its address, its second factor, or close itself? Not a demonstration account: every visitor signs in with it, and whoever changed one of these would lock the next out.

SecurityPolicy::isTwoFactorAvailable()

public function isTwoFactorAvailable(): bool

Is two-factor authentication offered to users at all?

SecurityPolicy::isTwoFactorMandatory()

public function isTwoFactorMandatory(?UserInterface $user = null): bool

Must every user hold a second factor - or, given an account, must this one?

Mandatory only means anything while the feature is available in the first place - an administrator who turns two-factor off entirely and leaves this checkbox ticked has not thereby locked everyone out.

SecurityPolicy::getRequiredRoles()

public function getRequiredRoles(): array
Returns

the roles whose holders must have a second factor

SecurityPolicy::isTwoFactorRequiredByRole()

public function isTwoFactorRequiredByRole(?UserInterface $user): bool

Does this account hold one of the roles a second factor is required of (base.security.two_factor.required_roles), directly or through the role hierarchy? Asked of the account itself, not of the current token: the settings page and the enrolment prompt may be asked about any user.

SecurityPolicy::arePasskeysAvailable()

public function arePasskeysAvailable(): bool

Are passkeys offered as a login method?

SecurityPolicy::isNewDeviceEmailEnabled()

public function isNewDeviceEmailEnabled(): bool

Should signing in from an unrecognised browser send a confirmation email?

SecurityPolicy::hasSecondFactor()

public function hasSecondFactor(?UserInterface $user): bool

Does this account already hold a second factor?

A passkey deliberately does not count. It replaces the password rather than adding to it, so an account whose only protection is a passkey has one factor, not two, and a site that mandates two-factor should still ask for the second one.

SecurityPolicy::canDisableTwoFactor()

public function canDisableTwoFactor(?UserInterface $user = null): bool

May this user turn their second factor off again?

This is the precedence rule in one line: no, while the administrator requires one.

SecurityPolicy::canEnableTwoFactor()

public function canEnableTwoFactor(?UserInterface $user = null): bool

May this user still enrol - i.e. is the feature switched on for them? (Never a demonstration account.)

SecurityPolicy::isNewDevicePromptEnabled()

public function isNewDevicePromptEnabled(): bool

Should the first sign-in from an unknown browser offer, once, to set up a one-time code? Only meaningful while two-factor is available and not already mandatory (then the enrolment prompt does the asking).

OFF unless an administrator turns it on. It interrupts a sign-in the person did not ask to have interrupted, which is friction a public site should choose deliberately rather than inherit from a default.

SecurityPolicy::needsEnrolment()

public function needsEnrolment(?UserInterface $user): bool

Should this user be asked to enrol before carrying on?

True only while the site requires a second factor and this account has none. Whether the user is then allowed to postpone the answer is decided by the caller, not here - see canPostponeEnrolment().

SecurityPolicy::canSkipEnrolment()

public function canSkipEnrolment(?UserInterface $user = null): bool

Does the enrolment prompt offer this account a "not now"?

Yes by default: the skip exists so that a policy change strands nobody mid-task, and it only lasts the session. An application that wants no "later" for the accounts a second factor is required of (staff reading patients' files) sets base.security.two_factor.postpone: false - the prompt then comes back on every page until the account has one.

SecurityPolicy::canPostponeEnrolmentPermanently()

public function canPostponeEnrolmentPermanently(?UserInterface $user = null): bool

May a "not now" be remembered for good?

No, while enrolment is mandatory: the prompt offers a skip so nobody is trapped mid-task, but that answer lives in the session and the prompt comes back on the next sign-in. When two-factor is merely offered, a dismissal can be kept for good.

SettingBag class

class SettingBag implements SettingBagInterface, CacheWarmerInterface SettingBag.php:19

SettingBag::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

Compile the snapshot fresh (bypassing any cached copy) and persist it, so the very first request after a deploy/cache:clear hits a warm cache instead of compiling on-demand.

SettingBag::isOptional()

public function isOptional(): bool

The snapshot compiles on-demand on a cache miss regardless (see loadSnapshot()), so this warmer is safe to skip under --no-optional-warmers.

SettingBag::__construct()

public function __construct(ParameterBagInterface $parameterBag, EntityManagerInterface $entityManager, SettingRepository $settingRepository, LocalizerInterface $localizer, CacheInterface $cache, string $environment)

SettingBag::invalidate()

public function invalidate(): void

Drop the in-memory and persisted snapshot. The next read recompiles it from the database in one pass. Called by SettingBag::set() and by SettingSubscriber on any Setting/SettingIntl write (including ones that bypass SettingBag entirely, e.g. the admin CRUD's plain flush()).

SettingBag::getBagParameters()

public function getBagParameters(): array

Flat [bagParameterName => resolvedDefaultLocaleValue] map, read straight off the compiled snapshot — no query, no entity hydration. Replaces HotParameterBagSubscriber's former allRaw(true, true) + recursive walk, which re-ran on every request/console command for what is typically a handful of bag-linked settings.

SettingBag::all()

public function all(?string $locale = null): array

SettingBag::allRaw()

public function allRaw($useCache = true, $onlyLinkedBag = false): array
Throws

Psr\Cache\InvalidArgumentException

SettingBag::__call()

public function __call($name, $_)
Throws

Exception

SettingBag::getEnvironment()

public function getEnvironment(): ?string

SettingBag::getPaths()

public function getPaths(null|string|array $path = null)
Throws

Psr\Cache\InvalidArgumentException

SettingBag::normalize()

public function normalize(?string $path, array $settings)
Throws

Exception

SettingBag::denormalize()

public function denormalize(array $settings, ?string $path = null)
Throws

Exception

SettingBag::getRaw()

public function getRaw(null|string|array $path = null, bool $useCache = true, bool $onlyLinkedBag = false)
Throws

Psr\Cache\InvalidArgumentException

SettingBag::generateRaw()

public function generateRaw(string $path, ?string $locale = null, bool $useCache = false): Setting

SettingBag::getRawScalar()

public function getRawScalar(null|string|array $path = null, bool $useCache = true)

SettingBag::getScalar()

public function getScalar(null|string|array $path, ?string $locale = null): mixed

SettingBag::get()

public function get(null|string|array $path = null, ?string $locale = null, ?bool $useCache = true): array

SettingBag::clearAll()

public function clearAll()

SettingBag::clear()

public function clear(null|string|array $path, ?string $locale = null, $useCache = true)

Invalidates the whole compiled snapshot. $path/$locale are accepted for backward compatibility with call sites that used to target a specific cache key, but a single small snapshot is cheap enough to recompile wholesale — there is no meaningful partial-invalidate left to do.

SettingBag::set()

public function set(string $path, $value, ?string $locale = null, $useCache = true)
Throws

Psr\Cache\InvalidArgumentException

SettingBag::setLabel()

public function setLabel(string $path, ?string $label = null, ?string $locale = null)
Throws

Exception

SettingBag::setHelp()

public function setHelp(string $path, ?string $help = null, ?string $locale = null)
Throws

Exception

SettingBag::setBag()

public function setBag(string $path, ?string $parameterName = null)

SettingBag::has()

public function has(string $path, ?string $locale = null)
Throws

Exception

SettingBag::remove()

public function remove(string $path)

SettingBag::lock()

public function lock(string $path)

SettingBag::unlock()

public function unlock(string $path)

SettingBag::setLock()

public function setLock(string $path, bool $flag = true)

SettingBag::secure()

public function secure(string $path)

SettingBag::unsecure()

public function unsecure(string $path)

SettingBag::setSecure()

public function setSecure(string $path, bool $flag = true)

SettingBagInterface interface

interface SettingBagInterface SettingBagInterface.php:5

SettingBagInterface::clearAll()

public function clearAll()

SettingBagInterface::all()

public function all(?string $locale = null): array

SettingBagInterface::get()

public function get(null|string|array $path = null, ?string $locale = null): array

SettingBagInterface::getScalar()

public function getScalar(null|string|array $path, ?string $locale = null): mixed

SettingBagInterface::getBagParameters()

public function getBagParameters(): array

Flat [bagParameterName => resolvedDefaultLocaleValue] map for every bag-linked setting, used by HotParameterBagSubscriber to seed the HotParameterBag without querying/hydrating entities on every request.

SettingBagInterface::set()

public function set(string $path, $value, ?string $locale = null)

SettingSnapshotValue class

final class SettingSnapshotValue SettingSnapshotValue.php:12

Opaque per-locale value holder used inside a compiled SettingBag snapshot tree, standing in for the live Setting entity that same tree position holds in SettingBag::normalize()'s entity-tree shape. Kept as an object (not a plain array) so array_map_recursive() treats it as a leaf and does not recurse into the per-locale map itself.

public readonly array $values

locale => RAW translated Setting value (SettingIntl::getValueRaw() — Uploader public-URL resolution is deliberately NOT applied here; it happens at read time in SettingBag::get() so the snapshot stays media-storage-independent)

SettingSnapshotValue::__construct()

public function __construct(public readonly array $values)
$values

locale => RAW translated Setting value (SettingIntl::getValueRaw() — Uploader public-URL resolution is deliberately NOT applied here; it happens at read time in SettingBag::get() so the snapshot stays media-storage-independent)

Sharing class

class Sharing Sharing.php:9

Sharing::getAdapters()

public function getAdapters()

Sharing::getAdapter()

public function getAdapter(string $idOrClass): ?SharingAdapterInterface

Sharing::addAdapter()

public function addAdapter(SharingAdapterInterface $adapter): self

Sharing::removeAdapter()

public function removeAdapter(SharingAdapterInterface $adapter): self

Sharing::generate()

public function generate(string $adapterId, LinkableInterface|string $url, array $options = [], ?string $template = null)

SharingInterface interface

interface SharingInterface SharingInterface.php:7

SharingInterface::generate()

public function generate(string $adapterId, LinkableInterface|string $url, array $options = [], ?string $template = null)

Signatures class

class Signatures Signatures.php:44

Documents signed through glitchr/omnisign, for any entity of the application: an envelope sent (send()), signed by e-mail or in the site's page (signingUrl()), followed (refresh(), or the provider's webhook: notify()), and once completed its signed document and evidence kept in the private storage (base.signatures.storage: the uploads', out of public/). Each move is a SignatureEvent; the application answers on what the envelope is about.

$envelope = $signatures->send($quote, new Omnisign\Model\Envelope('Devis D-42', [$document], [$client], $fields, embedded: true)); return $this->redirect($signatures->signingUrl($envelope, 'client', $returnUrl)); ... $signatures->refresh($envelope); // on the way back; the webhook does it too $signatures->signed($envelope); // the signed PDF, once completed

Registered only when glitchr/omnisign is installed (its bundle gives the gateways: omnisign.gateways.<name>); the entity is mapped only then too.

Signatures::__construct()

public function __construct(readonly EntityManagerInterface $entityManager, readonly FlysystemInterface $flysystem, readonly ?Registry $registry = null, readonly ?EventDispatcherInterface $dispatcher = null, readonly ?LoggerInterface $logger = null, readonly ?string $gateway = null, readonly ?string $storage = null, readonly ?string $uploads = null)

Signatures::gateway()

public function gateway(?string $name = null): ?string

The gateway envelopes go through by default: base.signatures.gateway, or the only one configured.

Signatures::isEnabled()

public function isEnabled(?string $name = null): bool

Signatures::send()

public function send(object $subject, Request $request, ?string $gateway = null): Envelope

Sent to be signed, about $subject: created on the gateway and sent - by the provider's e-mail, or kept for the site's page (embedded) - and kept as an Envelope.

Signatures::signingUrl()

public function signingUrl(Envelope $envelope, string $signer, ?string $returnUrl = null): string

Where $signer signs in the site's page; asked again each time (the providers' links expire).

Signatures::refresh()

public function refresh(Envelope $envelope): Envelope

Asks the provider where it stands; kept, its events dispatched, its files kept once completed.

Signatures::remind()

public function remind(Envelope $envelope, ?string $signer = null): void

Signatures::cancel()

public function cancel(Envelope $envelope, ?string $reason = null): Envelope

Signatures::notify()

public function notify(string $gateway, string $body, array $headers): Envelope|false|null

A provider's callback: its signature checked by the gateway, the envelope it names asked again and kept.

Returns

the envelope updated; null when it names none of the site's; false when its signature does not hold

Signatures::of()

public function of(object $subject): array
Returns

the envelopes about $subject, newest first

Signatures::signed()

public function signed(Envelope $envelope): ?string

The signed document, once completed and kept; null before.

Signatures::evidence()

public function evidence(Envelope $envelope): ?string

The evidence of its signing (an audit trail, a certificate), once kept.

Signatures::subject()

public function subject(Envelope $envelope): ?object

The entity the envelope is about, when it still exists.

Sitemapper class

class Sitemapper implements SitemapperInterface Sitemapper.php:16

Sitemapper::__construct()

public function __construct(Environment $twig, AttributeReader $attributeReader, AdvancedRouterInterface $router, LocalizerInterface $localizer, ?LoggerInterface $logger = null)

Sitemapper::getSitemap()

public function getSitemap(Route $route): ?Sitemap

Sitemapper::getHostname()

public function getHostname(): string

Sitemapper::setHostname()

public function setHostname(string $hostname): self

Sitemapper::register()

public function register(string|Route $routeOrName, array $routeParameters = [], ?string $lastMod = null): self

One page into the sitemap: a route (its name, or the Route) and the parameters of the page.

Nothing here is fatal. A route that does not exist, an address that matches nothing, a route whose action carries no #[Sitemap]: the page is left out and the reason logged (warning, "sitemap" in the message). One listener registering a route nobody declared used to throw, and the whole /sitemap.xml - every other page of the site with it - answered 500.

Sitemapper::registerUrl()

public function registerUrl(string $url, ?string $lastMod = null): self

Sitemapper::registerAttributes()

public function registerAttributes(): self

Sitemapper::get()

public function get(SitemapEntry|string|null $sitemapOrRouteName = null): ?SitemapEntry

Sitemapper::getAlternates()

public function getAlternates(SitemapEntry|string|null $sitemapOrRouteName = null)

Sitemapper::serve()

public function serve(string $name, array $context = []): Response

SitemapperInterface interface

interface SitemapperInterface SitemapperInterface.php:8

SitemapperInterface::getHostname()

public function getHostname(): string

SitemapperInterface::setHostname()

public function setHostname(string $hostname): self

SitemapperInterface::register()

public function register(string|Route $routeOrName, array $routeParameters = [], ?string $lastMod = null): self

SitemapperInterface::registerUrl()

public function registerUrl(string $url, ?string $lastMod = null): self

SitemapperInterface::registerAttributes()

public function registerAttributes(): self

SitemapperInterface::serve()

public function serve(string $name, array $context = []): Response

SpamChecker class

class SpamChecker implements SpamCheckerInterface SpamChecker.php:38

Is what a visitor wrote spam? The classifier of glitchr/omnishield behind omnibase's SpamCheckerInterface (check, score), which the forms (spam_protection), the comments and omnibase/faq's questions ask:

  • base.guard.classifier, a gateway of omnishield.gateways;
  • else Akismet (omnishield/akismet), with the key typed in the back office (api.spam.akismet, admin's SpamKeySection) or configured (base.spam.akismet);
  • else nothing is asked: NOT_SPAM, as without a key before.

What is sent is built here from the request and the candidate: the visitor's address, browser and referrer, the page, the site's home page (not the current page), its language, the author's name and e-mail as text, the date. A provider that does not answer is base.guard.unreachable: accept (NOT_SPAM) or reject (MAYBE_SPAM, held for a person); a key refused is the site's error, let through and logged. Nothing is swallowed silently.

SpamChecker::__construct()

public function __construct(protected RequestStack $requestStack, protected SettingBagInterface $settingBag, protected ParameterBagInterface $parameterBag, protected TranslatorInterface $translator, protected HttpClientInterface $client, protected bool $debug, protected ?FormGuard $guard = null, protected ?AdvancedRouterInterface $router = null, protected ?LoggerInterface $logger = null)

SpamChecker::getLang()

public function getLang(): ?string

SpamChecker::getUrl()

public function getUrl(): ?string

The site's home page: what Akismet calls the blog - not the page the form is on.

SpamChecker::getKey()

public function getKey($api = SpamApi::AKISMET): ?string

$api: a classifier is named by base.guard.classifier now

The key: typed in the back office (api.spam.akismet), else configured (base.spam.akismet).

SpamChecker::classifier()

public function classifier(): ?ClassifierInterface

The classifier asked, or null when there is none.

SpamChecker::submission()

public function submission(SpamProtectionInterface $candidate, array $context = []): Submission

What the classifier is told of a candidate.

$context

what the caller knows better: comment_author, comment_author_email, comment_author_url, comment_type (Akismet's names), permalink

SpamChecker::check()

public function check(SpamProtectionInterface $candidate, array $context = [], $api = SpamApi::AKISMET): int

SpamChecker::score()

public function score(SpamProtectionInterface $candidate, array $context = [], $api = SpamApi::AKISMET): int
Returns

0: not spam, 1: maybe spam (held for a person), 2: blatant spam; -1: no text

SpamChecker::report()

public function report(Submission $submission, bool $spam): bool

Teach the classifier: a submission it let through that was spam ($spam true), one it held that was not. False when there is no classifier to tell; a provider's error is thrown.

SpamCheckerInterface interface

interface SpamCheckerInterface SpamCheckerInterface.php:8

SpamCheckerInterface::check()

public function check(SpamProtectionInterface $candidate, array $context = [], $api = SpamApi::AKISMET): int

SpamCheckerInterface::score()

public function score(SpamProtectionInterface $candidate, array $context = [], $api = SpamApi::AKISMET): int

SpeculativeRequest class

final class SpeculativeRequest SpeculativeRequest.php:18

Tells a speculative request - one a client made ahead of any user action, hoping to have the answer ready - from a real one.

Browsers announce prefetches and prerenders through request headers: Sec-Purpose: prefetch (Fetch standard), Purpose: prefetch (Chrome, Safari, prefetching proxies), X-Moz: prefetch (Firefox) and X-Purpose: preview (Safari's Top Sites). Anything with a side effect - signing out, counting a view - must treat such a request as if the user had never asked for the page, because they have not.

SpeculativeRequest::is()

public static function is(Request $request): bool

SystemOfUnits class

class SystemOfUnits SystemOfUnits.php:5

SystemOfUnits::__construct()

public function __construct()

Themizer class

class Themizer extends AbstractLocalCache implements ThemizerInterface Themizer.php:8

Themizer::__construct()

public function __construct(ParameterBagInterface $parameterBag, TokenStorageInterface $tokenStorage, string $cacheDir, ?string $buildDir = null)

Themizer::getLayout()

public function getLayout($id = 0): string

Themizer::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

Themizer::detectLayouts()

public function detectLayouts()

Themizer::getAvailableModes()

public function getAvailableModes(): array

Themizer::color_scheme()

public function color_scheme(): string

Themizer::getMode()

public function getMode(): ?array

Themizer::getAvailableFilters()

public function getAvailableFilters(): array

Themizer::getFilter()

public function getFilter(): ?array

Themizer::getAudienceCategories()

public function getAudienceCategories(): array

Themizer::getAudience()

public function getAudience(): ?array

Themizer::getAvailableWidths()

public function getAvailableWidths(): array

Themizer::width()

public function width(): ?array

Themizer::getWidth()

public function getWidth(): ?array

Themizer::getAvailableEvents()

public function getAvailableEvents(): array

Returns the list of candidate themes (events) that are currently active.

Themizer::getEvent()

public function getEvent(): ?array

ThemizerInterface interface

interface ThemizerInterface ThemizerInterface.php:5

ThemizerInterface::getAvailableFilters()

public function getAvailableFilters(): array

ThemizerInterface::getFilter()

public function getFilter(): ?array

ThemizerInterface::getAvailableEvents()

public function getAvailableEvents(): array

ThemizerInterface::getEvent()

public function getEvent(): ?array

ThemizerInterface::getAvailableModes()

public function getAvailableModes(): array

ThemizerInterface::getMode()

public function getMode(): ?array

ThemizerInterface::color_scheme()

public function color_scheme(): string

ThemizerInterface::getAvailableWidths()

public function getAvailableWidths(): array

ThemizerInterface::getWidth()

public function getWidth(): ?array

ThemizerInterface::width()

public function width(): ?array

ThemizerInterface::getAudienceCategories()

public function getAudienceCategories(): array

ThemizerInterface::getAudience()

public function getAudience(): ?array

TimeMachine class

class TimeMachine extends BackupManager implements TimeMachineInterface TimeMachine.php:42

const DEFAULT_EXCLUDES = ["./vendor", "./node_modules", "./var/cache", "./var/log", "./var/coverage", "./var/phpunit", "./.git"]

Paths left out of the application tarball. Defaults to dependency and build output that composer install / yarn / a cache warmup rebuild from scratch - keeping them would multiply the snapshot size (and the free space it needs) for no restorable data.

TimeMachine::setCommandOutput()

public function setCommandOutput(OutputInterface $output)

TimeMachine::getCacheDir()

public function getCacheDir()

TimeMachine::getExcludes()

public function getExcludes(): array

TimeMachine::setExcludes()

public function setExcludes(array $excludes)

TimeMachine::getSnapshotDir()

public function getSnapshotDir(): ?string

TimeMachine::setSnapshotDir()

public function setSnapshotDir(?string $snapshotDir)

TimeMachine::assertEnoughFreeSpace()

public function assertEnoughFreeSpace(string $directory, array $excludes = [], float $factor = 2.2): void

Refuse to start a snapshot that cannot fit, instead of filling the disk up and taking the application down with it. The tarball and its compressed copy coexist while compressing, hence the multiplier.

TimeMachine::estimateArchiveSize()

public function estimateArchiveSize(string $directory, array $excludes = []): ?int

Apparent size of what would actually go into the tarball (excludes applied), or null when du is unavailable / fails.

TimeMachine::preventAbort()

public function preventAbort()

TimeMachine::__construct()

public function __construct(Flysystem $flysystem, Registry $doctrine, ParameterBagInterface $parameterBag)

TimeMachine::getMaxCycle()

public function getMaxCycle(): ?int

TimeMachine::setMaxCycle()

public function setMaxCycle(int $maxCycle)

TimeMachine::getTimeLimit()

public function getTimeLimit(): ?DateTime

TimeMachine::setTimeLimit()

public function setTimeLimit(null|string|DateTime|int $timeLimit)

TimeMachine::getCompression()

public function getCompression(): ?string

TimeMachine::setCompression()

public function setCompression(?string $compression)

TimeMachine::getDatabase()

public function getDatabase(string $name): Database

TimeMachine::getDatabaseConfiguration()

public function getDatabaseConfiguration(string $name): Database

TimeMachine::getDatabaseList()

public function getDatabaseList(): array

TimeMachine::getStorage()

public function getStorage(string $name): Filesystem

TimeMachine::getStorageList()

public function getStorageList(): array

TimeMachine::findOneBy()

public function findOneBy(int $id, int|array $storageNames, ?string $prefix = null, int $cycle = -1)

TimeMachine::findBy()

public function findBy(int|array $storageNames = [], ?string $prefix = null, $cycle = -1): array

TimeMachine::findByCycle()

public function findByCycle(int|array $storageNames = [], ?string $prefix = null, $cycle = -1): array

TimeMachine::getLastCycle()

public function getLastCycle(array $files, ?string $prefix = null): int

TimeMachine::backup()

public function backup(null|string|array $databases, int|array $storageNames = [], bool $userInfo = false, ?string $prefix = null, int $cycle = -1): bool
Throws

CompressorTypeNotSupported

Throws

ConfigFieldNotFound

Throws

ConfigNotFoundForConnection

Throws

DatabaseTypeNotSupported

Throws

FilesystemException

Throws

FilesystemTypeNotSupported

TimeMachine::restore()

public function restore(int $id, bool $restoreDatabase, bool $restoreApplication, int|array $storageNames = [], ?string $prefix = null, int $cycle = -1)
Throws

CompressorTypeNotSupported

Throws

ConfigFieldNotFound

Throws

ConfigNotFoundForConnection

Throws

DatabaseTypeNotSupported

Throws

FilesystemTypeNotSupported

Throws

FilesystemException

TimeMachine::openCompressedArchive()

public function openCompressedArchive(string $output): ?string

TimeMachine::openArchive()

public function openArchive(string $output, bool $compression = false): ?string

TimeMachine::buildCompressedArchive()

public function buildCompressedArchive(string $output, string $directory, array $excludes = [], bool $verbose = true): ?string

TimeMachine::extractUserInfo()

public function extractUserInfo(string $output): ?string

TimeMachine::buildArchive()

public function buildArchive(string $output, string $directory, array $excludes = [], bool $compression = false, bool $verbose = true): ?string

TimeMachineInterface interface

interface TimeMachineInterface TimeMachineInterface.php:5

TimeMachineInterface::findOneBy()

public function findOneBy(int $id, int|array $storageNames, ?string $prefix = null, int $cycle = -1)

TimeMachineInterface::findBy()

public function findBy(int|array $storageNames, ?string $prefix = null, int $cycle = -1)

TimeMachineInterface::findByCycle()

public function findByCycle(int|array $storageNames, ?string $prefix = null, int $cycle = -1)

TimeMachineInterface::backup()

public function backup(null|string|array $databases, int|array $storageNames = [], bool $userInfo = false, ?string $prefix = null, int $cycle = -1)

TimeMachineInterface::restore()

public function restore(int $id, bool $restoreDatabase, bool $restoreApplication, int|array $storageNames = [], ?string $prefix = null, int $cycle = -1)

TimelineEventProviderInterface interface

interface TimelineEventProviderInterface TimelineEventProviderInterface.php:18

A source of "worth marking on a timeline" events (a deploy, a campaign launch, ...), collected by base-bundle-admin's TimelineEventRegistry and rendered as annotations on the analytics dashboard chart. Lives here (not base-bundle-admin) for the same reason Analytics does: it's a domain concept, not an admin-UI-specific one - a future non-admin consumer (a public changelog widget, a CLI report) could reuse it without depending on the admin package.

No implementation ships with this interface - any bundle or app service can supply one by implementing it (self-registers automatically, see AdminBundle::build()'s registerForAutoconfiguration()).

TimelineEventProviderInterface::getTimelineEvents()

public function getTimelineEvents(\DateTimeImmutable $since, ?\DateTimeImmutable $until = null): array
$until

null = up to today

Returns

'date' is Y-m-d, same granularity as Analytics::dailyBreakdown()'s own rows. 'url', when present, is what turns this event into a clickable marker on the chart (see admin-charts.js's buildAnnotations()) instead of a plain dashed line - an event with somewhere real to send an admin (an article's own page, here) is worth making directly navigable, not just visible.

Trading class

class Trading implements TradingInterface Trading.php:20

Trading::__construct()

public function __construct(HttpClientInterface $httpClient, string $cacheDir, protected bool $live = true)
$live

whether a call that does not say otherwise ("use_swap") may ask the providers. On by default; an application on a provider's free plan (a hundred requests a month, which a visitor's page views would spend in a day) sets BASE_TRADING_LIVE=0: the stored rates, laid in as fallbacks, then answer, and whoever refreshes them (an administrator's action, a command) passes ['use_swap' => true].

Trading::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null)

Trading::getProviders()

public function getProviders()

The providers with a key, in the order Swap asks them: the highest getPriority() first, as for Symfony's tagged services - the order they were registered in only among equals. TradingPass adds them in the container's order, which puts an application's before the bundles': without this, a keyless fallback (a central bank's rates) would answer before the keyed providers typed in the admin.

Trading::getProvider()

public function getProvider(string $idOrClass): ?CurrencyApiInterface

Trading::getRenderedCurrency()

public function getRenderedCurrency(): ?string

Trading::setRenderedCurrency()

public function setRenderedCurrency(?string $renderedCurrency)

Trading::normalize()

public function normalize(string $source, string $target, mixed $value, null|string|int|DateTime $datetime): ?ExchangeRate

Trading::getFallback()

public function getFallback(string $source, ?string $target = null): ExchangeRate|array|null

Trading::addFallback()

public function addFallback(string $source, string $target, mixed $value, null|string|int|DateTime $date = "now"): self

Trading::removeFallback()

public function removeFallback(string $source, string $target): self

Trading::addProvider()

public function addProvider(CurrencyApiInterface $provider): self

Trading::removeProvider()

public function removeProvider(CurrencyApiInterface $provider): self

Trading::setCacheTTL()

public function setCacheTTL(int $ttl)

Trading::isLive()

public function isLive(): bool

Trading::setLive()

public function setLive(bool $live): static

Trading::getLatest()

public function getLatest(string $source, string $target, array $options = []): ?ExchangeRate

Trading::get()

public function get(string $from, string $to, array $options = [], string $timeAgo = "now"): ?ExchangeRate

Trading::convert()

public function convert(string|float $cash, string $source, string $target, array $options = [], string $timeAgo = "now"): ?float

Trading::convertLatest()

public function convertLatest(string|float $cash, string $source, string $target, array $options = []): ?float

Trading::convertFallback()

public function convertFallback(string|float $cash, string $source, string $target): ?float

TradingInterface interface

interface TradingInterface TradingInterface.php:8

TradingInterface::normalize()

public function normalize(string $source, string $target, mixed $value, null|string|int|DateTime $datetime): ?ExchangeRate

TradingInterface::get()

public function get(string $from, string $to, array $options = []): ?ExchangeRate

TradingInterface::getFallback()

public function getFallback(string $source, ?string $target = null): ExchangeRate|array|null

TradingInterface::getLatest()

public function getLatest(string $source, string $target, array $options = []): ?ExchangeRate

TradingInterface::isLive()

public function isLive(): bool

Whether get()/getLatest() ask the providers when the options do not say ("use_swap").

TradingInterface::setLive()

public function setLive(bool $live): static

TradingInterface::convert()

public function convert(string|float $cash, string $source, string $target, array $options = [], string $timeAgo = "now"): ?float

TradingInterface::convertLatest()

public function convertLatest(string|float $cash, string $source, string $target, array $options = []): ?float

TradingInterface::convertFallback()

public function convertFallback(string|float $cash, string $source, string $target): ?float

TradingInterface::getRenderedCurrency()

public function getRenderedCurrency(): ?string

TradingInterface::setRenderedCurrency()

public function setRenderedCurrency(?string $renderedCurrency)

TradingInterface::addFallback()

public function addFallback(string $source, string $target, mixed $value, null|string|int|DateTime $date): self

TradingInterface::removeFallback()

public function removeFallback(string $source, string $target): self

Translator class

class Translator implements TranslatorInterface Translator.php:12

const PARSE_EXTENDS = "extends"
const PARSE_NAMESPACE = "namespace"
const DOMAIN_DEFAULT = "messages"
const DOMAIN_BACKEND = "admin"
const DOMAIN_ENTITY = "entities"
const DOMAIN_ENUM = "enums"
const STRUCTURE_DOT = "^@?[a-zA-Z0-9_]+(?:-[a-zA-Z0-9_]+)*(?:[.][a-zA-Z0-9_]+(?:-[a-zA-Z0-9_]+)*)+\$"
const STRUCTURE_DOTBRACKET = "\\{[ ]*[@a-zA-Z0-9_.]+[.]{0,1}[a-zA-Z0-9_]+[ ]*\\}"
const STRUCTURE_BRACKETLIST = ['{}', "[]", "%%"]
const TRANSLATION_PROPERTIES = "_properties"
const TRANSLATION_GENDERNESS = "genderness"
const GENDERNESS_INCLUSIVE = "_inclusive"
const GENDERNESS_FEMININE = "_feminine"
const GENDERNESS_MASCULINE = "_masculine"
const GENDERNESS_NEUTRAL = "_neutral"
const TRANSLATION_POLITENESS = "politeness"

How somebody is addressed: familiar (tu, du, 常体), polite (vous, Sie, 丁寧語), formal (敬語). A text has one wording in the catalogue - its base text, at whatever level its language was written in - and may have a variant per level, under its key followed by the level: "key._plain", "key._polite", "key._formal".

The level is the site's (base.translator.politeness) unless a call gives its own - the TRANSLATION_POLITENESS parameter of trans(), or one of these among the options of transEntity() / transEnum(). What is tried, in order: formal -> polite -> the base text; polite -> the base text; plain -> the base text. See docs/20-architecture/politeness.md.

const POLITENESS_PLAIN = "_plain"
const POLITENESS_POLITE = "_polite"
const POLITENESS_FORMAL = "_formal"
const POLITENESS_LEVELS = [self::POLITENESS_PLAIN, self::POLITENESS_POLITE, self::POLITENESS_FORMAL]
const MAX_NESTED_TRANSLATION_DEPTH = 10

Translator::__construct()

public function __construct(\Symfony\Contracts\Translation\TranslatorInterface $translator, KernelInterface $kernel, ParameterBagInterface $parameterBag, ?string $politeness = null, array $applicationTexts = [])
$applicationTexts

the keys the application wrote in its own translations/ directory, by domain and locale (ApplicationTextsPass; read only when a level is set)

Translator::getPoliteness()

public function getPoliteness(): ?string

The site's level of politeness: one of POLITENESS_*, or null when none is set.

Translator::setPoliteness()

public function setPoliteness(?string $level)

Another level from here on - a message written to somebody the site addresses otherwise, a test. "plain", "polite", "formal" (or a POLITENESS_* constant); null for the texts as they are written.

Translator::politenessLevel()

public static function politenessLevel(mixed $level): ?string

A level as it may be written - "polite", "_polite", POLITENESS_POLITE - as one of POLITENESS_*; null for none (null, false, "", "none").

Throws

InvalidArgumentException for anything else

Translator::politenessChain()

public static function politenessChain(?string $level): array

The variants tried for a level, the closest first: a formal text that was not written falls back on the polite one.

Translator::getCatalogue()

public function getCatalogue(?string $locale = null): MessageCatalogueInterface

Translator::getCatalogues()

public function getCatalogues(): array

Translator::getLocale()

public function getLocale(): string

Translator::setLocale()

public function setLocale(string $locale)

Translator::getFallbackLocales()

public function getFallbackLocales(): array

Translator::transQuiet()

public function transQuiet(TranslatableMessage|string $id, array $parameters = array(), ?string $domain = null, ?string $locale = null, bool $recursive = true, bool $nullable = true): ?string

Translator::trans()

public function trans(TranslatableMessage|string $id, array $parameters = array(), ?string $domain = null, ?string $locale = null, bool $recursive = true): string

Translator::parseClass()

public function parseClass($class, string $parseBy = self::PARSE_NAMESPACE): string

Translator::transExists()

public function transExists(TranslatableMessage|string $id, ?string $domain = null, ?string $locale = null, bool $localeCountry = true): bool

Translator::transRoute()

public function transRoute(string $routeName, ?string $domain = null): ?string

Translator::transRouteExists()

public function transRouteExists(string $routeName, ?string $domain = null): bool

Translator::transEnum()

public function transEnum(?string $value, string $class, null|string|array $options = self::NOUN_SINGULAR): ?string

Translator::transEnumExists()

public function transEnumExists(string $value, string $class, string|array $options = self::NOUN_SINGULAR): bool

Translator::transEntity()

public function transEntity(mixed $entityOrClassName, ?string $property = null, string|array $options = self::NOUN_SINGULAR): ?string

Translator::transEntityExists()

public function transEntityExists(mixed $entityOrClassName, ?string $property = null, string|array $options = self::NOUN_SINGULAR): bool

Translator::transTime()

public function transTime(int $time): string

TranslatorInterface interface

interface TranslatorInterface extends SymfonyTranslatorInterface, SymfonyTranslatorBagInterface TranslatorInterface.php:9

const TRANSLATION_NOUN = "noun"

The noun of an entity or an enumeration's value, singular or plural (transEntity(), transEnum()). Declared here, not on Translator, so that the code asking for a noun - an enumeration's type, Base\Database\Type\ EnumType::getText() - loads no class of the framework (Translator imports the kernel). Translator::NOUN_SINGULAR still names them.

const NOUN_SINGULAR = "_singular"
const NOUN_PLURAL = "_plural"

TranslatorInterface::getFallbackLocales()

public function getFallbackLocales(): array

TranslatorInterface::setLocale()

public function setLocale(string $locale)

TranslatorInterface::trans()

public function trans(TranslatableMessage|string $id, array $parameters = [], ?string $domain = null, ?string $locale = null, bool $recursive = true): string

TranslatorInterface::transQuiet()

public function transQuiet(TranslatableMessage|string $id, array $parameters = [], ?string $domain = null, ?string $locale = null, bool $recursive = true): ?string

TranslatorInterface::transExists()

public function transExists(TranslatableMessage|string $id, ?string $domain = null, ?string $locale = null): bool

TranslatorInterface::transTime()

public function transTime(int $time): string

TranslatorInterface::transEnum()

public function transEnum(?string $value, string $class, string|array $options = self::NOUN_SINGULAR): ?string

TranslatorInterface::transEnumExists()

public function transEnumExists(string $value, string $class, string|array $options = self::NOUN_SINGULAR): bool

TranslatorInterface::transEntity()

public function transEntity(mixed $entityOrClassName, ?string $property = null, string|array $options = self::NOUN_SINGULAR): ?string

TranslatorInterface::transEntityExists()

public function transEntityExists(mixed $entityOrClassName, ?string $property = null, string|array $options = self::NOUN_SINGULAR): bool

TranslatorInterface::transRoute()

public function transRoute(string $routeName, ?string $domain = null): ?string

TranslatorInterface::transRouteExists()

public function transRouteExists(string $routeName, ?string $domain = null): bool

TrashManager class

class TrashManager TrashManager.php:24

Reads and empties what TrasheableSubscriber put aside.

Every method here works with the trash filter turned off, because the whole point of the filter is that trashed entities are unreachable through the ORM - including to the code meant to bring them back. withTrash() is the only place that is allowed, and it restores the previous filter state even when the callable throws, so an exception mid-restore cannot leave the rest of the request able to see deleted content.

const FILTER = "trash_filter"

TrashManager::__construct()

public function __construct(protected EntityManagerInterface $entityManager)

TrashManager::withTrash()

public function withTrash(Closure $callable): mixed

Run something with trashed entities visible.

TrashManager::contents()

public function contents(?string $entityClass = null, ?int $limit = null, int $offset = 0): array

TrashManager::count()

public function count(?string $entityClass = null): int

TrashManager::entity()

public function entity(TrashBall $trashBall): ?object

The entity a trash entry stands for, or null if it is no longer there - a trash entry outliving its entity is possible (a hard delete elsewhere, a cascade from a parent) and must not be an error.

TrashManager::restore()

public function restore(TrashBall $trashBall): bool

Put an entity back. The trash entry goes with it - being in the trash and having a trash entry are the same fact, and leaving one behind would show a restored article as still deleted.

TrashManager::destroy()

public function destroy(TrashBall $trashBall): bool

Destroy an entity for good, along with everything recorded about it.

The removal only goes through because the deletion field is already stamped - that is the escape hatch TrasheableSubscriber leaves open, and the reason this cannot be used to bypass the trash on a live entity.

TrashManager::purge()

public function purge(?DateTimeInterface $now = null, ?int $limit = null): int

Destroy everything whose grace period has run out.

Returns

how many entities were actually destroyed

VersionManager class

class VersionManager VersionManager.php:24

Reads back what VersionableSubscriber wrote.

Two shapes of the same data:

history() the revisions of an entity, newest first - one line per save, which is what the entity-level history reads fieldHistory() the same revisions pivoted per field - which is what the per-field badge in the form label reads

A form render asks for the same entity once per locale tab, so the lookup is memoised for the life of the request: without it an article edited in three languages would issue the same query four times to draw its badges.

VersionManager::__construct()

public function __construct(protected EntityManagerInterface $entityManager, protected int $maxRevisions = 5)

VersionManager::history()

public function history(object $entity): array

Revisions anchored on $entity - passing a translation gives its parent's history, which is where its own changes were recorded.

VersionManager::fieldHistory()

public function fieldHistory(object $entity): array

The history of every versioned field of $entity, pivoted per property and expressed in terms the form can render without knowing about revisions at all.

Only the fields declared on the class passed in are returned, under their bare property name: a ThreadIntl gets title/headline/content, not "fr-FR.title", so a form child can be matched by its own name.

VersionManager::preview()

public function preview(mixed $value, int $length = 80): string

A short, human line standing for a stored value in the dropdown.

Deliberately lossy: this is the thing you read to decide whether that is the version you want, not the thing that gets restored - restoring uses the raw value.

WidgetProvider class

class WidgetProvider implements WidgetProviderInterface WidgetProvider.php:10

WidgetProvider::__construct()

public function __construct(EntityManagerInterface $entityManager)

WidgetProvider::get()

public function get(string $widgetName, bool $useCache = true): ?Widget

WidgetProvider::getWidget()

public function getWidget(string $widgetName, bool $useCache = true): ?Widget

WidgetProvider::all()

public function all(bool $useCache = true): array

WidgetProvider::allSlots()

public function allSlots(bool $useCache = true): array

WidgetProvider::getSlot()

public function getSlot(string $widgetSlotName, bool $useCache = true): ?Slot

WidgetProvider::getWidgetSlot()

public function getWidgetSlot(string $path, bool $useCache = true): ?Slot

WidgetProviderInterface interface

interface WidgetProviderInterface WidgetProviderInterface.php:8

WidgetProviderInterface::all()

public function all(): array

WidgetProviderInterface::allSlots()

public function allSlots(): array

WidgetProviderInterface::get()

public function get(string $widgetName): ?Widget

WidgetProviderInterface::getSlot()

public function getSlot(string $widgetSlotName): ?Slot

WysiwygEnhancer class

class WysiwygEnhancer implements WysiwygEnhancerInterface WysiwygEnhancer.php:13

WysiwygEnhancer::__construct()

public function __construct(Environment $twig, HeadingEnhancerInterface $headingEnhancer, SemanticEnhancerInterface $semanticEnhancer, MentionEnhancerInterface $mentionEnhancer, LinkEnhancerInterface $linkEnhancer, MediaEnhancerInterface $mediaEnhancer)

WysiwygEnhancer::supports()

public function supports(mixed $html): bool

WysiwygEnhancer::render()

public function render(mixed $html, array $options = []): string

WysiwygEnhancer::getTableOfContents()

public function getTableOfContents(mixed $html, ?int $maxLevel = null): array

WysiwygEnhancer::enhanceHeadings()

public function enhanceHeadings(mixed $html, ?int $maxLevel = null, array $attrs = []): mixed

WysiwygEnhancer::enhanceSemantics()

public function enhanceSemantics(mixed $html, null|array|string $words = null, array $attrs = []): mixed

WysiwygEnhancer::enhanceMentions()

public function enhanceMentions(mixed $html, array $attrs = []): mixed
public function enhanceLinks(mixed $html, array $attrs = []): mixed

WysiwygEnhancer::enhanceMedia()

public function enhanceMedia(mixed $html, array $config = [], FilterInterface|array $filters = [], array $attrs = []): mixed

WysiwygEnhancerInterface interface

interface WysiwygEnhancerInterface WysiwygEnhancerInterface.php:7

WysiwygEnhancerInterface::supports()

public function supports(mixed $json): bool

WysiwygEnhancerInterface::render()

public function render(mixed $json, array $options = []): string

WysiwygEnhancerInterface::getTableOfContents()

public function getTableOfContents(mixed $json, ?int $maxLevel = null): mixed

WysiwygEnhancerInterface::enhanceMentions()

public function enhanceMentions(mixed $html, array $attrs = []): mixed
public function enhanceLinks(mixed $html, array $attrs = []): mixed

WysiwygEnhancerInterface::enhanceMedia()

public function enhanceMedia(mixed $html, array $config = [], FilterInterface|array $filters = [], array $attrs = []): mixed

WysiwygEnhancerInterface::enhanceHeadings()

public function enhanceHeadings(mixed $json, ?int $maxLevel = null, array $attr = []): mixed

WysiwygEnhancerInterface::enhanceSemantics()

public function enhanceSemantics(mixed $json, null|array|string $words = null, array $attr = []): mixed

Base\Service\Analytics

UserAgentClassifier class

final class UserAgentClassifier UserAgentClassifier.php:22

Buckets a request's User-Agent into one of three Base\Entity\Analytics\ PageView::SOURCE_* values. AI checks run first and take priority over the generic crawler-detect pass: several AI crawlers (GPTBot, ClaudeBot, ...) also match generic bot heuristics, but they deserve their own bucket (SOURCE_AI) rather than falling into the catch-all SOURCE_BOT one - that split is the whole point of this class over just jaybizzle/crawler-detect's plain isCrawler() boolean.

A missing/empty User-Agent is classified as SOURCE_BOT rather than SOURCE_HUMAN: real browsers always send one, so its absence is itself a signal, and defaulting to "not human" keeps the human bucket honest instead of silently inflating it with unidentified traffic.

UserAgentClassifier::__construct()

public function __construct(readonly CrawlerDetect $crawlerDetect = new CrawlerDetect())

UserAgentClassifier::classify()

public function classify(?string $userAgent): string

Base\Service\Calendar

CalendarEntry class

final class CalendarEntry CalendarEntry.php:15

One date as a calendar sees it, whatever it was in the site: a concert (omnibase/agenda's Event), an appointment, a class, a pick-up. What Ics and GoogleCalendarLink write from - a bundle maps its own entity to one (see omnibase/agenda's Event::toCalendarEntry()).

$start and $end carry the timezone the date happens in (the hall's, the office's): an hour is written in it, a whole day ($allDay) as a date. With no end, a timed date lasts $defaultDuration.

const DEFAULT_DURATION = 'PT2H'
public readonly string $uid
public readonly string $title
public readonly \DateTimeImmutable $start
public readonly ?\DateTimeImmutable $end
public readonly bool $allDay
public readonly string $description
public readonly ?string $location
public readonly ?float $latitude
public readonly ?float $longitude
public readonly ?string $url
public readonly bool $cancelled
public readonly ?\DateTimeInterface $updatedAt
public readonly string $defaultDuration

CalendarEntry::__construct()

public function __construct(public readonly string $uid, public readonly string $title, public readonly \DateTimeImmutable $start, public readonly ?\DateTimeImmutable $end = null, public readonly bool $allDay = false, public readonly string $description = '', public readonly ?string $location = null, public readonly ?float $latitude = null, public readonly ?float $longitude = null, public readonly ?string $url = null, public readonly bool $cancelled = false, public readonly ?\DateTimeInterface $updatedAt = null, public readonly string $defaultDuration = self::DEFAULT_DURATION)

CalendarEntry::timezone()

public function timezone(): \DateTimeZone

CalendarEntry::effectiveEnd()

public function effectiveEnd(): \DateTimeImmutable

The end a calendar should show: the one given, else the start plus the default duration (a whole day: that day).

class GoogleCalendarLink GoogleCalendarLink.php:10

The "add to Google Calendar" link of a date: Google's own template page, filled in. Hours go in UTC with the date's timezone beside them (ctz), whole days as dates, the last one excluded as Google wants it.

public function for(CalendarEntry $entry): string

Ics class

class Ics Ics.php:12

Dates as an iCalendar file (RFC 5545), written by hand: a calendar a phone subscribes to, or one date to add. Lines end with CRLF and are folded at 75 octets, texts are escaped, an hour is given in the date's timezone (with the VTIMEZONE that defines it) or in UTC, a date of whole days as dates. Moved here from omnibase/agenda, on CalendarEntry.

const PROD_ID = '-//omnibase//calendar//EN'

Ics::calendar()

public function calendar(iterable $entries, string $name = 'Agenda', string $prodId = self::PROD_ID): string

Ics::event()

public function event(CalendarEntry $entry): string

One date as a VEVENT block, to put in a VCALENDAR.

Ics::escape()

public static function escape(string $text): string

A text value: backslash, semicolon, comma and line break escaped.

Ics::fold()

public static function fold(string $line): string

A line of more than 75 octets continues on the next ones, each opened by a space; never inside a character.

Ics::unfold()

public static function unfold(string $ics): array

Lines folded at 75 octets read back as one (RFC 5545 §3.1).

@return list<string>

Base\Service\Collab

CollabRoomResolver class

class CollabRoomResolver CollabRoomResolver.php:14

This class supplies room-key logic and version-hash logic for the real-time collaboration feature. EditorType uses this class.

EditorController uses this class. The regular-field presence widget uses this class. Because of this shared use, the room-key format and the hash method exist in one place only.

CollabRoomResolver::__construct()

public function __construct(EntityManagerInterface $entityManager)

CollabRoomResolver::buildRoom()

public function buildRoom(string $fqcn, int|string $id, string $field, ?string $locale = null): string

The room key has this format: entity_fqcn:entity_id:field:locale.

Each field has one separate room. Example: an EditorJS field and a select2 field on the same record use two different rooms. The locale segment is always present. This method uses the placeholder value "_" for a field with no locale. Translatable content is specific to one locale. This method must not mix presence data or conflict data between two locales.

CollabRoomResolver::tokenId()

public function tokenId(string $room): string

The CSRF token id of one room - one entity's one field. The autosave and the collab ticket accept only the token of the room they act on: with the session-wide "editorjs" token, which any form with an editor hands out, anyone could write any field of any entity (a User's roles).

CollabRoomResolver::resolveEntity()

public function resolveEntity(mixed $data): ?object

The root form data is not always the mapped entity. An embedded form or a collection form can bind a separate DTO object or wrapper object instead. In this case, this method returns null. This method does not guess the correct entity. When this method returns null, the caller must skip the collaboration setup for that field.

CollabRoomResolver::hash()

public function hash(mixed $value): string

This method creates a version stamp for a field's current value.

This system uses this stamp for optimistic-concurrency control. This method uses a content hash. This method does not use a timestamp column, because not every entity has a timestamp column. This method avoids a database schema change for each entity.

CollabTicketFactory class

class CollabTicketFactory CollabTicketFactory.php:18

This class creates a short-lived, signed ticket. A browser presents this ticket to the collab relay (relay/src/server.js in editorjs-yjs), to join a room's WebSocket connection. The relay checks the signature by itself.

The relay does not send requests to PHP. The relay does not read the session store. Because of this, this class is the only place on this side that uses the shared secret.

Ticket format: base64url(payload) . "." . hex(hmac_sha256(payload, secret)). This format matches the relay's own verifyTicket() method exactly. To confirm this match, read the relay code first. Do not design each side separately.

CollabTicketFactory::__construct()

public function __construct(string $secret, string $wsUrl = "", int $ttl = 300)

$ttl is the ticket lifetime in seconds.

300, not 60: a ticket is only presented on the WebSocket handshake, and the client refreshes it well inside this window, so a short ttl bounds exposure of a leaked ticket without any legitimate client ever needing to stretch it. 60 was too tight in practice - the client's refresh timer runs at 45s, and browsers clamp timers in background tabs to once a minute (suspending them entirely while the machine sleeps), so the refresh routinely slipped past a 60s ttl and the following reconnect presented an expired ticket, which the relay rejects with 401. The client now also refreshes on socket close and on tab focus, so this margin is defence in depth rather than the only guard.

CollabTicketFactory::isConfigured()

public function isConfigured(): bool

An operator can deploy a relay with a secret value, but with no public WebSocket URL yet. The opposite case can also occur during setup. The collab_live option needs both values. Because of this, a caller must check this method before it activates the collab_live option for a field.

CollabTicketFactory::getWsUrl()

public function getWsUrl(): string

CollabTicketFactory::mint()

public function mint(string $room, array $user): ?string

CollabTicketFactory::verifyServiceToken()

public function verifyServiceToken(string $token, string $room): bool

This method checks a service-to-service token. The relay signs this token by itself. This token uses the same HMAC format as the mint() method, with payload {room, exp} and with no user fields.

The relay sends this token when the relay calls ux_editorjs_autosave, to save a room's content. The relay process is not a browser. Because of this, no Symfony session exists for that call. This method reuses the same shared secret from the other direction, instead of a second secret. This design uses one secret for symmetric use on both sides.

Base\Service\Model

Autocomplete class

class Autocomplete Autocomplete.php:10

Autocomplete::__construct()

public function __construct(TranslatorInterface $translator, ?MediaServiceInterface $mediaService = null)

Autocomplete::resolve()

public function resolve($entry, $class = null, array $entryOptions = [])

Autocomplete::resolveArray()

public function resolveArray($entry, array $entryOptions = [])
Throws

Exception

AutocompleteInterface interface

interface AutocompleteInterface AutocompleteInterface.php:5

AutocompleteInterface::__autocomplete()

public function __autocomplete(): ?string

AutocompleteInterface::__autocompleteData()

public function __autocompleteData(): array

Autovalidate class

class Autovalidate Autovalidate.php:8

Autovalidate::__construct()

public function __construct(TranslatorInterface $translator = null)

Autovalidate::validate()

public function validate($value, Constraint ...$constraints): bool

AutovalidateInterface interface

interface AutovalidateInterface AutovalidateInterface.php:5

Breadcrumb class

class Breadcrumb implements BreadcrumbInterface, Iterator, Countable, ArrayAccess Breadcrumb.php:17

Breadcrumb::offsetExists()

public function offsetExists(mixed $offset): bool

Breadcrumb::offsetUnset()

public function offsetUnset(mixed $offset): void

Breadcrumb::offsetGet()

public function offsetGet(mixed $offset): mixed

Breadcrumb::offsetSet()

public function offsetSet(mixed $offset, mixed $value = []): void

Breadcrumb::count()

public function count(): int

Breadcrumb::rewind()

public function rewind(): void

Breadcrumb::next()

public function next(): void

Breadcrumb::key()

public function key(): mixed

Breadcrumb::valid()

public function valid(): bool

Breadcrumb::current()

public function current(): mixed

Breadcrumb::__construct()

public function __construct(AdvancedRouterInterface $router, TranslatorInterface $translator, array $options = [], ?string $template = null)

Breadcrumb::getRequest()

public function getRequest(): ?Request

Breadcrumb::setRequest()

public function setRequest(Request $request): self

Breadcrumb::compute()

public function compute(?Request $request = null)
Throws

Exception

Breadcrumb::getRouteParameters()

public function getRouteParameters(?string $url = null, ?string $urlPattern = null)

Breadcrumb::getRouteName()

public function getRouteName(?string $url = null): string

Breadcrumb::getController()

public function getController(?string $url = null): string

Breadcrumb::getRouter()

public function getRouter(): AdvancedRouterInterface

Breadcrumb::setRouter()

public function setRouter(AdvancedRouterInterface $router)

Breadcrumb::getTranslator()

public function getTranslator(): TranslatorInterface

Breadcrumb::setTranslator()

public function setTranslator(TranslatorInterface $translator)

Breadcrumb::getTemplate()

public function getTemplate(): string

Breadcrumb::setTemplate()

public function setTemplate(string $template)

Breadcrumb::getOptions()

public function getOptions(): array

Breadcrumb::addOptions()

public function addOptions(array $options)

Breadcrumb::setOptions()

public function setOptions(array $options)

Breadcrumb::getOption()

public function getOption(string $name)

Breadcrumb::addOption()

public function addOption(string $name, $value)

Breadcrumb::removeOption()

public function removeOption(string $name)

Breadcrumb::removeItem()

public function removeItem(string $offset)

Breadcrumb::prependItem()

public function prependItem(string $label, ?string $route = null, array $routeParameters = [])

Breadcrumb::appendItem()

public function appendItem(string $label, ?string $route = null, array $routeParameters = [])

Breadcrumb::clear()

public function clear()

Breadcrumb::getLength()

public function getLength()

Breadcrumb::getItems()

public function getItems()

Breadcrumb::getFirstItem()

public function getFirstItem()

Breadcrumb::getLastItem()

public function getLastItem()

Breadcrumb::getItem()

public function getItem(int $index)

BreadcrumbInterface interface

interface BreadcrumbInterface BreadcrumbInterface.php:5

CacheableInterface interface

interface CacheableInterface CacheableInterface.php:5

CacheableInterface::__toKey()

public function __toKey(?string ...$context): string

CacheableInterface::__toKeyTTL()

public function __toKeyTTL(): ?int

CacheableInterface::__toKeyTags()

public function __toKeyTags(): array

ClassAliases class

final class ClassAliases ClassAliases.php:18

omnibase's class convention, without the bundle: App\Entity\X is Base\Entity\X when the application declares no App\Entity\X of its own - and so for App\Repository, App\Enum, App\Tests, App\Notifier, App\Form. Under Symfony, BaseBundle::warmUp() declares these aliases from its pool and AbstractBaseBundle's last-resort autoloader answers by the same convention (it asks base()); an entity manager built by hand (Base\Bridge\Doctrine\ Mapping) registers the convention as an autoloader of its own - an association names its target App\Entity\User\Notification.

Composer is asked first: an application's own class, or the stub glitchr/base-plugin wrote for it, is never replaced.

const NAMESPACES = ["Entity", "Repository", "Enum", "Tests", "Notifier", "Form"]

The namespaces mapped App\X => Base\X.

ClassAliases::base()

public static function base(string $class): ?string

The Base class an App class is by convention, null for any other.

ClassAliases::register()

public static function register(): void

The convention as an autoloader, appended after Composer's: once a process.

ClassFinder class

final class ClassFinder ClassFinder.php:11

The classes a folder of PHP files declares, read from the files: each file's namespace and its name, the interfaces (*Interface.php) and the empty files left out - what Base\Bundle\AbstractBaseBundle::getAllClasses() answers, without loading the bundle (and with it the framework) to ask.

ClassFinder::classes()

public static function classes(string $path): array

ColorizeInterface interface

interface ColorizeInterface ColorizeInterface.php:5

ColorizeInterface::__colorize()

public function __colorize(): ?array

ColorizeInterface::__colorizeStatic()

public static function __colorizeStatic(): ?array

GraphInterface interface

interface GraphInterface GraphInterface.php:7

GraphInterface::getParent()

public function getParent()

GraphInterface::getChildren()

public function getChildren(): Collection

GraphInterface::getConnexes()

public function getConnexes(): Collection

HtmlizeInterface interface

interface HtmlizeInterface HtmlizeInterface.php:5

HtmlizeInterface::__toHtml()

public function __toHtml(array $options = [], ...$args): ?string

IconizeInterface interface

interface IconizeInterface IconizeInterface.php:5

IconizeInterface::__iconize()

public function __iconize(): ?array

IconizeInterface::__iconizeStatic()

public static function __iconizeStatic(): ?array

IntlDateTime class

class IntlDateTime extends DateTime IntlDateTime.php:11

IntlDateTime::__construct()

public function __construct(DateTime|string $datetime = "now", ?string $locale = null, int $dateType = IntlDateFormatter::FULL, int $timeType = IntlDateFormatter::FULL, IntlTimeZone|DateTimeZone|string|null $timezone = null, IntlCalendar|int|null $calendar = null)

IntlDateTime::format()

public function format(string $format): string

IntlDateTime::createFromDateTime()

public static function createFromDateTime(DateTime $datetime, ?string $locale = null, int $dateType = IntlDateFormatter::FULL, int $timeType = IntlDateFormatter::FULL, DateTimeZone|string|null $timezone = null, int|null $calendar = null)
Throws

Exception

LinkableInterface interface

interface LinkableInterface LinkableInterface.php:13

A thing with an address. $referenceType is one of Symfony's UrlGeneratorInterface reference types, by their values (Base\Contract\Link's constants, so that the interface names nothing of the routing component); Link::to() makes the address through the Urls contract.

LinkableInterface::__toString()

public function __toString()

LinkableInterface::__toLink()

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

LocaleNormalizer class

final class LocaleNormalizer LocaleNormalizer.php:29

omnibase's locale form, xx-XX, without the framework (plan "omnibase agnostique", C3e): the rule Base\Service\Localizer::normalizeLocale() and __toLocaleLang() apply, taken out of the Localizer (a Symfony service, its statics filled at its warm-up), which now asks it with its own default and fallback locales - the same strings, by construction.

  • "fr_FR", "fr-FR": five characters, the separator made a dash;
  • "fr", "fr-XX": the language when intl knows it (else the default locale's), and its country among the available locales of that language (the first of them; else the default locale's country), keeping the one given when it is available.

here() is what the entities ask (TranslatableTrait, TranslationTrait): the default and available locales of the Locales contract (Runtime::locales(); under Symfony Base\Bridge\Symfony\LocalizerLocales, the Localizer's own), none when the registry has no Locales, as the Localizer's statics are empty before it is built. Not a contract: a rule over one.

const SEPARATOR = '-'

LocaleNormalizer::getLocales()

public static function getLocales(): array

Every language of intl's xx-YY locales, and its countries.

LocaleNormalizer::normalize()

public static function normalize(string $locale, ?string $defaultLocale, array $availableLocales, ?array $locales = null): string
$availableLocales

the default first, in omnibase's form

$locales

every language and its countries; intl's when null

LocaleNormalizer::lang()

public static function lang(string $locale, ?string $defaultLocale, ?array $locales = null): string

The language of a locale: its first two letters when intl knows them, else the default locale's.

$locales

every language and its countries; intl's when null

LocaleNormalizer::here()

public static function here(string $locale): string

normalize() with the Locales contract's default and available locales (Runtime), as the entities ask; none when the registry has no Locales.

Pagination class

class Pagination implements PaginationInterface, Iterator, Countable Pagination.php:16

Pagination::__construct()

public function __construct(array|Query $arrayOrQuery, RouterInterface $router, ?string $parameterName = "page")

Pagination::getCountQuery()

public function getCountQuery(Query $query, bool $bHint = true): Query

Pagination::rewind()

public function rewind(): void

Pagination::next()

public function next(): void

Pagination::count()

public function count(): int

Pagination::key()

public function key(): mixed

Pagination::valid()

public function valid(): bool

Pagination::current()

public function current(): mixed

Pagination::getBookmark()

public function getBookmark(): mixed

Pagination::get()

public function get()

Pagination::getQuery()

public function getQuery(): ?Query

Pagination::isQuery()

public function isQuery()

Pagination::getTotalCount()

public function getTotalCount()

Pagination::getLastPage()

public function getLastPage()

Pagination::getTotalPages()

public function getTotalPages()

Pagination::getTemplate()

public function getTemplate()

Pagination::setTemplate()

public function setTemplate(string $template)

Pagination::setParameterName()

public function setParameterName($parameterName)

Pagination::getParameterName()

public function getParameterName()

Pagination::getPageRange()

public function getPageRange()

Pagination::setPageRange()

public function setPageRange(int $pageRange)

Pagination::getPageSize()

public function getPageSize()

Pagination::setPageSize()

public function setPageSize($pageSize)

Pagination::getPage()

public function getPage()

Pagination::setPage()

public function setPage($page)

Pagination::getPath()

public function getPath(string $name, int $page = 0, array $parameters = [])

Pagination::getResult()

public function getResult()
Throws

InvalidPageException

PaginationInterface interface

interface PaginationInterface PaginationInterface.php:7

PaginationInterface::getPage()

public function getPage()

PaginationInterface::getPageSize()

public function getPageSize()

PaginationInterface::getPageRange()

public function getPageRange()

PaginationInterface::getTotalPages()

public function getTotalPages()

PaginationInterface::getTemplate()

public function getTemplate()

PaginationInterface::getPath()

public function getPath(string $name, int $page = 0, array $parameters = [])

PaginationInterface::getResult()

public function getResult()

PaginationInterface::getTotalCount()

public function getTotalCount()

SaltInterface interface

interface SaltInterface SaltInterface.php:5

SaltInterface::getSalt()

public function getSalt(): string

SelectInterface interface

interface SelectInterface SelectInterface.php:5

SelectInterface::getIcon()

public static function getIcon(string $id, int $index = -1): ?string

SelectInterface::getText()

public static function getText(string $id): ?string

SelectInterface::getHtml()

public static function getHtml(string $id): ?string

SelectInterface::getData()

public static function getData(string $id): ?array

SitemapEntry class

class SitemapEntry SitemapEntry.php:5

SitemapEntry::getLoc()

public function getLoc(): ?string

SitemapEntry::getLocale()

public function getLocale(): ?string

SitemapEntry::setLocale()

public function setLocale(string $locale): self

SitemapEntry::getPriority()

public function getPriority(): ?float

SitemapEntry::setPriority()

public function setPriority(float $priority): self

SitemapEntry::getLastMod()

public function getLastMod(): ?string

SitemapEntry::setLastMod()

public function setLastMod(string $lastMod): self

SitemapEntry::getChangeFreq()

public function getChangeFreq(): ?string

SitemapEntry::setChangeFreq()

public function setChangeFreq(string $changeFreq): self

SitemapEntry::hasAlternate()

public function hasAlternate(SitemapEntry $entry)

SitemapEntry::getAlternates()

public function getAlternates(): array

SitemapEntry::addAlternate()

public function addAlternate(SitemapEntry $entry): self

SitemapEntry::removeAlternate()

public function removeAlternate(SitemapEntry $entry): self

SitemapEntry::__construct()

public function __construct($loc)

SitemapEntry::toArray()

public function toArray(): array

SpamProtectionInterface interface

interface SpamProtectionInterface SpamProtectionInterface.php:8

SpamProtectionInterface::getSpamBlameable()

public function getSpamBlameable(): ?User

SpamProtectionInterface::getSpamText()

public function getSpamText(): ?string

SpamProtectionInterface::getSpamDate()

public function getSpamDate(): DateTime

SpamProtectionInterface::getSpamCallback()

public function getSpamCallback(int $score)

WorkflowInterface interface

interface WorkflowInterface extends WorkflowInterface WorkflowInterface.php:5

WorkflowInterface::getWorkflowName()

public static function getWorkflowName(): string

WorkflowInterface::getWorkflowType()

public static function getWorkflowType(): string

WorkflowInterface::supports()

public static function supports(): array

WorkflowInterface::supportStrategy()

public static function supportStrategy(): ?string

Base\Service\Model\Color

Palette class

class Palette implements Countable, IteratorAggregate Palette.php:11

Palette::getColorKey()

public function getColorKey()

Palette::setColorKey()

public function setColorKey(int|null $colorKey)

Palette::count()

public function count(): int

Palette::getIterator()

public function getIterator(): ArrayIterator

Palette::getCount()

public function getCount(int $color): int

Palette::getDominantColors()

public function getDominantColors(?int $limit = null): array

Palette::fromFilename()

public static function fromFilename(string $filename, int|null $colorKey = null): self

Palette::fromGD()

public static function fromGD(GdImage $image, int|null $colorKey = null): self

Palette::load()

public function load($filenameOrImage, int|null $colorKey = null): Palette

Palette::loadResource()

public function loadResource(GdImage|false $resource, int|null $colorKey = null): Palette

Base\Service\Model\Color\Intl

Colors class

final class Colors extends ResourceBundle Colors.php:9

const COLOR_DIR = "colors"

Colors::getLocaleLanguageCodes()

public static function getLocaleLanguageCodes(): array

Colors::exists()

public static function exists(string $color): bool

Colors::getName()

public static function getName(string $color, ?string $displayLocale = null): string

Colors::getNames()

public static function getNames(?string $displayLocale = null): array

Colors::getHSL()

public static function getHSL(string $color): array

Colors::getRGB()

public static function getRGB(string $color): array

Colors::getHexCode()

public static function getHexCode(string $color): string

Colors::getHexCodes()

public static function getHexCodes(): array

Base\Service\Model\Currency

AbstractCurrencyApi class

abstract class AbstractCurrencyApi implements CurrencyApiInterface AbstractCurrencyApi.php:7

AbstractCurrencyApi::__construct()

public function __construct(SettingBag $settingBag)

AbstractCurrencyApi::getName()

public static function getName(): string

AbstractCurrencyApi::supports()

public function supports(string $key): bool

AbstractCurrencyApi::getPriority()

public function getPriority(): int

AbstractCurrencyApi::getOptions()

public function getOptions(): array

AbstractCurrencyApi::getKey()

public function getKey(): ?string

CurrencyApiInterface interface

interface CurrencyApiInterface CurrencyApiInterface.php:5

CurrencyApiInterface::supports()

public function supports(string $key): bool

CurrencyApiInterface::getPriority()

public function getPriority(): int

CurrencyApiInterface::getOptions()

public function getOptions(): array

CurrencyApiInterface::getKey()

public function getKey(): ?string

Base\Service\Model\Currency\Api

AbstractApi class

class AbstractApi extends AbstractCurrencyApi AbstractApi.php:9

AbstractApi::getOptions()

public function getOptions(): array

CurrencyLayer class

class CurrencyLayer extends AbstractCurrencyApi CurrencyLayer.php:10

CurrencyLayer::__construct()

public function __construct(SettingBagInterface $settings, bool $enterprise = false)

CurrencyLayer::getOptions()

public function getOptions(): array

ExchangeRatesApi class

class ExchangeRatesApi extends AbstractCurrencyApi ExchangeRatesApi.php:9

ExchangeRatesApi::getOptions()

public function getOptions(): array

Fixer class

class Fixer extends AbstractCurrencyApi Fixer.php:9

Fixer::getOptions()

public function getOptions(): array

Base\Service\Model\IconProvider

AbstractIconAdapter class

abstract class AbstractIconAdapter extends AbstractLocalCache implements IconAdapterInterface AbstractIconAdapter.php:12

AbstractIconAdapter::__construct()

public function __construct(string $cacheDir, ?string $buildDir = null)

AbstractIconAdapter::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

AbstractIconAdapter::getVersion()

public function getVersion(): string

AbstractIconAdapter::getContents()

public function getContents()

AbstractIconAdapter::getMetadata()

public function getMetadata()

AbstractIconAdapter::getEntries()

public function getEntries()

AbstractIconAdapter::getEntry()

public function getEntry(?string $value = null): string

AbstractIconAdapter::iconify()

public function iconify(IconizeInterface|string $icon, array $attributes = []): string

IconAdapterInterface interface

interface IconAdapterInterface IconAdapterInterface.php:7

IconAdapterInterface::supports()

public function supports(IconizeInterface|string|null $icon): bool

IconAdapterInterface::iconify()

public function iconify(IconizeInterface|string $icon, array $attributes): string

IconAdapterInterface::getName()

public static function getName(): string

IconAdapterInterface::getOptions()

public static function getOptions(): array

IconAdapterInterface::getVersion()

public function getVersion(): string

IconAdapterInterface::getAssets()

public function getAssets(): array

IconAdapterInterface::getChoices()

public function getChoices(string $term = "")

Base\Service\Model\IconProvider\Adapter

BootstrapTwitterAdapter class

class BootstrapTwitterAdapter extends AbstractIconAdapter BootstrapTwitterAdapter.php:8

const STYLE_REGULAR = "regular"
const STYLE_FILL = "filled"

BootstrapTwitterAdapter::getName()

public static function getName(): string

BootstrapTwitterAdapter::getOptions()

public static function getOptions(): array

BootstrapTwitterAdapter::__construct()

public function __construct(string $metadata, string $cacheDir, ?string $buildDir = null, ?string $stylesheet = null)

BootstrapTwitterAdapter::getAssets()

public function getAssets(): array

BootstrapTwitterAdapter::supports()

public function supports(IconizeInterface|string|null $icon): bool

BootstrapTwitterAdapter::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

BootstrapTwitterAdapter::getChoices()

public function getChoices(string $term = ""): array

BootstrapTwitterAdapter::getStyle()

public function getStyle(string $name)

BootstrapTwitterAdapter::getIdentifier()

public function getIdentifier(string $name)
Throws

Exception

BootstrapTwitterAdapter::getValues()

public function getValues()

BootstrapTwitterAdapter::getValue()

public function getValue(string $name)

BootstrapTwitterAdapter::getLabels()

public function getLabels()

BootstrapTwitterAdapter::getLabel()

public function getLabel(string $name)

FontAwesomeAdapter class

class FontAwesomeAdapter extends AbstractIconAdapter FontAwesomeAdapter.php:8

const STYLE_SOLID = "solid"
const STYLE_REGULAR = "regular"
const STYLE_LIGHT = "light"
const STYLE_THIN = "thin"
const STYLE_DUOTONE = "duotone"
const STYLE_BRANDS = "brands"
const STYLE_KIT = "kit"

FontAwesomeAdapter::__construct()

public function __construct(string $metadata, string $cacheDir, ?string $buildDir = null, ?string $javascript = null, ?string $stylesheet = null)

FontAwesomeAdapter::getName()

public static function getName(): string

FontAwesomeAdapter::getOptions()

public static function getOptions(): array

FontAwesomeAdapter::getAssets()

public function getAssets(): array

FontAwesomeAdapter::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

FontAwesomeAdapter::supports()

public function supports(IconizeInterface|string|null $icon): bool

FontAwesomeAdapter::getClass()

public function getClass(string $style): ?string

FontAwesomeAdapter::getChoices()

public function getChoices(string $term = ""): array

FontAwesomeAdapter::getStyle()

public function getStyle(string $name)

FontAwesomeAdapter::getIdentifier()

public function getIdentifier(string $name)
Throws

Exception

FontAwesomeAdapter::getStyles()

public function getStyles(?string $name = null)

FontAwesomeAdapter::getValues()

public function getValues()

FontAwesomeAdapter::getValue()

public function getValue(string $name)

FontAwesomeAdapter::getLabels()

public function getLabels()

FontAwesomeAdapter::getLabel()

public function getLabel(string $name)

FontAwesomeAdapter::getUnicodes()

public function getUnicodes()

FontAwesomeAdapter::getUnicode()

public function getUnicode(string $name)

Base\Service\Model\Obfuscator

AbstractCompression class

abstract class AbstractCompression implements CompressionInterface AbstractCompression.php:7

AbstractCompression::supports()

public function supports(string $name): bool

AbstractCompression::getLevel()

public function getLevel(): int

AbstractCompression::setLevel()

public function setLevel(int $level): static

AbstractCompression::getEncoding()

public function getEncoding(): ?string

AbstractCompression::setEncoding()

public function setEncoding(?string $encoding): static

AbstractCompression::getMaxLength()

public function getMaxLength(): int

AbstractCompression::setMaxLength()

public function setMaxLength(int $maxLength): static

AbstractCompression::encode()

public function encode(string $data): ?string

AbstractCompression::decode()

public function decode(string $hex): ?string

CompressionInterface interface

interface CompressionInterface CompressionInterface.php:5

CompressionInterface::getName()

public function getName(): string

CompressionInterface::supports()

public function supports(string $name): bool

CompressionInterface::encode()

public function encode(string $data): ?string

CompressionInterface::decode()

public function decode(string $hex): ?string

Base\Service\Model\Obfuscator\Compression

DeflateCompression class

class DeflateCompression extends AbstractCompression DeflateCompression.php:7

DeflateCompression::getName()

public function getName(): string

DeflateCompression::getEncoding()

public function getEncoding(): ?string

GzipCompression class

class GzipCompression extends AbstractCompression GzipCompression.php:7

GzipCompression::getName()

public function getName(): string

GzipCompression::getEncoding()

public function getEncoding(): ?string

HashidsCompression class

class HashidsCompression extends AbstractCompression HashidsCompression.php:8

HashidsCompression::__construct()

public function __construct(string $secret)

HashidsCompression::getName()

public function getName(): string

HashidsCompression::getEncoding()

public function getEncoding(): ?string

HashidsCompression::isValid()

public function isValid(string $hash): bool

NullCompression class

class NullCompression extends AbstractCompression NullCompression.php:7

NullCompression::getName()

public function getName(): string

ZlibCompression class

class ZlibCompression extends AbstractCompression ZlibCompression.php:7

ZlibCompression::getName()

public function getName(): string

ZlibCompression::getEncoding()

public function getEncoding(): ?string

Base\Service\Model\Sharing

AbstractSharingAdapter class

abstract class AbstractSharingAdapter implements SharingAdapterInterface, IconizeInterface AbstractSharingAdapter.php:8

AbstractSharingAdapter::__iconize()

public function __iconize(): ?array

AbstractSharingAdapter::__construct()

public function __construct(Environment $twig)

AbstractSharingAdapter::getTemplate()

public function getTemplate(): string

AbstractSharingAdapter::generate()

public function generate(array $options, ?string $template = null): string

SharingAdapterInterface interface

interface SharingAdapterInterface SharingAdapterInterface.php:5

SharingAdapterInterface::getIdentifier()

public function getIdentifier(): string

SharingAdapterInterface::getUrl()

public function getUrl(): string

SharingAdapterInterface::getTemplate()

public function getTemplate(): string

SharingAdapterInterface::generate()

public function generate(array $options, ?string $template = null): string

Base\Service\Model\Sharing\Adapter

FacebookAdapter class

class FacebookAdapter extends AbstractSharingAdapter FacebookAdapter.php:7

FacebookAdapter::getIdentifier()

public function getIdentifier(): string

FacebookAdapter::getUrl()

public function getUrl(): string

FacebookAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

GooglePlusAdapter class

class GooglePlusAdapter extends AbstractSharingAdapter GooglePlusAdapter.php:7

GooglePlusAdapter::getIdentifier()

public function getIdentifier(): string

GooglePlusAdapter::getUrl()

public function getUrl(): string

GooglePlusAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

LinkedInAdapter class

class LinkedInAdapter extends AbstractSharingAdapter LinkedInAdapter.php:7

LinkedInAdapter::getIdentifier()

public function getIdentifier(): string

LinkedInAdapter::getUrl()

public function getUrl(): string

LinkedInAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

PinterestAdapter class

class PinterestAdapter extends AbstractSharingAdapter PinterestAdapter.php:7

PinterestAdapter::getIdentifier()

public function getIdentifier(): string

PinterestAdapter::getUrl()

public function getUrl(): string

PinterestAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

TumblrAdapter class

class TumblrAdapter extends AbstractSharingAdapter TumblrAdapter.php:7

TumblrAdapter::getIdentifier()

public function getIdentifier(): string

TumblrAdapter::getUrl()

public function getUrl(): string

TumblrAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

TwitterAdapter class

class TwitterAdapter extends AbstractSharingAdapter TwitterAdapter.php:7

TwitterAdapter::getIdentifier()

public function getIdentifier(): string

TwitterAdapter::getUrl()

public function getUrl(): string

TwitterAdapter::__iconizeStatic()

public static function __iconizeStatic(): ?array

Base\Service\Model\Wysiwyg

EditorJsRenderer class

final class EditorJsRenderer EditorJsRenderer.php:17

EditorJS's saved document ({"blocks": [...]}) as HTML, on the server: what a page shows without the editor's script, what a crawler, an e-mail or a feed reads. The blocks of omnibase's editor: paragraph, header, list (nested, ordered, checklist), checklist, quote, image, embed, table, code, delimiter, warning, alert, raw, linkTool, attaches. A block of a type it does not know is left out.

The text of a block is the editor's inline HTML (bold, links, marks, mentions): kept, minus what could run (tags outside the list below, on* attributes, javascript: addresses).

EditorJsRenderer::render()

public static function render(mixed $document): string

HeadingEnhancer class

class HeadingEnhancer implements HeadingEnhancerInterface HeadingEnhancer.php:9

HeadingEnhancer::__construct()

public function __construct(EntityManagerInterface $entityManager, SluggerInterface $slugger)

HeadingEnhancer::toc()

public function toc(mixed $html, ?int $maxLevel = null): array

HeadingEnhancer::enhance()

public function enhance(mixed $html, ?int $maxLevel = null, array $attrs = []): mixed

HeadingEnhancerInterface interface

interface HeadingEnhancerInterface HeadingEnhancerInterface.php:5

HeadingEnhancerInterface::enhance()

public function enhance(string|array|null $strOrArray, ?int $maxLevel, array $attributes = []): mixed

HeadingEnhancerInterface::toc()

public function toc(mixed $strOrArray, ?int $maxLevel): array

LinkEnhancer class

class LinkEnhancer implements LinkEnhancerInterface LinkEnhancer.php:7

LinkEnhancer::enhance()

public function enhance(string|array|null $strOrArray, array $attributes = []): string|array|null

Rewrites same-site absolute <a href> links back to relative, leaving everything else (external links, already-relative paths, anchors, mailto:/tel:, ...) untouched.

An editor authoring/pasting a link always bakes in whatever host they were browsing at the time (EditorJS's built-in inline "link" tool stores the href verbatim, no normalization) - on this app that means an absolute https://m.apfelschorlette.fr/... URL sits in the stored content forever, so viewing that same article on beta.m.apfelschorlette.fr (or any other environment sharing the DB) silently bounces the reader back to production instead of following the link on the current host (reported live).

"Same site" is deliberately domain+subdomain, NOT the full host: AdvancedRouter's own getDomain()/getSubdomain()/getMachine() split (see parse_url2()) treats "apfelschorlette.fr" + "m" as the stable site identity and "machine" (beta/empty) as the part that legitimately varies per environment - comparing full hosts would never match beta against prod, which is exactly the case this exists to fix.

LinkEnhancerInterface interface

interface LinkEnhancerInterface LinkEnhancerInterface.php:5

LinkEnhancerInterface::enhance()

public function enhance(string|array|null $strOrArray, array $attributes = []): string|array|null

MediaEnhancer class

class MediaEnhancer implements MediaEnhancerInterface MediaEnhancer.php:11

MediaEnhancer::__construct()

public function __construct(MediaServiceInterface $mediaService, FlysystemInterface $flysystem, ?LoggerInterface $logger = null)

MediaEnhancer::enhance()

public function enhance(string|array|null $strOrArray, array $config = [], FilterInterface|array $filters = [], array $attributes = []): string|array|null

MediaEnhancerInterface interface

interface MediaEnhancerInterface MediaEnhancerInterface.php:7

MediaEnhancerInterface::enhance()

public function enhance(string|array|null $strOrArray, array $config = [], FilterInterface|array $filters = [], array $attributes = []): string|array|null

MentionEnhancer class

class MentionEnhancer implements MentionEnhancerInterface MentionEnhancer.php:14

MentionEnhancer::__construct()

public function __construct(MentionRepository $mentionRepository, UserRepository $userRepository, EntityManagerInterface $entityManager, ObfuscatorInterface $obfuscator)

MentionEnhancer::getRepository()

public function getRepository(): MentionRepository

MentionEnhancer::extractMentionees()

public function extractMentionees(string|array|null $strOrArray, array $attributes = []): array

MentionEnhancer::enhance()

public function enhance(string|array|null $strOrArray, array $attributes = []): string|array|null

MentionEnhancerInterface interface

interface MentionEnhancerInterface MentionEnhancerInterface.php:6

MentionEnhancerInterface::getRepository()

public function getRepository(): MentionRepository

MentionEnhancerInterface::extractMentionees()

public function extractMentionees(string|array|null $strOrArray, array $attributes = []): array

MentionEnhancerInterface::enhance()

public function enhance(string|array|null $strOrArray, array $attributes = []): string|array|null

SemanticEnhancer class

class SemanticEnhancer implements SemanticEnhancerInterface SemanticEnhancer.php:7

SemanticEnhancer::__construct()

public function __construct(SemanticRepository $semanticRepository)

SemanticEnhancer::enhance()

public function enhance(string|array|null $strOrArray, null|array|string $words = null, array $attributes = []): string|array|null

SemanticEnhancerInterface interface

interface SemanticEnhancerInterface SemanticEnhancerInterface.php:5

SemanticEnhancerInterface::enhance()

public function enhance(string|array|null $strOrArray, null|array|string $words = null, array $attributes = []): string|array|null

Base\Service\Push

WebPushService class

class WebPushService WebPushService.php:25

Web Push delivery (RFC 8030 + VAPID) to the browsers a user enabled notifications in. The service is a no-op until VAPID keys are configured (VAPID_PUBLIC_KEY / VAPID_PRIVATE_KEY / VAPID_SUBJECT), so the rest of the notification center works without it - the in-app list, the badge - and push simply switches on the day the keys land in .env.local.

Generate a pair once per site with bin/console push:vapid (or VAPID::createVapidKeys()); rotating them invalidates every subscription, so treat them like a credential, not a config knob.

WebPushService::__construct()

public function __construct(protected readonly EntityManagerInterface $entityManager, protected readonly PushSubscriptionRepository $repository, protected readonly ?LoggerInterface $logger = null, protected readonly ?string $publicKey = null, protected readonly ?string $privateKey = null, protected readonly ?string $subject = null)

WebPushService::isConfigured()

public function isConfigured(): bool

WebPushService::getPublicKey()

public function getPublicKey(): ?string

WebPushService::createKeys()

public static function createKeys(): array

WebPushService::countReachableUsers()

public function countReachableUsers(): int

How many people would receive a push right now (one per user, however many browsers they enabled it in).

WebPushService::subscriptionsOf()

public function subscriptionsOf(User $user): array

WebPushService::subscribe()

public function subscribe(User $user, array $subscription, ?string $userAgent = null): PushSubscription

Registers (or refreshes) one browser's subscription for a user. The browser may re-send the same endpoint (page reload, permission re-prompt); that is an update, not a duplicate.

WebPushService::unsubscribe()

public function unsubscribe(User $user, string $endpoint): bool

WebPushService::sendToUsers()

public function sendToUsers(iterable $users, array $payload): int

Sends one payload to every browser of every given user. Returns the number of subscriptions accepted by their push service. Dead subscriptions (404/410: the browser revoked it) are deleted on the way.

Base\Service\Qr

QrCode class

class QrCode QrCode.php:16

A QR code for an address (or any text), drawn by endroid/qr-code: as SVG - sharp at any print size, the default - or PNG. Used by QrSheet for its pages, and directly for a poster or a ticket:

<img src="{{ qr_code(url('app_menu')) }}" alt="">

QrCode::svg()

public function svg(string $data, int $size = 600, int $margin = 0): string

The SVG markup.

QrCode::dataUri()

public function dataUri(string $data, int $size = 600, int $margin = 0, string $format = 'svg'): string

A data: URI to put in an <img src>: SVG, or PNG when asked (needs GD).

QrSheet class

class QrSheet QrSheet.php:22

QR codes laid out on A4 pages to print: one big code per page (a poster for a counter, a door, a table), or a sheet of Avery labels - each label a code and a caption, at the label's place on the sheet, in millimetres.

return new Response($sheet->render([ ['data' => $url, 'label' => 'Table 4'], ... ], 'L7160', 'Tables'));

Layouts (LAYOUTS): 'a4' one per page; Avery 'L7160' (21 labels of 63.5 x 38.1 mm), 'L7163' (14 of 99.1 x 38.1 mm), 'L7121' (20 squares of 45 x 45 mm, made for QR codes). The page prints at 100 % (no "fit to page") with @page margins of zero - the template sets both.

const LAYOUTS = ['a4' => ['width' => 210.0, 'height' => 297.0, 'columns' => 1, 'rows' => 1, 'top' => 0.0, 'left' => 0.0, 'pitchX' => 210.0, 'pitchY' => 297.0], 'L7160' => ['…

In millimetres: label size, columns x rows, the first label's top-left corner, the step from one label to the next.

QrSheet::__construct()

public function __construct(protected readonly QrCode $qr, protected readonly ?Environment $twig = null)

QrSheet::layout()

public static function layout(string $name): array

QrSheet::pages()

public function pages(iterable $items, string $layout = 'a4', int $skip = 0): array

The items placed on their pages: each label's position (mm) and its code as a data URI. $skip leaves the first labels of the first sheet empty - those already used on a sheet put back in the printer.

Returns

pages of labels

QrSheet::render()

public function render(iterable $items, string $layout = 'a4', ?string $title = null, int $skip = 0): string

The printable HTML page (@Base/qr/sheet.html.twig).

Base\Subscriber

AnalyticsSubscriber class

class AnalyticsSubscriber implements EventSubscriberInterface AnalyticsSubscriber.php:18

AnalyticsSubscriber::__construct()

public function __construct(TokenStorageInterface $tokenStorage, AdvancedRouterInterface $router, TranslatorInterface $translator, Environment $twig, UserRepository $userRepository, ?GaService $googleAnalyticsService = null)

AnalyticsSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

AnalyticsSubscriber::onUserRequest()

public function onUserRequest(RequestEvent $event)

AnalyticsSubscriber::onGoogleAnalyticsRequest()

public function onGoogleAnalyticsRequest(RequestEvent $event)

DemoBackOfficeSubscriber class

class DemoBackOfficeSubscriber implements EventSubscriberInterface DemoBackOfficeSubscriber.php:42

The back office in a demonstration (registered in the demo environment only): open to nobody with a password everyone knows. Two tiers, a secret each:

  • the super-administrator, never a demonstration account, and never signed in with the password the fixtures gave it ("glitchr" / "glitchr"): its password is base.demo.superadmin_password (DEMO_SUPERADMIN_PASSWORD by default);
  • an account that opens the back office (base.demo.admin_roles - the shop's, the practice's, declared as a demonstration account or not): its password is base.demo.admin_password (DEMO_ADMIN_PASSWORD by default), the one given to whoever is shown the back office.

What is typed is compared with the secret, the password stored in the database is not looked at. While a tier's secret is not set, its accounts cannot sign in at all, by any means.

And no other account opens the back office, whatever its roles give it elsewhere (the kitchen's ROLE_STAFF reading the orders under /admin): a page of it answers 403 to anyone signed in below base.demo.admin_roles.

DemoBackOfficeSubscriber::__construct()

public function __construct(readonly DemoAccountRegistry $accounts, readonly ?string $password = null, readonly ?string $adminPassword = null, readonly ?AdvancedRouterInterface $router = null, readonly ?TokenStorageInterface $tokens = null)

DemoBackOfficeSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

DemoBackOfficeSubscriber::onRequest()

public function onRequest(RequestEvent $event): void

DemoBackOfficeSubscriber::onCheckPassport()

public function onCheckPassport(CheckPassportEvent $event): void

DemoSubscriber class

class DemoSubscriber implements EventSubscriberInterface DemoSubscriber.php:24

Two of the demonstration's safeguards (registered in the demo environment only, config/services/demo.php):

  • no page of a demonstration is indexed: X-Robots-Tag: noindex, nofollow on every response;
  • no e-mail leaves it. Every message is refused where the mailer hands it over - as it is queued and as it is sent - whatever transport MAILER_DSN names: a visitor signed in as "patient" types any address in a form, and a demonstration must not write to it. What would have gone is logged (recipients and subject, not the body).

DemoSubscriber::__construct()

public function __construct(readonly ?LoggerInterface $logger = null)

DemoSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

DemoSubscriber::onResponse()

public function onResponse(ResponseEvent $event): void

DemoSubscriber::onMessage()

public function onMessage(MessageEvent $event): void

EntityDispatcherFlushSubscriber class

final class EntityDispatcherFlushSubscriber implements EventSubscriberInterface EntityDispatcherFlushSubscriber.php:19

Flushes what the entity dispatchers' listeners changed (a thread published by its "publishable" event, a user's welcome state...), once the flush that raised those events is completely over: when the response goes out, when a command ends, after each message a worker handles. See AbstractEventDispatcher::$flushPending for why not from postFlush.

EntityDispatcherFlushSubscriber::__construct()

public function __construct(readonly iterable $dispatchers)

EntityDispatcherFlushSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

EntityDispatcherFlushSubscriber::onResponse()

public function onResponse(ResponseEvent $event): void

EntityDispatcherFlushSubscriber::flush()

public function flush(): void

FlashBagSubscriber class

class FlashBagSubscriber implements EventSubscriberInterface FlashBagSubscriber.php:11

FlashBagSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

FlashBagSubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event)

HotParameterBagSubscriber class

class HotParameterBagSubscriber implements EventSubscriberInterface HotParameterBagSubscriber.php:14

HotParameterBagSubscriber::__construct()

public function __construct($parameterBag, SettingBagInterface $settingBag)

HotParameterBagSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

HotParameterBagSubscriber::onRequest()

public function onRequest($event)

IntegritySubscriber class

class IntegritySubscriber implements EventSubscriberInterface IntegritySubscriber.php:36

const DEFAULT_PRIORITY = 7

IntegritySubscriber::__construct()

public function __construct(TokenStorageInterface $tokenStorage, RequestStack $requestStack, ManagerRegistry $doctrine, AdvancedRouterInterface $router, ReferrerInterface $referrer, string $projectDir, ?string $secret = null)

IntegritySubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

IntegritySubscriber::checkCacheReady()

public function checkCacheReady()

IntegritySubscriber::onCommand()

public function onCommand(ConsoleEvent $event)

IntegritySubscriber::onEarlyKernelRequest()

public function onEarlyKernelRequest()

IntegritySubscriber::onException()

public function onException(ExceptionEvent $event)

IntegritySubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

IntegritySubscriber::checkUserIntegrity()

public function checkUserIntegrity()

IntegritySubscriber::checkDoctrineIntegrity()

public function checkDoctrineIntegrity()

IntegritySubscriber::checkSecretIntegrity()

public function checkSecretIntegrity()

IsGrantedSubscriber class

class IsGrantedSubscriber implements EventSubscriberInterface IsGrantedSubscriber.php:21

IsGrantedSubscriber::__construct()

public function __construct(AttributeReader $attributeReader, ?AuthorizationCheckerInterface $authorizationChecker = null)

IsGrantedSubscriber::onKernelControllerArguments()

public function onKernelControllerArguments(KernelEvent $event)

IsGrantedSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

LocalizerSubscriber class

class LocalizerSubscriber implements EventSubscriberInterface LocalizerSubscriber.php:20

const __LANG_IDENTIFIER__ = "LANG"
const __TIMEZONE_IDENTIFIER__ = "TIMEZONE"
const DISPLAYED_LOCALE = "_base_displayed_locale"

The request attribute holding the language a page was shown in, for the response to remember.

const REQUEST_DEFAULT_LANGUAGE = "en-us,en;q=0.5"

What Symfony's Request::create() says when it is told no language.

LocalizerSubscriber::__construct()

public function __construct(LocalizerInterface $localizer, AdvancedRouterInterface $router, TokenStorageInterface $tokenStorage)

LocalizerSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

LocalizerSubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event): void

The language the page was shown in, remembered for the next one (LANG).

LocalizerSubscriber::onSwitchUser()

public function onSwitchUser(SwitchUserEvent $event): void

LocalizerSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

The language of a page: its address (a route of one language, "/en/..." or "/datenschutz"), else the visitor's own choice or the language their last page was shown in (the LANG cookie, which the response keeps up to date), else a signed-in member's, else - on a first visit only - the browser's (Accept-Language), else the site's.

The browser's language used to be read on every page from the USER/INFO cookie, which the site's script writes after the first one: a visitor who arrived on a French page, or chose French, was moved to their browser's language from the second page on.

MailTrapSubscriber class

class MailTrapSubscriber implements EventSubscriberInterface MailTrapSubscriber.php:19

Stops mail at the last possible moment when the trap is armed.

MessageEvent fires twice for a queued message: once as it is handed to Messenger (isQueued() true) and again when the worker actually sends it. Only the second one is intercepted, and that is the whole point - trapping at queue time would refuse mail that a released trap should still deliver, while trapping at send time means a message queued before the incident is still caught on its way out.

MailTrapSubscriber::__construct()

public function __construct(readonly MailTrap $trap)

MailTrapSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

MailTrapSubscriber::onMessage()

public function onMessage(MessageEvent $event): void

NewDeviceSubscriber class

class NewDeviceSubscriber implements EventSubscriberInterface NewDeviceSubscriber.php:30

Reacts to an account being signed into from a browser it has not been signed into before: tells the user by email (administrator's switch), and on an account with no second factor, flags the session so the next page offers - once, optionally - to set up a one-time code (SecurityEnrolmentSubscriber, UserSettingsController::Enrolment).

"Browser" here means what UserTracker already means by it: a Connection, keyed by the long-lived id it keeps in a cookie. A sign-in that has to create one is a sign-in from somewhere new. The account's very first sign-in creates one too, and there is nothing useful to warn about then - the person is holding the device in their hand - so the mail goes out only once a second browser appears.

Nothing here blocks the login. This is a notice after the fact, not a challenge; the administrator's switch decides whether it is sent at all.

NewDeviceSubscriber::__construct()

public function __construct(SecurityPolicy $securityPolicy, UserTracker $userTracker, ConnectionRepository $connectionRepository)

NewDeviceSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

NewDeviceSubscriber::onLoginSuccess()

public function onLoginSuccess(LoginSuccessEvent $event): void

NotifierSubscriber class

class NotifierSubscriber implements EventSubscriberInterface NotifierSubscriber.php:15

NotifierSubscriber::__construct()

public function __construct(Notifier $notifier, AuthorizationCheckerInterface $authorizationChecker, ParameterBagInterface $parameterBag, string $debug)

NotifierSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

NotifierSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

PageViewSubscriber class

class PageViewSubscriber implements EventSubscriberInterface PageViewSubscriber.php:35

Records one Base\Service\Analytics::track() call per trackable request.

Runs on kernel.terminate (after the response has already been sent) so the counter writes never add latency to what the visitor is waiting on.

Not to be confused with the pre-existing Base\Subscriber\AnalyticsSubscriber (an unrelated, currently-inert - gated behind the now-dead isAdmin() check - "online users" heartbeat + Google Analytics live-stats puller). That one is untouched by this; naming this class PageViewSubscriber specifically to avoid colliding with it.

"Trackable" is deliberately inferred from the RESPONSE rather than matched against a path allow/deny list: a successful, GET, text/html response is a real page render regardless of whether it arrived via a normal navigation or one of transparentJS's AJAX SPA-swap fetches (both return full HTML documents with that content type) - excluding XHR requests outright would have undercounted most of this app's actual navigation, since in-app browsing mostly happens through those swaps, not full page loads. $excludedPrefixes is the one thing that IS explicitly configured (bound in services.php) - keeps admin/API/asset traffic out of what's meant to be public-site analytics.

PageViewSubscriber::__construct()

public function __construct(readonly Analytics $analytics, readonly Security $security, readonly array $excludedPrefixes = ["/admin", "/_", "/api"])

PageViewSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

PageViewSubscriber::onKernelTerminate()

public function onKernelTerminate(TerminateEvent $event): void

PasswordChangeSubscriber class

class PasswordChangeSubscriber implements EventSubscriberInterface PasswordChangeSubscriber.php:21

An account made with a password it did not choose (user:create) carries a "change-password" token: until its owner has chosen one, every page sends them to security_changePassword.

As narrow as SecurityEnrolmentSubscriber, for the same reason: only a plain top-level GET of an HTML page is turned back, never the pages needed to answer - the change itself, logging out, the profiler.

const TOKEN = 'change-password'

PasswordChangeSubscriber::__construct()

public function __construct(Security $security, UrlGeneratorInterface $router)

PasswordChangeSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

PasswordChangeSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event): void

ProfilerSubscriber class

class ProfilerSubscriber implements EventSubscriberInterface ProfilerSubscriber.php:13

ProfilerSubscriber::__construct()

public function __construct(AdvancedRouterInterface $router)

ProfilerSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

ProfilerSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

ProfilerSubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event)

RedirectionSubscriber class

class RedirectionSubscriber implements EventSubscriberInterface RedirectionSubscriber.php:21

A page that is not found is looked up in the redirections (Base\Entity\Layout\Redirection) before the 404 is answered: the old addresses of a site taken over lead to its new pages.

Only then - no route matched, or a controller found no record: a page the site answers is never redirected, and costs no query. Ahead of the listeners that log and render the error (priority 16), so a redirected address is not reported as an error.

RedirectionSubscriber::__construct()

public function __construct(readonly Redirections $redirections)

RedirectionSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

RedirectionSubscriber::onKernelException()

public function onKernelException(ExceptionEvent $event): void

ReferrerSubscriber class

class ReferrerSubscriber implements EventSubscriberInterface ReferrerSubscriber.php:29

Where a visitor comes back to after signing in: the last page they read.

Only a page is remembered - a GET answered 2xx with an HTML document, asked as a document (Sec-Fetch-Dest: document or iframe) or by flowjs's navigation swap (an XHR whose answer is a whole HTML page, as omnibase's PageViewSubscriber counts it). An image, a stylesheet, a feed, a JSON or an HTML fragment fetched by a script is not: an avatar served by a controller used to be the last thing asked before the sign-in, and the sign-in sent the visitor to that SVG (seen on chapaland). Nor is a speculative fetch, a route of base.access_restriction.route_exceptions (the sign-in pages themselves...) or a secured page.

ReferrerSubscriber::__construct()

public function __construct(protected ReferrerInterface $referrer, protected AdvancedRouterInterface $router, protected ParameterBagInterface $parameterBag)

ReferrerSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

ReferrerSubscriber::getCurrentRouteName()

public function getCurrentRouteName($event)

ReferrerSubscriber::isException()

public function isException(?string $route): bool

ReferrerSubscriber::isPageNavigation()

public static function isPageNavigation(Request $request, Response $response): bool

Whether this request and its answer are a page the visitor read.

ReferrerSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

ReferrerSubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event): void

RequestScopedStateSubscriber class

class RequestScopedStateSubscriber implements EventSubscriberInterface, ResetInterface RequestScopedStateSubscriber.php:32

Clears static state that is really request-scoped, for processes that outlive a request: FrankenPHP worker mode and messenger consumers.

Under FPM, or FrankenPHP classic mode, statics die with the request anyway and both hooks below are no-ops on already-empty state.

Two hooks, because neither covers every mode on its own:

  • kernel.reset (reset()): the services_resetter runs between requests handled by the SAME kernel, and messenger resets services between messages. But under FRANKENPHP_RESET_KERNEL=1 the kernel is cloned after each request: Kernel::__clone() sets resetServices back to false and the clone boots a fresh container, so the resetter never runs at all - while class statics survive the clone untouched.
  • kernel.request, main request only, top priority: fires in every mode, cloned kernel included, and ahead of LocalizerSubscriber (priority 8) and anything else that reads this state.
const PRIORITY = 4096

RequestScopedStateSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

RequestScopedStateSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event): void

RequestScopedStateSubscriber::reset()

public function reset(): void

RouterSubscriber class

class RouterSubscriber implements EventSubscriberInterface RouterSubscriber.php:15

RouterSubscriber::__construct()

public function __construct(AuthorizationCheckerInterface $authorizationChecker, RouterInterface $router, ParameterBagInterface $parameterBag)

RouterSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

RouterSubscriber::onCommand()

public function onCommand(ConsoleEvent $event): void

RouterSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

SecondLevelCacheConsoleSubscriber class

class SecondLevelCacheConsoleSubscriber implements EventSubscriberInterface SecondLevelCacheConsoleSubscriber.php:18

Doctrine's second-level cache emptied after a command that rewrites the database behind the ORM's back: doctrine:fixtures:load purges the tables with DELETE / TRUNCATE and numbers the new rows from 1 again, so the cache went on answering yesterday's entity for today's id (a product under another one's name, a deleted page still shown) until it expired.

const COMMANDS = ['doctrine:fixtures:load', 'doctrine:schema:drop', 'doctrine:schema:create', 'doctrine:schema:update', 'doctrine:database:drop', 'doctrine:database:import', …

The commands after which the cached entities may no longer be the database's.

SecondLevelCacheConsoleSubscriber::__construct()

public function __construct(readonly ?ManagerRegistry $doctrine = null)

SecondLevelCacheConsoleSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

SecondLevelCacheConsoleSubscriber::onTerminate()

public function onTerminate(ConsoleTerminateEvent $event): void

SecondLevelCacheConsoleSubscriber::evict()

public function evict(): int

Every region of every entity manager that has a second-level cache; the number of managers emptied.

SecurityEnrolmentSubscriber class

class SecurityEnrolmentSubscriber implements EventSubscriberInterface SecurityEnrolmentSubscriber.php:27

Sends a signed-in user to the enrolment prompt once, when a second factor is mandatory for this account - the administrator made it so for everyone, or the application requires it of one of the account's roles (base.security.two_factor.required_roles) - and the account has none.

The redirect is deliberately narrow. It only ever happens on a plain top-level GET of an HTML page, so nothing in-flight is interrupted: a form post lands where it was going, an XHR gets its JSON, a download downloads. And it never fires on the pages the user needs in order to *answer* it - the settings pages, the login and logout paths, the two-factor check itself. Getting that list wrong would lock the account out of the site with no way back in, so the exemptions err generously.

SecurityEnrolmentSubscriber::__construct()

public function __construct(SecurityPolicy $securityPolicy, Security $security, UrlGeneratorInterface $router)

SecurityEnrolmentSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

SecurityEnrolmentSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event): void

SecuritySubscriber class

class SecuritySubscriber implements EventSubscriberInterface SecuritySubscriber.php:38

SecuritySubscriber::__construct()

public function __construct(UserRepository $userRepository, AuthorizationChecker $authorizationChecker, TokenStorageInterface $tokenStorage, RequestStack $requestStack, ReferrerInterface $referrer, SettingBagInterface $settingBag, Localizer $localizer, AdvancedRouterInterface $router, ParameterBagInterface $parameterBag, MaintenanceProviderInterface $maintenanceProvider, LauncherInterface $launcher, ?Profiler $profiler = null)

SecuritySubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

SecuritySubscriber::onAccessRequest()

public function onAccessRequest(?RequestEvent $event = null): bool

SecuritySubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

SecuritySubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event)

SecuritySubscriber::onLoginFailure()

public function onLoginFailure(LoginFailureEvent $event)

SecuritySubscriber::onLoginSuccess()

public function onLoginSuccess(LoginSuccessEvent $event)

SecuritySubscriber::onLogout()

public function onLogout(LogoutEvent $event)

SecuritySubscriber::onMaintenanceRequest()

public function onMaintenanceRequest(RequestEvent $event)

SecuritySubscriber::onLaunchRequest()

public function onLaunchRequest(RequestEvent $event)

TemplatedEmailSubjectSubscriber class

class TemplatedEmailSubjectSubscriber implements EventSubscriberInterface TemplatedEmailSubjectSubscriber.php:26

A TemplatedEmail's subject written in its template:

{% block subject %}{{ 'booking.email.subject'|trans({date: date}) }}{% endblock %}

omnibase's e-mail templates name their subject that way, and a notification reads it. A plain TemplatedEmail sent through Symfony's mailer did not: the block was rendered in the body and the message left without a subject. Here the block is rendered with the e-mail's context and becomes the subject, before the body is rendered.

A subject set in PHP (->subject('...')) is kept: it is also handed to the template as the subject variable, which omnibase's frame prints instead of the block.

TemplatedEmailSubjectSubscriber::__construct()

public function __construct(readonly Environment $twig)

TemplatedEmailSubjectSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

TemplatedEmailSubjectSubscriber::onMessage()

public function onMessage(MessageEvent $event): void

TwigSubscriber class

class TwigSubscriber implements EventSubscriberInterface TwigSubscriber.php:18

const INJECT = '_omnibase_inject'

The request attribute (a route default) that keeps a response as it was rendered.

TwigSubscriber::__construct()

public function __construct(HtmlTagRenderer $htmlTagRenderer, WebpackTagRenderer $webpackTagRenderer, AuthorizationCheckerInterface $authorizationChecker, ParameterBag $parameterBag, AdvancedRouterInterface $router)

TwigSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

TwigSubscriber::onKernelException()

public function onKernelException(RequestEvent $event)

TwigSubscriber::onKernelRequest()

public function onKernelRequest(RequestEvent $event)

TwigSubscriber::onKernelResponse()

public function onKernelResponse(ResponseEvent $event)
Throws

Exception

ValidCacheSubscriber class

class ValidCacheSubscriber implements EventSubscriberInterface ValidCacheSubscriber.php:17

Marks the bundle cache as valid early in the request cycle. Sole survivor of the former EagerSubscriber: its eager-construction duty is obsolete now that AttributeReader's constructor is metadata-free (the heavy precompute moved to AttributeCacheWarmer) and BaseTrait statics resolve lazily through the base.runtime locator.

ValidCacheSubscriber::getSubscribedEvents()

public static function getSubscribedEvents(): array

ValidCacheSubscriber::onValidCache()

public function onValidCache(KernelEvent $e)

Base\Traits

BagTrait trait

trait BagTrait BagTrait.php:7

BagTrait::read()

public static function read(?string $path, array $bag = [])
Throws

Exception

BagTrait::write()

public static function write($path, $value, array &$bag = [])

BaseCommonTrait trait

trait BaseCommonTrait BaseCommonTrait.php:28

BaseCommonTrait::setRuntime()

public static function setRuntime(?RuntimeLocatorInterface $runtime): void

Installing a DIFFERENT locator means a different kernel, and everything memoised from the previous one (by runtimeGet() or by an eagerly built BaseService's set*() calls) belongs to a container that is gone. Those statics are cleared, so every accessor re-resolves lazily from the new kernel - the process then behaves exactly like a fresh first boot.

Without this, a second kernel in the same process silently ran on the FIRST kernel's services. It never shows in production (an FPM request or a messenger worker boots once), but any process that boots twice does - a PHPUnit run of several KernelTestCase tests that persist entities failed three different ways at once: "The kernel service is synthetic", "Undefined array key preQuery" (a dead event manager), and "Column uuid cannot be null" (GenerateUuid wired to the old one).

The first installation (from null) resets nothing: there is nothing stale yet, and values pre-filled before it must survive. Re-installing the SAME locator resets nothing either.

projectDir/environment are reset too; BaseBundle::boot() re-seeds both right after calling this.

BaseCommonTrait::runtimeGet()

public static function runtimeGet(string $property, string $serviceId)

Resolve a static property, lazily pulling the backing service from the runtime locator on first access. Memoizes into the static property, so each service is resolved at most once per RUNTIME (per kernel; see setRuntime(), which clears these when a new kernel boots) — and an eagerly constructed BaseService (which still calls the set*() methods) simply pre-fills the same properties.

BaseCommonTrait::hasInstance()

public function hasInstance()

BaseCommonTrait::getInstance()

public function getInstance()

BaseCommonTrait::setInstance()

public function setInstance($instance)

BaseCommonTrait::setProjectDir()

public static function setProjectDir($projectDir)

BaseCommonTrait::setEnvironment()

public static function setEnvironment(?string $environment)

BaseCommonTrait::setTranslator()

public static function setTranslator(?TranslatorInterface $translator)

BaseCommonTrait::setRequestStack()

public static function setRequestStack(RequestStack $requestStack)

BaseCommonTrait::setObfuscator()

public static function setObfuscator(Obfuscator $obfuscator)

BaseCommonTrait::setDoctrine()

public static function setDoctrine(ManagerRegistry $doctrine)

BaseCommonTrait::setEntityHydrator()

public static function setEntityHydrator(EntityHydratorInterface $entityHydrator)

BaseCommonTrait::setLocalizer()

public static function setLocalizer(?LocalizerInterface $localizer)

BaseCommonTrait::setTrading()

public static function setTrading(?TradingInterface $tradingMarket)

BaseCommonTrait::setTokenStorage()

public static function setTokenStorage(?TokenStorageInterface $tokenStorage)

BaseCommonTrait::setSlugger()

public static function setSlugger(?SluggerInterface $slugger)

BaseCommonTrait::setIconProvider()

public static function setIconProvider(?IconProvider $iconProvider)

BaseCommonTrait::setClassMetadataManipulator()

public static function setClassMetadataManipulator(?ClassMetadataManipulator $classMetadataManipulator)

BaseCommonTrait::setMediaService()

public static function setMediaService(?MediaServiceInterface $mediaService)

BaseCommonTrait::setFirewallMap()

public static function setFirewallMap(?FirewallMapInterface $firewallMap)

BaseCommonTrait::setRouter()

public static function setRouter(AdvancedRouterInterface $router)

BaseCommonTrait::setTwig()

public static function setTwig(Environment $twig)

BaseCommonTrait::setSettingBag()

public static function setSettingBag(SettingBagInterface $settings)

BaseCommonTrait::setParameterBag()

public static function setParameterBag(ParameterBagInterface $parameterBag)

BaseCommonTrait::setNotifier()

public static function setNotifier(NotifierInterface $notifier)

BaseTrait trait

trait BaseTrait BaseTrait.php:39

Static service accessors usable from anywhere (entities, attributes, subscribers, ...). Backed by BaseService's static properties, which are populated EITHER eagerly by BaseService's constructor (when something actually injects it) OR lazily, one service at a time, through the base.runtime ServiceLocator seeded in BaseBundle::boot() — see BaseCommonTrait::runtimeGet(). Nothing here forces BaseService's full dependency graph to be built anymore.

BaseTrait::getAttributeReader()

public static function getAttributeReader(): ?AttributeReader

BaseTrait::getService()

public static function getService(): ?BaseService

BaseTrait::getSettingBag()

public static function getSettingBag(): ?SettingBag

BaseTrait::getDoctrine()

public static function getDoctrine(): ?ManagerRegistry

BaseTrait::getObjectManager()

public static function getObjectManager(mixed $entity): ?ObjectManager

BaseTrait::getEntityManager()

public static function getEntityManager(bool $reopen = false): ?EntityManagerInterface

BaseTrait::getRepository()

public static function getRepository(mixed $object = null): ?ObjectRepository

BaseTrait::isEntity()

public static function isEntity(mixed $entityOrClassOrMetadata): ?bool

BaseTrait::getProjectDir()

public static function getProjectDir(): string

BaseTrait::getEnvironment()

public static function getEnvironment(): string

BaseTrait::getPublicDir()

public static function getPublicDir(): string

BaseTrait::getTemplateDir()

public static function getTemplateDir(): string

BaseTrait::getTranslationDir()

public static function getTranslationDir(): string

BaseTrait::getCacheDir()

public static function getCacheDir(): string

BaseTrait::getLogDir()

public static function getLogDir(): string

BaseTrait::getDataDir()

public static function getDataDir(): string

BaseTrait::getFixtureDir()

public static function getFixtureDir(): string

BaseTrait::getClassMetadataManipulator()

public static function getClassMetadataManipulator(): ?ClassMetadataManipulator

BaseTrait::getTokenStorage()

public static function getTokenStorage(): ?TokenStorageInterface

BaseTrait::getRequestStack()

public static function getRequestStack(): ?RequestStack

BaseTrait::getEntityHydrator()

public static function getEntityHydrator(): ?EntityHydrator

BaseTrait::getMediaService()

public static function getMediaService(): ?MediaService

BaseTrait::getObfuscator()

public static function getObfuscator(): ?Obfuscator

BaseTrait::getIconProvider()

public static function getIconProvider(): ?IconProvider

BaseTrait::getLocalizer()

public static function getLocalizer(): ?LocalizerInterface

BaseTrait::getRouter()

public static function getRouter(): ?AdvancedRouterInterface

BaseTrait::getFirewallMap()

public static function getFirewallMap(): ?FirewallMapInterface

BaseTrait::getTwig()

public static function getTwig(): ?Environment

BaseTrait::getNotifier()

public static function getNotifier(): ?BaseNotifierInterface

BaseTrait::getTranslator()

public static function getTranslator(): ?TranslatorInterface

BaseTrait::getSlugger()

public static function getSlugger(): ?SluggerInterface

BaseTrait::getTrading()

public static function getTrading(): ?TradingInterface

BaseTrait::getParameterBag()

public static function getParameterBag(string $key = "", ?array $bag = null)

CacheClearTrait trait

trait CacheClearTrait CacheClearTrait.php:13

CacheableTrait trait

trait CacheableTrait CacheableTrait.php:5

CacheableTrait::__toKey()

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

CacheableTrait::__toKeyTTL()

public function __toKeyTTL(): ?int

CacheableTrait::__toKeyTags()

public function __toKeyTags(): array

ProxyTrait trait

trait ProxyTrait ProxyTrait.php:8

ProxyTrait::hasProxy()

public function hasProxy(): bool

ProxyTrait::getProxy()

public function getProxy(): ?object

ProxyTrait::setProxy()

public function setProxy(object $proxy)

ProxyTrait::__call()

public function __call(string $methodOrProperty, array $arguments)
Throws

Exception

SimpleCacheTrait trait

trait SimpleCacheTrait SimpleCacheTrait.php:11

SimpleCacheTrait::__construct()

public function __construct(string $cacheDir, ?string $buildDir = null)

SimpleCacheTrait::hasCache()

public function hasCache(string $key): bool

SimpleCacheTrait::deleteCache()

public function deleteCache(?string $key = null): bool

SimpleCacheTrait::getCacheAdapter()

public function getCacheAdapter(): mixed

SimpleCacheTrait::invalidateCache()

public function invalidateCache(?string $key = null): self

SimpleCacheTrait::getCache()

public function getCache(?string $key = null, mixed $fallback = null, int|DateInterval|null $ttl = null, $deferred = false): mixed
Throws

InvalidArgumentException

SimpleCacheTrait::setCache()

public function setCache(CacheItemPoolInterface|string $cacheOrKey, mixed $value = null, int|DateInterval|null $ttl = null, bool $deferred = false)
Throws

Psr\Cache\InvalidArgumentException

SimpleCacheTrait::commitCache()

public function commitCache()

SimpleCacheTrait::executeOnce()

public function executeOnce(callable $fn, int|DateInterval|null $ttl = null): mixed

SingletonTrait trait

trait SingletonTrait SingletonTrait.php:8

SingletonTrait::hasInstance()

public static function hasInstance()

SingletonTrait::setInstance()

public static function setInstance($instance)

SingletonTrait::getInstance()

public static function getInstance(bool $instanciateIfNotFound = true): ?self

SingletonTrait::__clone()

public function __clone()

SingletonTrait::__sleep()

public function __sleep()

SingletonTrait::__wakeup()

public function __wakeup()

UserInfoTrait trait

trait UserInfoTrait UserInfoTrait.php:8

const __COOKIE_IDENTIFIER__ = "USER/INFO"
const __TIMEZONE_IDENTIFIER__ = "LOCATION/TIMEZONE"

The time zone, where the visitor answers for it apart (the LOCATION category of the page's script, assets/styles/js/user.js).

UserInfoTrait::getCookie()

public static function getCookie(?string $key = null)

What the page's script wrote of the visitor's browser: its language, calendar, light or dark theme (USER/INFO), its time zone (LOCATION/TIMEZONE, else USER/INFO's "timezone") and, read from that zone, its country. Nothing is written here: the cookies are the visitor's to accept or refuse, and the script's to write.

UserInfoTrait::setCookie()

public static function setCookie(string $key, $value, int $lifetime = 0)

UserInfoTrait::getAgent()

public static function getAgent(): ?string

UserInfoTrait::getIp()

public static function getIp(): ?string

UserInfoTrait::getCountryCode()

public function getCountryCode(): ?string

UserInfoTrait::getTimezone()

public function getTimezone(): string

UserInfoTrait::setTimezone()

public function setTimezone(?string $timezone = null): self

Base\Translation

OverridingTranslator class

class OverridingTranslator implements TranslatorInterface, TranslatorBagInterface, LocaleAwareInterface, ResetInterface OverridingTranslator.php:27

The site's texts as the team rewrote them in the back office (Base\Entity\Layout\TextOverride, omnibase/admin's "Textes du site"): a rewritten key, in that language, wins over translations/. Between omnibase's translator (which resolves "@messages.key" and falls back between languages) and Symfony's: it sees a plain key and domain, and only answers when it has something.

The rewritten texts are read once per request from the cache - the shared Redis pool (cache.redis) when the application has one, so the web, the worker and cron agree; TextOverrideCacheListener empties it when one changes. Moved here from the apps' App\Translation\OverridingTranslator.

const CACHE_KEY = 'base.text_overrides'

OverridingTranslator::__construct()

public function __construct(protected readonly TranslatorInterface&TranslatorBagInterface&LocaleAwareInterface $inner, protected readonly \Closure $overrides, protected readonly CacheItemPoolInterface $cache)

OverridingTranslator::trans()

public function trans(?string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string

OverridingTranslator::isRewritten()

public function isRewritten(string $id, ?string $domain = null, ?string $locale = null): bool

Whether the team rewrote this key in that language. omnibase's translator asks it when a level of politeness is set (base.translator.politeness): a text rewritten at its base wins over a variant of the files, and a rewritten variant ("key._polite") is one.

OverridingTranslator::getCatalogue()

public function getCatalogue(?string $locale = null): MessageCatalogueInterface

OverridingTranslator::getCatalogues()

public function getCatalogues(): array

OverridingTranslator::setLocale()

public function setLocale(string $locale): void

OverridingTranslator::getLocale()

public function getLocale(): string

OverridingTranslator::getFallbackLocales()

public function getFallbackLocales(): array

The languages after the default one (framework.translator.fallbacks): asked by name - method_exists(), which __call does not answer - by the translator above (the profiler's) and through it by omnibase's Localizer.

OverridingTranslator::__call()

public function __call(string $method, array $arguments): mixed

What the inner translator offers beyond the interfaces.

OverridingTranslator::reset()

public function reset(): void

OverridingTranslator::invalidate()

public function invalidate(): void

Forget the rewritten texts: the next call reads them again.

TextOverrideCacheListener class

class TextOverrideCacheListener TextOverrideCacheListener.php:16

A rewritten text saved or deleted: the next page reads them all again.

Noted on the row's events, cleared once the flush is over (postFlush): cleared inside it, before the commit, a page read in between would put the old texts back in the cache.

TextOverrideCacheListener::__construct()

public function __construct(protected readonly \Closure $translator)
$translator

lazy: a Doctrine listener is built while Doctrine starts

TextOverrideCacheListener::postPersist()

public function postPersist(LifecycleEventArgs $args): void

TextOverrideCacheListener::postUpdate()

public function postUpdate(LifecycleEventArgs $args): void

TextOverrideCacheListener::postRemove()

public function postRemove(LifecycleEventArgs $args): void

TextOverrideCacheListener::postFlush()

public function postFlush(PostFlushEventArgs $args): void

Base\Twig

AppVariable class

class AppVariable AppVariable.php:21

public ReferrerInterface $referrer
public Environment $twig
public SettingBagInterface $settingBag
public ParameterBagInterface $parameterBag
public SiteVariable $site
public RandomVariable $random
public EmailVariable $email
public AdminVariable $admin
public LocalizerInterface $localizer
public ThemizerInterface $themizer

AppVariable::__construct()

public function __construct(SymfonyAppVariable $appVariable, RandomVariable $random, SiteVariable $site, EmailVariable $email, AdminVariable $admin, SettingBag $settingBag, ParameterBagInterface $parameterBag, ReferrerInterface $referrer, Environment $twig, LocalizerInterface $localizer, ThemizerInterface $themizer)

AppVariable::getGlobals()

public function getGlobals()
Throws

Exception

AppVariable::bag()

public function bag(?string $key = null, ?array $bag = null)

AppVariable::settings()

public function settings()
Throws

Exception

AppVariable::referrer()

public function referrer()

AppVariable::locale()

public function locale()

AppVariable::theme()

public function theme()

AssetPackage class

class AssetPackage implements PackageInterface AssetPackage.php:20

This defines a Symfony Asset named package that groups all the assets provided by EasyAdmin. This is needed because EasyAdmin uses asset versioning, so the full absolute URLs of assets isn't known (the URL contain changing hashes).

In practice this uses the same strategy (and even the same "manifest.json" file) used by Webpack Encore. We do this because we want to keep EasyAdmin dependencies as lean as possible, so we don't want to require Webpack Encore to use EasyAdmin.

const PACKAGE_NAME = 'base.assets.package'

AssetPackage::__construct()

public function __construct(RequestStack $requestStack)

AssetPackage::getBasePath()

public function getBasePath(): string

AssetPackage::stripPrefix()

public function stripPrefix(string $path): string

AssetPackage::getUrl()

public function getUrl(string $path): string

AssetPackage::getVersion()

public function getVersion(string $path): string

Environment class

class Environment extends TwigEnvironment Environment.php:17

Environment::__construct()

public function __construct(LoaderInterface $loader, array $options, RequestStack $requestStack, LocalizerInterface $localizer, AdvancedRouterInterface $router, ParameterBagInterface $parameterBag)

Environment::getParameter()

public function getParameter(string $name = '')

Environment::addGlobal()

public function addGlobal(string $name, $value): bool

Environment::hasParameter()

public function hasParameter(string $name)

Environment::setParameter()

public function setParameter(string $name, $value)

Environment::addParameter()

public function addParameter(string $name, $newValue)
Throws

Exception

Environment::appendParameter()

public function appendParameter($name, $value)
Throws

Exception

Environment::addRenderer()

public function addRenderer(TagRendererInterface $renderer)

Environment::getRenderer()

public function getRenderer(string $className): ?TagRendererInterface

Environment::getAsset()

public function getAsset(string $url): string

Environment::render()

public function render($name, array $context = []): string
Throws

LoaderError

Throws

RuntimeError

Throws

SyntaxError

Globals class

class Globals extends AbstractExtension implements GlobalsInterface Globals.php:11

Globals::__construct()

public function __construct(BaseService $base, AppVariable $app, RandomVariable $random)

Globals::getGlobals()

public function getGlobals(): array

Base\Twig\Extension

AccountTwigExtension class

final class AccountTwigExtension extends AbstractExtension AccountTwigExtension.php:18

account_profile(user): a member's profile as its view model (Base\Screen\Account\ProfilePage), as the visitor asking sees it - what a host page gives the core's profile template when it renders it with the user alone (lesringostars' /profile/of/{username}: @Base/client/user/profile_show.html.twig with {user}), so that the template reads its screen whoever renders it (plan "omnibase agnostique", C5). Answered by the AccountScreens runtime.

AccountTwigExtension::getFunctions()

public function getFunctions(): array

AnalyticsTwigExtension class

final class AnalyticsTwigExtension extends AbstractExtension AnalyticsTwigExtension.php:15

Thin Twig-side wrapper around Base\Service\Analytics - lets any template (the admin sidebar widget, a future public "N readers this week" badge, ...) reach the counters directly, without every consumer needing its own controller/Twig-global plumbing just to display a number.

AnalyticsTwigExtension::__construct()

public function __construct(readonly Analytics $analytics)

AnalyticsTwigExtension::getFunctions()

public function getFunctions(): array

AnalyticsTwigExtension::pageViews()

public function pageViews(?string $path = null, ?string $window = null, ?string $source = null): int

{{ analytics_page_views() }} - site-wide, all-time {{ analytics_page_views(window: '7d') }} - site-wide, last 7 days {{ analytics_page_views(app.request.pathInfo, 'today') }} - this page, today {{ analytics_page_views(window: '7d', source: 'ai') }} - AI crawler hits only, last 7 days

AnalyticsTwigExtension::uniqueVisitors()

public function uniqueVisitors(?string $window = null): int

{{ analytics_unique_visitors('30d') }}

AnalyticsTwigExtension::uniqueUsers()

public function uniqueUsers(?string $window = null): int

{{ analytics_unique_users('today') }}

AnalyticsTwigExtension::summary()

public function summary(): array

{% set stats = analytics_summary() %} {{ stats.today.pageViews }} / {{ stats['7d'].uniqueVisitors }} / .

..

AnalyticsTwigExtension::dailyBreakdown()

public function dailyBreakdown(?int $days = 14): array

{% set series = analytics_daily_breakdown(14) %} {% set series = analytics_daily_breakdown(null) %} - all time

AnalyticsTwigExtension::weekOverWeekChange()

public function weekOverWeekChange(): array

{% set change = analytics_week_over_week_change() %} {{ change.pageViews }}% vs last week

BreadgrinderTwigExtension class

final class BreadgrinderTwigExtension extends AbstractExtension BreadgrinderTwigExtension.php:11

BreadgrinderTwigExtension::__construct()

public function __construct(BreadgrinderInterface $breadgrinder)

BreadgrinderTwigExtension::getName()

public function getName()

BreadgrinderTwigExtension::getFunctions()

public function getFunctions(): array

BreadgrinderTwigExtension::renderBreadcrumb()

public function renderBreadcrumb(Environment $twig, string $name, Request $request, array $options = []): ?string

ClassTwigExtension class

final class ClassTwigExtension extends AbstractExtension ClassTwigExtension.php:11

ClassTwigExtension::getFunctions()

public function getFunctions(): array

ClassTwigExtension::getName()

public function getName()

ClassTwigExtension::getShortClass()

public function getShortClass($object)

ClipboardTwigExtension class

final class ClipboardTwigExtension extends AbstractExtension ClipboardTwigExtension.php:9

ClipboardTwigExtension::getName()

public function getName()

ClipboardTwigExtension::getFunctions()

public function getFunctions(): array

ClipboardTwigExtension::clipboard()

public function clipboard(Environment $twig, string $template, ?string $value, array $attributes = []): ?string

ClipboardTwigExtension::clipboard_target()

public function clipboard_target(Environment $twig, string $template, ?string $target, array $attributes = []): ?string

CommonsTwigExtension class

class CommonsTwigExtension extends AbstractExtension CommonsTwigExtension.php:25

The shared bricks, in a template (docs/40-commons):

embed_url(url) what a page can frame of an address (Base\Service\Embeds) qr_code(data, size) a QR code as an SVG data: URI (Base\Service\Qr\QrCode) opening_hours() Base\Service\OpeningHours; opening_hours(store), opening_hours('store:12'): one place's image|picture(w, h) a stored picture to its URL (an upload through the image resolver at that size, a URL or a public path as it is, anything else under public/assets/)

CommonsTwigExtension::__construct()

public function __construct(protected readonly Embeds $embeds, protected readonly QrCode $qr, protected readonly OpeningHours $hours, protected readonly ?Packages $packages = null, protected readonly ?MediaService $media = null, protected readonly string $publicDir = '')

CommonsTwigExtension::getFunctions()

public function getFunctions(): array

CommonsTwigExtension::getFilters()

public function getFilters(): array

CommonsTwigExtension::picture()

public function picture(?string $image, ?int $width = null, ?int $height = null): ?string

A stored picture to its URL (moved here from the apps' App\Twig\ImageExtension).

DemoTwigExtension class

class DemoTwigExtension extends AbstractExtension DemoTwigExtension.php:22

The demonstration in a template (docs/20-architecture/demo.md): {% if demo_mode() %}...{% endif %} the demo environment, and no other {% for account in demo_accounts() %} the declared accounts a visitor may sign in as @Base/demo/_banner.html.twig and @Base/demo/_accounts.html.twig are what a layout and a sign-in page include; both print nothing outside demo. The banner names the first of these accounts to a visitor who is not signed in.

DemoTwigExtension::__construct()

public function __construct(readonly DemoMode $mode, readonly DemoAccountRegistry $registry, readonly DemoAccountFactory $factory)

DemoTwigExtension::getFunctions()

public function getFunctions(): array

DemoTwigExtension::accounts()

public function accounts(): array

The declared accounts that exist and may be signed in as - none outside demo, and never one that opens the back office (base.demo.admin_roles; the super-administrator's roles reach them).

DeployVersionExtension class

final class DeployVersionExtension extends AbstractExtension DeployVersionExtension.php:33

A value that changes on every real deploy and stays stable otherwise - meant to be fed into a client-side cache key (e.g.

@glitchr/transparent's Transparent.ready({cache_version: deploy_version()})) so a browser tab that cached a page before a deploy doesn't keep replaying it forever.

Reads the app's own git HEAD directly (no shell-out) rather than a Composer/env-var version string, since that's correct regardless of whether the app bumps any version number on release - this app's own deploy model resets the production directory to a specific commit via git fetch && git reset --hard, so HEAD always changes on a real deploy and never otherwise.

ALSO folds in vendor/{glitchr,omniscient,omnibase}/*'s own git HEADs, not just the app's - on this project, those aren't standard immutable Composer installs, they're live git checkouts iterated on directly (see e.g. the base-bundle-admin/base-bundle dev workflow), so a change committed there changes nothing about the APP's own HEAD at all. Without this, every vendor-level fix left every already-open admin tab replaying the pre-fix HTML/CSS/JS indefinitely - reported live, repeatedly, as "no handler" for a control that had genuinely already shipped. Missing/non-git vendor dirs (a normal production Composer install, source-archive not git checkout) just contribute nothing, same as the app dir falling back to 'dev' when it isn't a git checkout either.

DeployVersionExtension::__construct()

public function __construct(readonly string $projectDir)

DeployVersionExtension::getFunctions()

public function getFunctions(): array

DeployVersionExtension::getVersion()

public function getVersion(): string

FormTwigExtension class

final class FormTwigExtension extends AbstractExtension FormTwigExtension.php:11

FormTwigExtension::__construct()

public function __construct(FormProxyInterface $formProxy)

FormTwigExtension::getName()

public function getName()

FormTwigExtension::getFunctions()

public function getFunctions(): array

FormTwigExtension::advancedForm()

public function advancedForm(): bool

FormTwigExtension::getForm()

public function getForm(string $name): ?FormInterface

FormTwigExtension::getView()

public function getView(string $name): ?FormView

FunctionTwigExtension class

final class FunctionTwigExtension extends AbstractExtension FunctionTwigExtension.php:43

omnibase's Twig functions and filters. html_attributes, mb_ucfirst, second, join_if_exists and less_than are omnibridge/twig's HelperExtension's (registered beside this one, the same results); str_shorten, highlight and datetime stay here, they do more than its copies (str_shorten's SHORTEN_BACK_SHRINK/EXTEND, highlight's excerpt, datetime's patterns lists, intervals and formats), and win over them.

FunctionTwigExtension::__construct()

public function __construct(TranslatorInterface $translator, AssetExtension $assetExtension, Environment $twig, AdminUrlGeneratorInterface $adminUrlGenerator, string $projectDir, readonly ?AdminRouteRegistry $routeRegistry = null)

FunctionTwigExtension::getFunctions()

public function getFunctions(): array

FunctionTwigExtension::getFilters()

public function getFilters(): array

FunctionTwigExtension::isEmojiOnly()

public function isEmojiOnly(?string $value): bool

FunctionTwigExtension::at()

public function at(array $array, int|string $index)

FunctionTwigExtension::crudify()

public function crudify(?object $entity, array $options = []): string

A link to the entity's edit page in the admin, or nothing when no CRUD manages it. Options: label, icon. The registered controller first (an app's CRUD may sit outside the namespace convention), then the convention.

Throws

LoaderError

Throws

RuntimeError

Throws

SyntaxError

FunctionTwigExtension::mailparseEmail()

public function mailparseEmail(string|EmailRecipientInterface $recipient): ?string

FunctionTwigExtension::mailparseName()

public function mailparseName(string|RecipientInterface $recipient): ?string

FunctionTwigExtension::htmlify()

public function htmlify(?HtmlizeInterface $object, array $options = [], ...$args): ?string

FunctionTwigExtension::email()

public function email(array $context)

FunctionTwigExtension::is_linkable()

public function is_linkable(mixed $value): bool

FunctionTwigExtension::is_callable()

public function is_callable(mixed $value, bool $syntax_only = false, &$callable_name = null): bool

FunctionTwigExtension::nargs()

public function nargs(callable $fn): int

FunctionTwigExtension::call_user_func_with_defaults()

public function call_user_func_with_defaults(callable $fn, ...$args)

FunctionTwigExtension::call_user_func_if_exists()

public function call_user_func_if_exists(Environment $environment, string $fn, array $args)

FunctionTwigExtension::pad()

public function pad(array $array = [], int $length = 0, mixed $value = null): array

FunctionTwigExtension::transforms()

public function transforms(array $array = [], $arrow = null)

FunctionTwigExtension::enum()

public function enum(null|string|array $class): null|Type|array

FunctionTwigExtension::colorify()

public function colorify(null|string|array|ColorizeInterface $color, ?string $entry = null): null|string|array

FunctionTwigExtension::static_property()

public function static_property($class, $propertyName)
Throws

Exception

FunctionTwigExtension::property_accessor()

public function property_accessor(mixed $object, array|string $propertyName, bool $enableMagicCall = false): mixed

FunctionTwigExtension::color_name()

public function color_name(string $hex)
Throws

Exception

FunctionTwigExtension::is_countable()

public function is_countable($object)

FunctionTwigExtension::get_class()

public function get_class($object, $method)

FunctionTwigExtension::method_exists()

public function method_exists($object, $method)

FunctionTwigExtension::preg_split()

public function preg_split(string $subject, string $pattern, int $limit = -1, int $flags = 0)

FunctionTwigExtension::instanceof()

public function instanceof(mixed $object, string $class): bool

FunctionTwigExtension::joinIfExists()

public function joinIfExists(?array $array, string $separator)

FunctionTwigExtension::static_call()

public function static_call($class, $method, ...$args)
Throws

Exception

FunctionTwigExtension::render_stylesheet()

public function render_stylesheet(string $href, array $attributes = [], bool $keepIfNotFound = true): string

FunctionTwigExtension::render_javascript()

public function render_javascript(string $src, array $attributes = [], bool $keepIfNotFound = true): string

FunctionTwigExtension::datetime()

public function datetime(Environment $env, \DateTime|\DateInterval|int|string|null $datetime, array|string $pattern = 'YYYY-MM-dd HH:mm:ss', ?string $dateFormat = 'medium', ?string $timeFormat = 'medium', $timezone = null, string $calendar = 'gregorian', ?string $locale = null): array|string

A moment as a pattern says it, lowered. A string in ISO 8601 (a screen's moment, Base\Screen\Shape::moment(): 2026-04-10T18:05:00+00:00) is that moment, printed as the DateTime it came from was; any other string is given back lowered (a word: "présent"); nothing gives the pattern.

Throws

RuntimeError

FunctionTwigExtension::isMoment()

public static function isMoment(string $value): bool

Whether a string is a moment in ISO 8601: a date, a time, and a zone or not.

FunctionTwigExtension::pickup()

public function pickup(?array $array, int $i)

FunctionTwigExtension::countdown()

public function countdown(Environment $env, \DateTime|\DateInterval|int|string|null $datetime, array $parameters = []): string

FunctionTwigExtension::progress()

public function progress(Environment $env, \DateTime $start, \DateTime $end, array $parameters = []): string

FunctionTwigExtension::title()

public function title(string $name, array $parameters = [], ?string $domain = 'controllers', ?string $locale = null): string

FunctionTwigExtension::excerpt()

public function excerpt(string $name, array $parameters = [], ?string $domain = 'controllers', ?string $locale = null): string

FunctionTwigExtension::less_than()

public function less_than($date, $diff): bool
Throws

Exception

FunctionTwigExtension::greater_than()

public function greater_than($date, int $diff): bool
Throws

Exception

FunctionTwigExtension::truncate()

public function truncate($string, $maxLength = 30, $replacement = '', $truncAtSpace = false): string

FunctionTwigExtension::highlight()

public function highlight(?string $content, string|array $pattern, $gateLength = -1)
$gateLength

Number of words before and after

FunctionTwigExtension::stringify()

public function stringify($value): string

FunctionTwigExtension::mailto()

public function mailto(string $address, string $label)

HtmlTwigExtension class

final class HtmlTwigExtension extends AbstractExtension HtmlTwigExtension.php:14

HtmlTwigExtension::__construct()

public function __construct(HtmlTagRenderer $htmlTagRenderer, WysiwygEnhancerInterface $wysiwygEnhancer, EditorEnhancerInterface $editorEnhancer)

HtmlTwigExtension::getFilters()

public function getFilters(): array

HtmlTwigExtension::renderWysiwyg()

public function renderWysiwyg(?string $htmlOrJson, array $options = [])

HtmlTwigExtension::getTableOfContents()

public function getTableOfContents(?string $htmlOrJson, ?int $maxLevel = null): array

HtmlTwigExtension::getFunctions()

public function getFunctions(): array

HtmlTwigExtension::renderLinkTags()

public function renderLinkTags(): string

HtmlTwigExtension::renderScriptTags()

public function renderScriptTags(): string

HtmlTwigExtension::renderHeadTags()

public function renderHeadTags(): string

HtmlTwigExtension::renderNoscriptTags()

public function renderNoscriptTags(): string

HtmlTwigExtension::renderBodyTags()

public function renderBodyTags(): string

LocalBusinessTwigExtension class

class LocalBusinessTwigExtension extends AbstractExtension LocalBusinessTwigExtension.php:16

schema.org's LocalBusiness in a template (docs/40-commons/local-business.md):

{{ local_business_jsonld() }} the page's <script type="application/ld+json"> {{ local_business_jsonld({priceRange: '€€'}, store) }} properties of its own, one place's hours {% set business = local_business() %} the properties, to merge into a graph of the page's own

LocalBusinessTwigExtension::__construct()

public function __construct(protected readonly LocalBusiness $business)

LocalBusinessTwigExtension::getFunctions()

public function getFunctions(): array

LocalizerTwigExtension class

final class LocalizerTwigExtension extends AbstractExtension LocalizerTwigExtension.php:12

LocalizerTwigExtension::__construct()

public function __construct(LocalizerInterface $localizer)

LocalizerTwigExtension::getName()

public function getName()

LocalizerTwigExtension::getFilters()

public function getFilters(): array

LocalizerTwigExtension::getFunctions()

public function getFunctions(): array

LocalizerTwigExtension::renderLocale()

public function renderLocale(Environment $twig, array $options = [], string $template = '@Base/localizer/locale_dropdown.html.twig'): ?string

LocalizerTwigExtension::renderCountry()

public function renderCountry(Environment $twig, array $options = [], string $template = '@Base/localizer/country_dropdown.html.twig'): ?string

LocalizerTwigExtension::renderTimezone()

public function renderTimezone(Environment $twig, array $options = [], string $template = '@Base/localizer/timezone_dropdown.html.twig'): ?string

LocalizerTwigExtension::renderCurrency()

public function renderCurrency(Environment $twig, array $options = [], string $template = '@Base/localizer/currency_dropdown.html.twig'): ?string

MathTwigExtension class

final class MathTwigExtension extends AbstractExtension MathTwigExtension.php:8

MathTwigExtension::getFunctions()

public function getFunctions(): array

MathTwigExtension::sqrt()

public function sqrt($value): float

MathTwigExtension::count()

public function count(\Countable|array $value, int $mode = COUNT_NORMAL): int

MathTwigExtension::round()

public function round(int|float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): int

MediaTwigExtension class

final class MediaTwigExtension extends AbstractExtension MediaTwigExtension.php:23

MediaTwigExtension::__construct()

public function __construct(AdvancedRouterInterface $router, MediaService $mediaService, MediaController $mediaController, string $projectDir)

MediaTwigExtension::getFunctions()

public function getFunctions(): array

MediaTwigExtension::getTests()

public function getTests(): array

MediaTwigExtension::getFilters()

public function getFilters(): array

MediaTwigExtension::onDisk()

public function onDisk(string $file): bool

MediaTwigExtension::image()

public function image(array $context, array|string|null $path, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::imageCrop()

public function imageCrop(array $context, array|string|null $path, int $x = 0, int $y = 0, ?int $width = null, ?int $height = null, string $position = 'leftop', array $config = [], array $filters = []): array|string|null

MediaTwigExtension::thumbnailInset()

public function thumbnailInset(array $context, array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::thumbnailOutbound()

public function thumbnailOutbound(array $context, array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::thumbnailNoclone()

public function thumbnailNoclone(array $context, array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::thumbnailUpscale()

public function thumbnailUpscale(array $context, array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::thumbnail()

public function thumbnail(array $context, array|string|null $path, ?int $width = null, ?int $height = null, array $config = [], array $filters = []): array|string|null

MediaTwigExtension::urlify()

public function urlify(LinkableInterface|string|null $urlOrPath, ?string $label = null, array $attributes = [])

MediaTwigExtension::linkify()

public function linkify(mixed $urlOrLinkableObject)

MediaTwigExtension::url()

public function url(array $context, ?string $name, array $parameters = [], int $referenceType = AdvancedRouter::ABSOLUTE_URL)

MediaTwigExtension::inline_css_email()

public function inline_css_email(array $context, string $body, string ...$css): string

MediaTwigExtension::embed()

public function embed(Environment $twig, array $context, string $src, array $options = [])

NotificationTwigExtension class

class NotificationTwigExtension extends AbstractExtension NotificationTwigExtension.php:22

What a toolbar needs to draw the bell: the unread count (the red dot), the latest entries (the dropdown), and the two things its script needs - the CSRF token every mutation carries and whether push can be offered at all.

All of it is for the CURRENT user; anonymous visitors get zeros so the templates need no guards of their own.

NotificationTwigExtension::__construct()

public function __construct(protected readonly Security $security, protected readonly NotificationRepository $repository, protected readonly WebPushService $webPush, protected readonly CsrfTokenManagerInterface $csrfTokenManager, protected readonly ?NotificationLinkerInterface $linker = null)

NotificationTwigExtension::getFunctions()

public function getFunctions(): array

NotificationTwigExtension::unread()

public function unread(): int

NotificationTwigExtension::latest()

public function latest(int $limit = 8): array

NotificationTwigExtension::token()

public function token(): string

NotificationTwigExtension::pushKey()

public function pushKey(): string

NotificationTwigExtension::adminUrl()

public function adminUrl(Notification $notification): ?string

The back-office page of what a notification is about, or null.

NotificationTwigExtension::pushAvailable()

public function pushAvailable(): bool

OAuthTwigExtension class

final class OAuthTwigExtension extends AbstractExtension OAuthTwigExtension.php:16

oauth_available('google'): whether a "continue with ..." button can lead anywhere - the provider is declared in hwi_oauth.resource_owners of some firewall AND has a client id. A site that leaves the id empty (a sandbox, a provider not set up yet) keeps the declaration without showing a button that ends on the provider's error page.

OAuthTwigExtension::__construct()

public function __construct(readonly ?ResourceOwnerMapLocator $locator = null)

OAuthTwigExtension::getFunctions()

public function getFunctions(): array

OAuthTwigExtension::isAvailable()

public function isAvailable(string $name): bool

PaginatorTwigExtension class

final class PaginatorTwigExtension extends AbstractExtension PaginatorTwigExtension.php:11

PaginatorTwigExtension::__construct()

public function __construct(TranslatorInterface $translator)

PaginatorTwigExtension::getName()

public function getName()

PaginatorTwigExtension::getFunctions()

public function getFunctions(): array

PaginatorTwigExtension::getSlidingControl()

public function getSlidingControl(Environment $twig, PaginationInterface $pagination, string $name, array $parameters = []): ?string

PaginatorTwigExtension::getRewind()

public function getRewind(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

PaginatorTwigExtension::getFirst()

public function getFirst(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

PaginatorTwigExtension::getFirstSeparator()

public function getFirstSeparator(PaginationInterface $pagination, string $separator): ?string

PaginatorTwigExtension::getFirstOnes()

public function getFirstOnes(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?array

PaginatorTwigExtension::getPreviousOnes()

public function getPreviousOnes(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?array

PaginatorTwigExtension::getPrevious()

public function getPrevious(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

PaginatorTwigExtension::getCurrent()

public function getCurrent(PaginationInterface $pagination, ?string $label = null): ?string

PaginatorTwigExtension::getNext()

public function getNext(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

PaginatorTwigExtension::getNextOnes()

public function getNextOnes(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?array

PaginatorTwigExtension::getLast()

public function getLast(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

PaginatorTwigExtension::getLastOnes()

public function getLastOnes(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?array

PaginatorTwigExtension::getLastSeparator()

public function getLastSeparator(PaginationInterface $pagination, string $separator): ?string

PaginatorTwigExtension::getFastForward()

public function getFastForward(PaginationInterface $pagination, string $name, array $parameters = [], ?string $label = null): ?string

SecurityPolicyTwigExtension class

class SecurityPolicyTwigExtension extends AbstractExtension implements GlobalsInterface SecurityPolicyTwigExtension.php:19

Exposes the administrator's account-security policy to every template as security_policy.

The account settings page receives the same object as a normal render parameter, but the login page and the layout do not have a controller of their own to pass it from - the login form is rendered by the security bundle - and both need to know whether passkeys are offered before they draw a button for them.

SecurityPolicyTwigExtension::__construct()

public function __construct(SecurityPolicy $securityPolicy)

SecurityPolicyTwigExtension::getGlobals()

public function getGlobals(): array

SemanticTwigExtension class

final class SemanticTwigExtension extends AbstractExtension SemanticTwigExtension.php:10

SemanticTwigExtension::__construct()

public function __construct(SemanticEnhancerInterface $semanticEnhancer)

SemanticTwigExtension::getName()

public function getName()

SemanticTwigExtension::getFilters()

public function getFilters(): array

SharingFilter class

final class SharingFilter extends AbstractExtension SharingFilter.php:10

SharingFilter::__construct()

public function __construct(Sharing $sharing)

SharingFilter::getName()

public function getName()

SharingFilter::getFilters()

public function getFilters(): array

SharingFilter::getFunctions()

public function getFunctions(): array

SharingFilter::generate()

public function generate(LinkableInterface $url, string $identifier, array $options = [], ?string $template = null): ?string

ThemizerTwigExtension class

final class ThemizerTwigExtension extends AbstractExtension ThemizerTwigExtension.php:12

ThemizerTwigExtension::__construct()

public function __construct(ThemizerInterface $themizer)

ThemizerTwigExtension::getName()

public function getName()

ThemizerTwigExtension::getFilters()

public function getFilters(): array

ThemizerTwigExtension::getFunctions()

public function getFunctions(): array

ThemizerTwigExtension::renderModes()

public function renderModes(Environment $twig, array $options = [], string $template = '@Base/themizer/dropdown.html.twig'): ?string

ThemizerTwigExtension::renderFilters()

public function renderFilters(Environment $twig, array $options = [], string $template = '@Base/themizer/filters/dropdown.html.twig'): ?string

ThemizerTwigExtension::renderWidths()

public function renderWidths(Environment $twig, array $options = [], string $template = '@Base/themizer/widths/dropdown.html.twig'): ?string

TradingTwigExtension class

final class TradingTwigExtension extends AbstractExtension TradingTwigExtension.php:12

TradingTwigExtension::__construct()

public function __construct(TradingInterface $tradingMarket)

TradingTwigExtension::getFilters()

public function getFilters(): array

TradingTwigExtension::getFunctions()

public function getFunctions(): array

TradingTwigExtension::formatCurrency()

public function formatCurrency($amount, string $currency, array $attrs = [], ?string $locale = null): string
Throws

RuntimeError

TradingTwigExtension::applyCurrencyRate()

public function applyCurrencyRate($amount, string $currency, array $attrs = [], ?string $locale = null): ?float

TranslatorTwigExtension class

final class TranslatorTwigExtension extends AbstractExtension TranslatorTwigExtension.php:11

TranslatorTwigExtension::__construct()

public function __construct(LocalizerInterface $localizer)

TranslatorTwigExtension::getName()

public function getName()

TranslatorTwigExtension::getFilters()

public function getFilters(): array

WebpackTwigExtension class

final class WebpackTwigExtension extends AbstractExtension WebpackTwigExtension.php:9

WebpackTwigExtension::getFunctions()

public function getFunctions(): array

WidgetTwigExtension class

final class WidgetTwigExtension extends AbstractExtension WidgetTwigExtension.php:14

WidgetTwigExtension::__construct()

public function __construct(WidgetProviderInterface $widgetProvider)

WidgetTwigExtension::getName()

public function getName()

WidgetTwigExtension::getFunctions()

public function getFunctions(): array

WidgetTwigExtension::render_slot()

public function render_slot(Environment $twig, string $slot, array $options = [], ?string $template = null): string

Base\Twig\Loader

FilesystemLoader class

class FilesystemLoader extends FilesystemLoader FilesystemLoader.php:8

FilesystemLoader::__construct()

public function __construct(\Twig\Loader\FilesystemLoader $inner, ParameterBagInterface $parameterBag, string $projectDir)

FilesystemLoader::getSourceContext()

public function getSourceContext(string $name): \Twig\Source

ORDER OF RESOLUTION: 1. custom loader 2. default Symfony loader (and TwigComponent delegated loaders)

FilesystemLoader::exists()

public function exists(string $name): bool

FilesystemLoader::getCacheKey()

public function getCacheKey(string $name): string

FilesystemLoader::isFresh()

public function isFresh(string $name, int $time): bool

Base\Twig\Renderer

AbstractTagRenderer class

abstract class AbstractTagRenderer implements TagRendererInterface AbstractTagRenderer.php:10

AbstractTagRenderer::__construct()

public function __construct(Environment $twig, LocalizerInterface $localizer, SluggerInterface $slugger, ParameterBagInterface $parameterBag)

TagRendererInterface interface

interface TagRendererInterface TagRendererInterface.php:7

TagRendererInterface::render()

public function render(string $name, array $context = []): string

TagRendererInterface::renderFallback()

public function renderFallback(Response $response): Response

Base\Twig\Renderer\Adapter

HtmlTagRenderer class

class HtmlTagRenderer extends AbstractTagRenderer HtmlTagRenderer.php:15

HtmlTagRenderer::__construct()

public function __construct(Environment $twig, LocalizerInterface $localizer, SluggerInterface $slugger, ParameterBagInterface $parameterBag, RequestStack $requestStack, AdvancedRouterInterface $router)

HtmlTagRenderer::getAsset()

public function getAsset(string $url): string

HtmlTagRenderer::renderHtmlContent()

public function renderHtmlContent(string $location)

HtmlTagRenderer::getHtmlContent()

public function getHtmlContent(string $location)

HtmlTagRenderer::removeHtmlContent()

public function removeHtmlContent(string $location)

HtmlTagRenderer::addHtmlContent()

public function addHtmlContent(string $location, $contentOrArrayOrFile, array $options = [])

HtmlTagRenderer::render()

public function render(string $name, array $context = []): string

HtmlTagRenderer::renderFallback()

public function renderFallback(Response $response): Response

WebpackTagRenderer class

class WebpackTagRenderer extends AbstractTagRenderer implements AbstractLocalCacheInterface WebpackTagRenderer.php:25

WebpackTagRenderer::__construct()

public function __construct(Environment $twig, LocalizerInterface $localizer, SluggerInterface $slugger, ParameterBagInterface $parameterBag, ?EntrypointLookupCollectionInterface $entrypointLookupCollection, Packages $packages, string $publicDir, string $cacheDir, ?string $buildDir = null)

WebpackTagRenderer::getCacheFile()

public function getCacheFile()

WebpackTagRenderer::warmUp()

public function warmUp(string $cacheDir, ?string $buildDir = null): array

WebpackTagRenderer::getMedia()

public function getMedia(string $filename): ?string

WebpackTagRenderer::getBreakpoints()

public function getBreakpoints()

WebpackTagRenderer::addBreakpoint()

public function addBreakpoint(string $name, string $media)

WebpackTagRenderer::removeBreakpoint()

public function removeBreakpoint(string $name)

WebpackTagRenderer::getAlternatives()

public function getAlternatives()

WebpackTagRenderer::addAlternative()

public function addAlternative(string $alternative)

WebpackTagRenderer::removeAlternative()

public function removeAlternative(string $alternative)

WebpackTagRenderer::getEntryLinkTags()

public function getEntryLinkTags(): array

WebpackTagRenderer::getEntryScriptTags()

public function getEntryScriptTags(): array

WebpackTagRenderer::getEntrypoints()

public function getEntrypoints(): array

WebpackTagRenderer::discoverEntrypoints()

public function discoverEntrypoints(?string $appJsonPath, array $breakpoints = []): bool

Reads the entries of the application's build (its entrypoints.json) and of the core's (public/bundles/base/entrypoints.json), the breakpoints and the alternatives (-async, -defer).

Returns

whether both builds were there with entries: a build being written (Encore's watcher empties its output first) is not complete, and what was read of it is never kept beyond the request (see WebpackCacheWarmer::doWarmUp())

WebpackTagRenderer::getEntry()

public function getEntry(string $entrypointName): ?EntrypointLookupInterface

WebpackTagRenderer::addEntrypoint()

public function addEntrypoint(string $value, string $entrypointJsonPath, ?CacheItemPoolInterface $cache = null, ?string $cacheKey = null, bool $strictMode = true)

WebpackTagRenderer::removeEntrypoint()

public function removeEntrypoint(string $value)

WebpackTagRenderer::hasEntry()

public function hasEntry(string $entryName, string $entrypointName = '_default'): bool

WebpackTagRenderer::addTag()

public function addTag(string $value, ?string $packageName = null, ?string $entrypointName = null, ?string $htmlAttributes = null)

WebpackTagRenderer::loadEntry()

public function loadEntry(array|string|null $value)

WebpackTagRenderer::markAsOptional()

public function markAsOptional(array|string|null $value, bool $isOptional = true)

WebpackTagRenderer::isOptional()

public function isOptional(string $value): bool

WebpackTagRenderer::addLinkTag()

public function addLinkTag(string $value, ?string $packageName = null, ?string $entrypointName = null, ?string $htmlAttributes = null)

WebpackTagRenderer::addScriptTag()

public function addScriptTag(string $value, ?string $packageName = null, ?string $entrypointName = null, ?string $htmlAttributes = null)

WebpackTagRenderer::removeTags()

public function removeTags(string $value)

WebpackTagRenderer::removeLinkTag()

public function removeLinkTag(string $entryName)

WebpackTagRenderer::removeScriptTag()

public function removeScriptTag(string $entryName)

WebpackTagRenderer::reset()

public function reset($entrypoints = null)

WebpackTagRenderer::renderOptionalCssSource()

public function renderOptionalCssSource(string $entryName, ?string $packageName = null, ?string $entrypointName = null, ?string $htmlAttributes = null): string

WebpackTagRenderer::renderCssSource()

public function renderCssSource(string|array $entryName, ?string $packageName = null, ?string $entrypointName = null, ?string $htmlAttributes = null): string

WebpackTagRenderer::renderOptionalLinkTags()

public function renderOptionalLinkTags(null|string|array $entryName = null, ?string $packageName = null, ?string $entrypointName = null, array $htmlAttributes = []): string

WebpackTagRenderer::renderLinkTags()

public function renderLinkTags(null|string|array $entryName = null, ?string $packageName = null, ?string $entrypointName = null, array $htmlAttributes = []): string

WebpackTagRenderer::renderOptionalScriptTags()

public function renderOptionalScriptTags(null|string|array $entryName = null, ?string $packageName = null, ?string $entrypointName = null, array $htmlAttributes = []): string

WebpackTagRenderer::scriptAttributes()

public static function scriptAttributes(string $file, array $defaults = []): array

How a script file is loaded: defer for a file named -defer, async for one named -async, the defaults (base.twig.script_attributes) for the others.

Unless the defaults say ordered: false, a file named -async is loaded defer too: deferred scripts run in the order of the page, async ones whenever they arrive. The core's base-async entry is what sets window.jQuery, and a site's entries read it as an external (addExternals({ jquery: 'jQuery' }), its own app-async included): left async, nothing made the core's run first, and the site's threw "jQuery is not defined" when its file came back sooner. The page renders base before the site's entries, so in order the global is always there.

WebpackTagRenderer::renderScriptTags()

public function renderScriptTags(null|string|array $entryName = null, ?string $packageName = null, ?string $entrypointName = null, array $htmlAttributes = []): string

WebpackTagRenderer::render()

public function render(string $name, ?array $context = [], ?string $packageName = null, ?string $entrypointName = null, array $htmlAttributes = []): string

WebpackTagRenderer::renderFallback()

public function renderFallback(Response $response): Response

Base\Twig\Variable

AdminVariable class

class AdminVariable extends SiteVariable AdminVariable.php:17

AdminVariable::__construct()

public function __construct(AdvancedRouterInterface $router, SitemapperInterface $sitemapper, TranslatorInterface $translator, LocalizerInterface $localizer, BaseService $baseService, MaintenanceProviderInterface $maintenanceProvider, LauncherInterface $launcher, AdminUrlGeneratorInterface $adminUrlGenerator)

AdminVariable::title()

public function title()

AdminVariable::slogan()

public function slogan()
public function logo()

AdminVariable::crudify()

public function crudify(mixed $entity)

EmailVariable class

class EmailVariable EmailVariable.php:8

EmailVariable::__construct()

public function __construct(BaseService $baseService, LauncherInterface $launcher)

EmailVariable::homepage()

public function homepage()

EmailVariable::title()

public function title(): ?string

EmailVariable::slogan()

public function slogan(): ?string
public function logo(): ?string

EmailVariable::address()

public function address(?string $locale = null): ?string

EmailVariable::age()

public function age(?string $locale = null): string

RandomVariable class

class RandomVariable RandomVariable.php:8

RandomVariable::uuidv4()

public function uuidv4()

RandomVariable::rand()

public function rand()

SiteVariable class

class SiteVariable SiteVariable.php:14

SiteVariable::__construct()

public function __construct(AdvancedRouterInterface $router, SitemapperInterface $sitemapper, TranslatorInterface $translator, LocalizerInterface $localizer, BaseService $baseService, MaintenanceProviderInterface $maintenanceProvider, LauncherInterface $launcher)

SiteVariable::index()

public function index()

SiteVariable::meta()

public function meta(array $meta = [], ?string $locale = null): array

SiteVariable::map()

public function map()

SiteVariable::route()

public function route()

SiteVariable::title()

public function title()

SiteVariable::slogan()

public function slogan()
public function logo()

SiteVariable::scheme()

public function scheme(?string $locale = null): ?string

SiteVariable::host()

public function host(?string $locale = null): ?string

SiteVariable::port()

public function port(?string $locale = null): ?string

SiteVariable::domain()

public function domain(?string $locale = null): ?string

SiteVariable::subdomain()

public function subdomain(?string $locale = null): ?string

SiteVariable::base_dir()

public function base_dir(?string $locale = null): string

SiteVariable::url()

public function url(?string $nameOrUrl = '', array $routeParameters = [], ?string $locale = null): string

SiteVariable::under_maintenance()

public function under_maintenance(): bool

SiteVariable::launchdate()

public function launchdate(?string $locale = null): \DateTime

SiteVariable::is_launchedd()

public function is_launchedd(?string $locale = null): bool

SiteVariable::age()

public function age(?string $locale = null): string

SiteVariable::is_newcomer()

public function is_newcomer(int $within = 0): bool

Whether the visitor has not been seen within the last $within seconds, remembered in the cookie USER/LAST_VISIT - which a visitor who refused the site's own cookies (USER) is not given: such a visitor is a newcomer at each page.

SiteVariable::execution_time()

public function execution_time()

Base\Validator

Constraint class

class Constraint extends Constraint Constraint.php:5

public string $message

Constraint::__construct()

public function __construct(?string $message = null, ?array $groups = null, mixed $payload = null)

ConstraintEntity class

abstract class ConstraintEntity extends Constraint ConstraintEntity.php:5

public array|string $fields
public mixed $entity = null

ConstraintEntity::__construct()

public function __construct(array|string $fields, mixed $entity = null, ?string $message = null, ?array $groups = null, mixed $payload = null)
$fields

Required: the field or combination of fields

$entity

Optional: entity class or name

ConstraintEntity::getRequiredOptions()

public function getRequiredOptions(): array

ConstraintEntity::getDefaultOption()

public function getDefaultOption(): ?string

ConstraintEntity::getTargets()

public function getTargets(): string|array

ConstraintEntityValidator class

abstract class ConstraintEntityValidator extends ConstraintValidator ConstraintEntityValidator.php:17

ConstraintEntityValidator::getOriginalEntity()

public function getOriginalEntity($entity)

ConstraintEntityValidator::getEntityChangeSet()

public function getEntityChangeSet($entity): ?array

ConstraintEntityValidator::getClassMetadata()

public function getClassMetadata($entityName): ClassMetadata

ConstraintEntityValidator::buildViolation()

public function buildViolation(Constraint $constraint, $value = null): ConstraintViolationBuilderInterface

ConstraintEntityValidator::validate()

public function validate($value, Constraint $constraint): void
Throws

Exception

ConstraintValidator class

abstract class ConstraintValidator extends ConstraintValidator ConstraintValidator.php:11

public string $constraintClass

ConstraintValidator::__construct()

public function __construct()

ConstraintValidator::setParameter()

public function setParameter(string $parameterName, ?string $parameterValue = null)

ConstraintValidator::getPropertyName()

public function getPropertyName()

ConstraintValidator::getConstraintType()

public function getConstraintType()

ConstraintValidator::buildViolation()

public function buildViolation(Constraint $constraint, $value = null): ConstraintViolationBuilderInterface

Base\Validator\Constraints

Alphanumeric class

class Alphanumeric extends Constraint Alphanumeric.php:8

public string $message = 'alphanumeric'

AlphanumericPlus class

class AlphanumericPlus extends Constraint AlphanumericPlus.php:7

public string $message = 'alphanumeric_plus'

AlphanumericPlusValidator class

class AlphanumericPlusValidator extends ConstraintValidator AlphanumericPlusValidator.php:10

AlphanumericPlusValidator::validate()

public function validate($value, Constraint $constraint): void

AlphanumericValidator class

class AlphanumericValidator extends ConstraintValidator AlphanumericValidator.php:10

AlphanumericValidator::validate()

public function validate($value, Constraint $constraint): void

File class

class File extends Constraint File.php:8

public string $messageMaxSize = 'file.max_size'
public string $messageMimeType = 'file.mime_type'
public array $mimeTypes = []
public int $maxSize

File::__construct()

public function __construct(?string $max_size = null, array $mime_types = [], ?array $groups = null, mixed $payload = null)
$max_size

Human readable string ("2M", "500K", etc.) or null

$mime_types

Array of allowed MIME types

$groups

Validation groups

$payload

Metadata

File::getAllowedMimeTypes()

public function getAllowedMimeTypes(): array

File::getMaxSize()

public function getMaxSize(): int

FileValidator class

class FileValidator extends ConstraintValidator FileValidator.php:11

FileValidator::validate()

public function validate($value, Constraint $constraint): void

Hexcode class

class Hexcode extends Constraint Hexcode.php:7

public string $message = 'hexcode'

HexcodeValidator class

class HexcodeValidator extends ConstraintValidator HexcodeValidator.php:8

HexcodeValidator::validate()

public function validate(mixed $value, Constraint $constraint): void

NotBlank class

class NotBlank extends Constraint NotBlank.php:15

Constraint for the NotBlank validator.

public string $message = '@validators.not_blank'
public bool $allowNull = false
public $normalizer = null

NotBlank::getTargets()

public function getTargets(): string|array

NotBlank::__construct()

public function __construct(?string $message = null, ?bool $allowNull = null, ?callable $normalizer = null, ?array $groups = null, mixed $payload = null)

Symfony 7.4 compliant constructor

NotBlankValidator class

class NotBlankValidator extends ConstraintValidator NotBlankValidator.php:11

NotBlankValidator::validate()

public function validate($value, Constraint $constraint): void

{@inheritdoc}

Password class

class Password extends Constraint Password.php:11

const MIN_LENGTH_FALLBACK = 8
const MIN_STRENGTH_FALLBACK = 0
const MAX_STRENGTH_FALLBACK = 5
public string $messageMinStrength = 'password.min_strength'
public string $messageMinLength = 'password.min_length'
public string $messageUpperCase = 'password.requirements.uppercase'
public string $messageLowerCase = 'password.requirements.lowercase'
public string $messageLength = 'password.requirements.length'
public string $messageNumbers = 'password.requirements.numbers'
public string $messageSpecials = 'password.requirements.specials'

Password::getMinLength()

public function getMinLength(): int

Password::getMinStrength()

public function getMinStrength(): int

Password::getMaxStrength()

public function getMaxStrength(): int

Password::requiresUppercase()

public function requiresUppercase(): bool

Password::requiresLowercase()

public function requiresLowercase(): bool

Password::requiresNumbers()

public function requiresNumbers(): bool

Password::requiresSpecials()

public function requiresSpecials(): bool

Password::requiresLength()

public function requiresLength(): bool

Password::__construct()

public function __construct(bool $uppercase = true, bool $lowercase = true, bool $numbers = true, bool $specials = true, bool $length = true, int $min_strength = self::MIN_STRENGTH_FALLBACK, int $min_length = self::MIN_LENGTH_FALLBACK, ?array $groups = null, mixed $payload = null)

Symfony 7.4+ compliant constructor

PasswordValidator class

class PasswordValidator extends ConstraintValidator PasswordValidator.php:9

PasswordValidator::validate()

public function validate($value, Constraint $constraint): void

StringCaseEntity class

class StringCaseEntity extends ConstraintEntity StringCaseEntity.php:11

Constraint for the StringCase Entity validator.

public ?string $message = 'string_case'

StringCaseEntityValidator class

class StringCaseEntityValidator extends ConstraintEntityValidator StringCaseEntityValidator.php:10

StringCaseEntityValidator::validate()

public function validate($value, Constraint $constraint): void
Throws

Exception

UniqueEntity class

class UniqueEntity extends ConstraintEntity UniqueEntity.php:14

Constraint for UniqueEntity validation.

const NOT_UNIQUE_ERROR = '23bd9dbf-6b9b-41cd-a99e-4844bcf3077f'
public string $service = 'doctrine.orm.validator.unique'
public ?string $em = null
public ?string $entityClass = null
public string $repositoryMethod = 'findBy'
public string|array $fields = []
public ?string $errorPath = null
public bool $ignoreNull = true

UniqueEntity::__construct()

public function __construct(array|string $fields, ?string $message = null, ?string $service = null, ?string $em = null, ?string $entityClass = null, ?string $repositoryMethod = null, ?string $errorPath = null, ?bool $ignoreNull = null, ?array $groups = null, mixed $payload = null)

Symfony 7.4+ compliant constructor.

UniqueEntityValidator class

class UniqueEntityValidator extends ConstraintEntityValidator UniqueEntityValidator.php:17

UniqueEntityValidator::validate()

public function validate($value, Constraint $constraint): void
Throws

Exception