Class LaravelUi5\Sdk\Security\Attributes\Read

Declares an {@see AbilityType::Read} ability on an OData entity set's authored source class — the custom entity-set class (CustomEntitySetInterface / EntitySetSourceInterface), or the Eloquent model for a discoverModel set.

Same shape as {@see Access} / {@see Act}: the developer names the ability. The harvest additionally records which entity set the attribute's class backs (resolved from the app's ResolverMap — binding->getSourceClass() names this class), so the read authorizer, given a set name at request time, resolves set → ability → grant. Ability names are unique per app namespace (as with #[Act]/#[Access]).

Enforced server-side by the SDK read authorizer at the odata read forward-exit: an actor lacking the ability gets a 403 on a root read, or a pruned $expand + sap-messages warning. A set whose class carries no #[Read] is open (default-open, mirroring #[Access]/#[Act]).

The resulting i18n keys for admin UI labels:

"abilities.read..title"
"abilities.read..description"

Nota Bene: Changing an ability name is a breaking security change.

Methods


					
	public

__construct(string $ability, string|BackedEnum $role, string $note)

Parameters

`$ability`	Semantic identifier, e.g. "readUserPartners".
`$role`	Semantic role bag the read ability belongs to — actors holding the role may read the set.
`$note`	Admin-only description of the read gate's purpose or scope.

Properties
`public`	`string`	`$ability` Semantic identifier, e.g. "readUserPartners". Semantic identifier, e.g. "readUserPartners".	#
`public`	`string\|BackedEnum`	`$role` Semantic role bag the read ability belongs to — actors holding the role may read the set. Semantic role bag the read ability belongs to — actors holding the role may read the set.	#
`public`	`string`	`$note` Admin-only description of the read gate's purpose or scope. Admin-only description of the read gate's purpose or scope.	#

Namespaces

Classes

Class LaravelUi5\Sdk\Security\Attributes\Read

Parameters