PolicyRuleInterface

A single authorization policy rule, as consumed by the PolicyGate. Backing storage is the host's concern (the Milpa monorepo implements it with a Doctrine entity); the gate only reads these four accessors.

abstract public function getId(): ?int

Persistent identifier of the rule, or null when it has not been persisted (e.g. an in-memory rule).

abstract public function getEffect(): string

Either "allow" or "deny".

abstract public function getRequiresScopes(): ?array

Scopes the caller must hold to satisfy this rule.

Returns

Any-of set of required scopes, or null when the rule imposes no scope requirement.

abstract public function getDescription(): ?string

Human-readable explanation surfaced back to the caller when this rule denies the call.