VuFind API Documentation

OaiResumption extends RowGateway
in package
implements OaiResumptionEntityInterface

Row Definition for oai_resumption

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 Site

Interfaces, Classes, Traits and Enums

OaiResumptionEntityInterface
Entity model interface for oai_resumption table

Table of Contents

$expires  : string
$id  : int
$params  : string
__construct()  : mixed
Constructor
getExpiry()  : DateTime
Get expiry date.
getId()  : int
Id getter
getPrimaryKeyColumn()  : array<string|int, mixed>
Retrieve primary key information.
getResumptionParameters()  : string|null
Get resumption parameters.
restoreParams()  : array<string|int, mixed>
Extract an array of parameters from the object.
saveParams()  : void
Encode an array of parameters into the object.
setExpiry()  : OaiResumptionEntityInterface
Expiry date setter.
setResumptionParameters()  : OaiResumptionEntityInterface
Resumption parameters setter

Properties

Methods

__construct()

Constructor

public __construct(Adapter $adapter) : mixed
Parameters
$adapter : Adapter

Database adapter

Return values
mixed

getExpiry()

Get expiry date.

public getExpiry() : DateTime
Return values
DateTime

getId()

Id getter

public getId() : int
Return values
int

getPrimaryKeyColumn()

Retrieve primary key information.

public getPrimaryKeyColumn() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResumptionParameters()

Get resumption parameters.

public getResumptionParameters() : string|null
Return values
string|null

restoreParams()

Extract an array of parameters from the object.

public restoreParams() : array<string|int, mixed>
Tags
deprecated

Use parse_str() instead

Return values
array<string|int, mixed>

Original saved parameters.

saveParams()

Encode an array of parameters into the object.

public saveParams(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>

Parameters to save.

Tags
deprecated

Use \VuFind\Db\Service\OaiResumptionService::createAndPersistToken()

Return values
void

Search results