Class LaravelUi5\Core\Contracts\Ui5Context

`final`
`readonly`

Represents the runtime context of a UI5 artifact request.

This context encapsulates all scoped information (tenant, partner, artifact, request, locale) required to evaluate settings, resolve permissions, and execute providers consistently.

Scope

HTTP requests: Constructed by middleware from the current Request/Route.
Console/Queue/Test: Can be created manually without a Request (Request is nullable). Useful for jobs, batch reports, migrations, or tests.

Guidelines

Do not directly depend on $request being non-null in providers.
Always access tenant/partner/artifact/locale via this context, not via globals.
Treat as immutable: one Ui5Context per logical execution.

Access via dependency injection or the service container:


$context = app(Ui5Context::class);

Located at Contracts/Ui5Context.php

Methods


					
	public

__construct(
	Request|null $request = null,
	Ui5ArtifactInterface $artifact,
	TenantInterface|null $tenant = null,
	BusinessPartnerInterface|null $partner = null,
	BusinessPartnerInterface|null $authPartner = null,
	string|null $locale = null,
)

Parameters

`$request`	The current HTTP request (null if running in console)
`$artifact`	The current UI5 artifact (App, Card, Report)
`$tenant`	The tenant the app is running in (if applicable)
`$partner`	The acting business partner (can be impersonated)
`$authPartner`	The originally authenticated partner (if different)
`$locale`	Effective locale (overrides tenant->getLocale() if provided)


					
	public

effectiveLocale(): string|null

Effective locale, falling back to tenant->getLocale() if not explicitly set.

Properties
`public`	`Request\|null`	`$request` The current HTTP request (null if running in console) The current HTTP request (null if running in console)	#
`public`	`Ui5ArtifactInterface`	`$artifact` The current UI5 artifact (App, Card, Report) The current UI5 artifact (App, Card, Report)	#
`public`	`TenantInterface\|null`	`$tenant` The tenant the app is running in (if applicable) The tenant the app is running in (if applicable)	#
`public`	`BusinessPartnerInterface\|null`	`$partner` The acting business partner (can be impersonated) The acting business partner (can be impersonated)	#
`public`	`BusinessPartnerInterface\|null`	`$authPartner` The originally authenticated partner (if different) The originally authenticated partner (if different)	#
`public`	`string\|null`	`$locale` Effective locale (overrides tenant->getLocale() if provided) Effective locale (overrides tenant->getLocale() if provided)	#

Namespaces

Classes

Interfaces

Class LaravelUi5\Core\Contracts\Ui5Context

Parameters