ExternalSessionServiceInterface
extends
DbServiceInterface
in
Database service for external_session table.
Tags
Table of Contents
- addSessionMapping() : ExternalSessionEntityInterface
- Add a mapping between local and external session id's; return the newly-created entity.
- createEntity() : ExternalSessionEntityInterface
- Create a new external session entity.
- destroySession() : void
- Destroy data for the given session ID.
- getAllByExternalSessionId() : array<string|int, ExternalSessionEntityInterface>
- Retrieve objects from the database based on an external session ID
- persistEntity() : void
- Persist an entity.
Methods
addSessionMapping()
Add a mapping between local and external session id's; return the newly-created entity.
public
addSessionMapping(string $localSessionId, string $externalSessionId) : ExternalSessionEntityInterface
Parameters
- $localSessionId : string
-
Local (VuFind) session id
- $externalSessionId : string
-
External session id
Return values
ExternalSessionEntityInterface —createEntity()
Create a new external session entity.
public
createEntity() : ExternalSessionEntityInterface
Return values
ExternalSessionEntityInterface —destroySession()
Destroy data for the given session ID.
public
destroySession(string $sid) : void
Parameters
- $sid : string
-
Session ID to erase
Return values
void —getAllByExternalSessionId()
Retrieve objects from the database based on an external session ID
public
getAllByExternalSessionId(string $sid) : array<string|int, ExternalSessionEntityInterface>
Parameters
- $sid : string
-
External session ID to retrieve
Return values
array<string|int, ExternalSessionEntityInterface> —persistEntity()
Persist an entity.
public
persistEntity(EntityInterface $entity) : void
Parameters
- $entity : EntityInterface
-
Entity to persist.