API:EPrints/DataObj/LoginTicket

From EPrints Documentation
Revision as of 15:26, 16 December 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::LoginTicket - user system loginticket

User Comments


DESCRIPTION

Login tickets are the database entries for the user's session cookies.

User Comments


Configuration Settings

User Comments


user_cookie_timeout = undef

Set an expiry on the session cookies. This will cause the user's browser to delete the cookie after the given time. The time is specified according to CGI's cookie constructor. This allows settings like +1h and +7d.

User Comments


user_inactivity_timeout = 86400 * 7

How long to wait in seconds before logging the user out after their last activity.

User Comments


user_session_timeout = undef

How long in seconds the user can stay logged in before they must re-log in. Defaults to never - if you do specify this setting you probably want to reduce user_inactivity_timeout to <1 hour.

User Comments


METHODS

User Comments


get_system_field_info

$thing = EPrints::DataObj::Access->get_system_field_info

Core fields.

User Comments


Class Methods

User Comments


get_dataset_id

$dataset = EPrints::DataObj::LoginTicket->get_dataset_id

Returns the id of the EPrints::DataSet object to which this record belongs.

User Comments


Object Methods

User Comments


set_cookies

$ticket->set_cookies()

Set the session cookies for this login ticket.

User Comments


update

$ticket->update()

Update the login ticket by increasing the expiry time.

The expiry time is increased user_inactivity_timeout or 7 days.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

User Comments