VuFind API Documentation

Followup extends AbstractPlugin
in package

Action helper to deal with login followup; responsible for remembering URLs before login and then redirecting the user to the appropriate place afterwards.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Page

Table of Contents

$session  : Container
Session container
__construct()  : mixed
Constructor
clear()  : bool
Clear an element of the stored followup information.
retrieve()  : mixed
Retrieve the stored followup information.
retrieveAndClear()  : mixed
Retrieve and then clear a particular followup element.
store()  : void
Store the current URL (and optional additional information) in the session for use following a successful login.

Properties

$session

Session container

protected Container $session

Methods

__construct()

Constructor

public __construct(Container $session) : mixed
Parameters
$session : Container

Session container

Return values
mixed —

clear()

Clear an element of the stored followup information.

public clear(string $key) : bool
Parameters
$key : string

Element to clear.

Return values
bool —

True if cleared, false if never set.

retrieve()

Retrieve the stored followup information.

public retrieve([string $key = null ][, mixed $default = null ]) : mixed
Parameters
$key : string = null

Element to retrieve and clear (null for entire \Laminas\Session\Container object)

$default : mixed = null

Default value to return if no stored value found (ignored when $key is null)

Return values
mixed —

retrieveAndClear()

Retrieve and then clear a particular followup element.

public retrieveAndClear(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string

Element to retrieve and clear.

$default : mixed = null

Default value to return if no stored value found

Return values
mixed —

store()

Store the current URL (and optional additional information) in the session for use following a successful login.

public store([array<string|int, mixed> $extras = [] ][, string $overrideUrl = null ]) : void
Parameters
$extras : array<string|int, mixed> = []

Associative array of extra fields to store.

$overrideUrl : string = null

URL to store in place of current server URL (null for no override)

Return values
void —

Search results