PHP Class ZfcRbac\Options\RedirectStrategyOptions

Author: Michaël Gallego ([email protected])
Inheritance: extends Zend\Stdlib\AbstractOptions
Afficher le fichier Open project: zf-commons/zfc-rbac Class Usage Examples

Protected Properties

Свойство Type Description
$appendPreviousUri boolean Should the previous URI should be appended as a query param?
$previousUriQueryKey string If appendPreviousUri is enabled, key to use in query params that hold the previous URI
$redirectToRouteConnected string The name of the route to redirect when a user is connected and not authorized
$redirectToRouteDisconnected string The name of the route to redirect when a user is disconnected and not authorized
$redirectWhenConnected boolean Should the user be redirected when connected and not authorized

Méthodes publiques

Méthode Description
getAppendPreviousUri ( ) : boolean
getPreviousUriQueryKey ( ) : string
getRedirectToRouteConnected ( ) : string
getRedirectToRouteDisconnected ( ) : string
getRedirectWhenConnected ( ) : boolean
setAppendPreviousUri ( boolean $appendPreviousUri )
setPreviousUriQueryKey ( string $previousUriQueryKey )
setRedirectToRouteConnected ( string $redirectToRouteConnected ) : void
setRedirectToRouteDisconnected ( string $redirectToRouteDisconnected ) : void
setRedirectWhenConnected ( boolean $redirectWhenConnected ) : void

Method Details

getAppendPreviousUri() public méthode

public getAppendPreviousUri ( ) : boolean
Résultat boolean

getPreviousUriQueryKey() public méthode

public getPreviousUriQueryKey ( ) : string
Résultat string

getRedirectToRouteConnected() public méthode

public getRedirectToRouteConnected ( ) : string
Résultat string

getRedirectToRouteDisconnected() public méthode

public getRedirectToRouteDisconnected ( ) : string
Résultat string

getRedirectWhenConnected() public méthode

public getRedirectWhenConnected ( ) : boolean
Résultat boolean

setAppendPreviousUri() public méthode

public setAppendPreviousUri ( boolean $appendPreviousUri )
$appendPreviousUri boolean

setPreviousUriQueryKey() public méthode

public setPreviousUriQueryKey ( string $previousUriQueryKey )
$previousUriQueryKey string

setRedirectToRouteConnected() public méthode

public setRedirectToRouteConnected ( string $redirectToRouteConnected ) : void
$redirectToRouteConnected string
Résultat void

setRedirectToRouteDisconnected() public méthode

public setRedirectToRouteDisconnected ( string $redirectToRouteDisconnected ) : void
$redirectToRouteDisconnected string
Résultat void

setRedirectWhenConnected() public méthode

public setRedirectWhenConnected ( boolean $redirectWhenConnected ) : void
$redirectWhenConnected boolean
Résultat void

Property Details

$appendPreviousUri protected_oe property

Should the previous URI should be appended as a query param?
protected bool $appendPreviousUri
Résultat boolean

$previousUriQueryKey protected_oe property

If appendPreviousUri is enabled, key to use in query params that hold the previous URI
protected string $previousUriQueryKey
Résultat string

$redirectToRouteConnected protected_oe property

The name of the route to redirect when a user is connected and not authorized
protected string $redirectToRouteConnected
Résultat string

$redirectToRouteDisconnected protected_oe property

The name of the route to redirect when a user is disconnected and not authorized
protected string $redirectToRouteDisconnected
Résultat string

$redirectWhenConnected protected_oe property

Should the user be redirected when connected and not authorized
protected bool $redirectWhenConnected
Résultat boolean