PHP Класс ZfcRbac\Options\ModuleOptions

Автор: Michaël Gallego ([email protected])
Наследование: extends Zend\Stdlib\AbstractOptions
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$assertionMap array Assertion map
$guards array Guards
$guestRole string Guest role (used when no identity is found)
$identityProvider string Key of the identity provider used to retrieve the identity
$protectionPolicy string Protection policy for guards (can be "deny" or "allow")
$redirectStrategy RedirectStrategyOptions | null Options for the redirect strategy
$roleProvider array A configuration for role provider
$unauthorizedStrategy UnauthorizedStrategyOptions | null Options for the unauthorized strategy

Открытые методы

Метод Описание
__construct ( $options = null ) Constructor
getAssertionMap ( ) : array Get the assertions options
getGuards ( ) : array Get the guards options
getGuestRole ( ) : string Get the guest role (used when no identity is found)
getIdentityProvider ( ) : string Get the key of the identity provider used to retrieve the identity
getProtectionPolicy ( ) : string Get the protection policy for guards
getRedirectStrategy ( ) : RedirectStrategyOptions Get the redirect strategy options
getRoleProvider ( ) : array Get the configuration for the role provider
getUnauthorizedStrategy ( ) : UnauthorizedStrategyOptions Get the unauthorized strategy options
setAssertionMap ( array $assertionMap ) : void Set the assertions options
setGuards ( array $guards ) : void Set the guards options
setGuestRole ( string $guestRole ) : void Set the guest role (used when no identity is found)
setIdentityProvider ( string $identityProvider ) : void Set the key of the identity provider used to retrieve the identity
setProtectionPolicy ( string $protectionPolicy ) : void Set the protection policy for guards
setRedirectStrategy ( array $redirectStrategy ) Set the redirect strategy options
setRoleProvider ( array $roleProvider ) Set the configuration for the role provider
setUnauthorizedStrategy ( array $unauthorizedStrategy ) Set the unauthorized strategy options

Описание методов

__construct() публичный Метод

{@inheritDoc}
public __construct ( $options = null )

getAssertionMap() публичный Метод

Get the assertions options
public getAssertionMap ( ) : array
Результат array

getGuards() публичный Метод

Get the guards options
public getGuards ( ) : array
Результат array

getGuestRole() публичный Метод

Get the guest role (used when no identity is found)
public getGuestRole ( ) : string
Результат string

getIdentityProvider() публичный Метод

Get the key of the identity provider used to retrieve the identity
public getIdentityProvider ( ) : string
Результат string

getProtectionPolicy() публичный Метод

Get the protection policy for guards
public getProtectionPolicy ( ) : string
Результат string

getRedirectStrategy() публичный Метод

Get the redirect strategy options
public getRedirectStrategy ( ) : RedirectStrategyOptions
Результат RedirectStrategyOptions

getRoleProvider() публичный Метод

Get the configuration for the role provider
public getRoleProvider ( ) : array
Результат array

getUnauthorizedStrategy() публичный Метод

Get the unauthorized strategy options
public getUnauthorizedStrategy ( ) : UnauthorizedStrategyOptions
Результат UnauthorizedStrategyOptions

setAssertionMap() публичный Метод

Set the assertions options
public setAssertionMap ( array $assertionMap ) : void
$assertionMap array
Результат void

setGuards() публичный Метод

Set the guards options
public setGuards ( array $guards ) : void
$guards array
Результат void

setGuestRole() публичный Метод

Set the guest role (used when no identity is found)
public setGuestRole ( string $guestRole ) : void
$guestRole string
Результат void

setIdentityProvider() публичный Метод

Set the key of the identity provider used to retrieve the identity
public setIdentityProvider ( string $identityProvider ) : void
$identityProvider string
Результат void

setProtectionPolicy() публичный Метод

Set the protection policy for guards
public setProtectionPolicy ( string $protectionPolicy ) : void
$protectionPolicy string
Результат void

setRedirectStrategy() публичный Метод

Set the redirect strategy options
public setRedirectStrategy ( array $redirectStrategy )
$redirectStrategy array

setRoleProvider() публичный Метод

Set the configuration for the role provider
public setRoleProvider ( array $roleProvider )
$roleProvider array

setUnauthorizedStrategy() публичный Метод

Set the unauthorized strategy options
public setUnauthorizedStrategy ( array $unauthorizedStrategy )
$unauthorizedStrategy array

Описание свойств

$assertionMap защищенное свойство

Assertion map
protected array $assertionMap
Результат array

$guards защищенное свойство

Guards
protected array $guards
Результат array

$guestRole защищенное свойство

Guest role (used when no identity is found)
protected string $guestRole
Результат string

$identityProvider защищенное свойство

Key of the identity provider used to retrieve the identity
protected string $identityProvider
Результат string

$protectionPolicy защищенное свойство

Protection policy for guards (can be "deny" or "allow")
protected string $protectionPolicy
Результат string

$redirectStrategy защищенное свойство

Options for the redirect strategy
protected RedirectStrategyOptions,ZfcRbac\Options|null $redirectStrategy
Результат RedirectStrategyOptions | null

$roleProvider защищенное свойство

A configuration for role provider
protected array $roleProvider
Результат array

$unauthorizedStrategy защищенное свойство

Options for the unauthorized strategy
protected UnauthorizedStrategyOptions,ZfcRbac\Options|null $unauthorizedStrategy
Результат UnauthorizedStrategyOptions | null