Passport
in package
A Passport contains all security-related information that needs to be validated during authentication.
A passport badge can be used to add any additional information to the passport.
Tags
Table of Contents
Properties
- $user : mixed
- $attributes : array<string|int, mixed>
- $badges : array<string|int, mixed>
Methods
- __construct() : mixed
- addBadge() : $this
- Adds a new security badge.
- getAttribute() : mixed
- getAttributes() : array<string|int, mixed>
- getBadge() : BadgeInterface|null
- getBadges() : array<BadgeInterface>, BadgeInterface>
- getUser() : UserInterface
- hasBadge() : bool
- setAttribute() : void
Properties
$user
protected
mixed
$user
$attributes
private
array<string|int, mixed>
$attributes
= []
$badges
private
array<string|int, mixed>
$badges
= []
Methods
__construct()
public
__construct(UserBadge $userBadge, CredentialsInterface $credentials[, array<string|int, BadgeInterface> $badges = [] ]) : mixed
Parameters
- $userBadge : UserBadge
- $credentials : CredentialsInterface
-
the credentials to check for this authentication, use SelfValidatingPassport if no credentials should be checked
- $badges : array<string|int, BadgeInterface> = []
addBadge()
Adds a new security badge.
public
addBadge(BadgeInterface $badge) : $this
A passport can hold only one instance of the same security badge. This method replaces the current badge if it is already set on this passport.
Parameters
- $badge : BadgeInterface
Return values
$thisgetAttribute()
public
getAttribute(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
getAttributes()
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getBadge()
public
getBadge(string $badgeFqcn) : BadgeInterface|null
Parameters
- $badgeFqcn : string
Return values
BadgeInterface|nullgetBadges()
public
getBadges() : array<BadgeInterface>, BadgeInterface>
Return values
array<BadgeInterface>, BadgeInterface>getUser()
public
getUser() : UserInterface
Return values
UserInterfacehasBadge()
public
hasBadge(string $badgeFqcn) : bool
Parameters
- $badgeFqcn : string
Return values
boolsetAttribute()
public
setAttribute(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed