PHP Class ZfcRbac\Options\RedirectStrategyOptions

Author: Michaël Gallego ([email protected])
Inheritance: extends Zend\Stdlib\AbstractOptions
ファイルを表示 Open project: zf-commons/zfc-rbac Class Usage Examples

Protected Properties

Property 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

Public Methods

Method 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 method

public getAppendPreviousUri ( ) : boolean
return boolean

getPreviousUriQueryKey() public method

public getPreviousUriQueryKey ( ) : string
return string

getRedirectToRouteConnected() public method

public getRedirectToRouteConnected ( ) : string
return string

getRedirectToRouteDisconnected() public method

public getRedirectToRouteDisconnected ( ) : string
return string

getRedirectWhenConnected() public method

public getRedirectWhenConnected ( ) : boolean
return boolean

setAppendPreviousUri() public method

public setAppendPreviousUri ( boolean $appendPreviousUri )
$appendPreviousUri boolean

setPreviousUriQueryKey() public method

public setPreviousUriQueryKey ( string $previousUriQueryKey )
$previousUriQueryKey string

setRedirectToRouteConnected() public method

public setRedirectToRouteConnected ( string $redirectToRouteConnected ) : void
$redirectToRouteConnected string
return void

setRedirectToRouteDisconnected() public method

public setRedirectToRouteDisconnected ( string $redirectToRouteDisconnected ) : void
$redirectToRouteDisconnected string
return void

setRedirectWhenConnected() public method

public setRedirectWhenConnected ( boolean $redirectWhenConnected ) : void
$redirectWhenConnected boolean
return void

Property Details

$appendPreviousUri protected_oe property

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

$previousUriQueryKey protected_oe property

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

$redirectToRouteConnected protected_oe property

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

$redirectToRouteDisconnected protected_oe property

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

$redirectWhenConnected protected_oe property

Should the user be redirected when connected and not authorized
protected bool $redirectWhenConnected
return boolean