Skip to content
docsv0.9.0

PolicyDecision

A {@see Contracts\Policy}'s verdict on one (actor, permission, context) — an effect plus an optional learnable reason.

PolicyDecision::__construct()

public function __construct(Milpa\Auth\PolicyEffect $effect, ?string $reason = null):

Parameters

Parameters of __construct()
NameTypeDescription
$effectMilpa\Auth\PolicyEffect
$reason?string

PolicyDecision::allow()

public static function allow(?string $reason = null): self

Factory for an allow decision.

Parameters

Parameters of allow()
NameTypeDescription
$reason?string

PolicyDecision::deny()

public static function deny(?string $reason = null): self

Factory for a deny decision.

Parameters

Parameters of deny()
NameTypeDescription
$reason?string

PolicyDecision::abstain()

public static function abstain(): self

Factory for an abstain decision.

PolicyDecision::isAllowed()

public function isAllowed(): bool

Check if the decision is allow.

PolicyDecision::isDenied()

public function isDenied(): bool

Check if the decision is deny.

PolicyDecision::isAbstain()

public function isAbstain(): bool

Check if the decision is abstain.