API:EPrints/DataObj/LoginTicket - Revision history

Pod2wiki at 17:10, 10 January 2022

2022-01-10T17:10:03Z

Pod2wiki at 17:07, 9 January 2022

2022-01-09T17:07:49Z

Pod2wiki at 17:02, 9 January 2022

2022-01-09T17:02:29Z

Pod2wiki at 00:14, 30 December 2021

2021-12-30T00:14:42Z

Pod2wiki at 00:13, 30 December 2021

2021-12-30T00:13:40Z

Show changes

Tdb01r at 09:57, 22 January 2013

2013-01-22T09:57:12Z

Show changes

Tdb01r at 15:26, 16 December 2011

2011-12-16T15:26:30Z

Tdb01r at 12:27, 1 December 2011

2011-12-01T12:27:57Z

Tdb01r: Removing all content from page

2009-08-12T15:40:38Z

Removing all content from page

@@ Line 63: / Line 63: @@
 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 <tt>user_inactivity_timeout</tt> to &lt;1 hour.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 164: / Line 153: @@
 The ID of the user to whom this login ticket belongs.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 73: / Line 73: @@
 <!-- Pod2Wiki=head_instance_variables -->
 ==INSTANCE VARIABLES==
-See &lt;EPrints::DataObj|EPrints::DataObj#INSTANCE_VARIABLES&gt;.
+See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints::DataObj::LoginTicket''' - User system loginticket
+'''EPrints::DataObj::LoginTicket''' - User system login ticket.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
-Login tickets are the database entries for the user's session cookies.
+Login tickets are the database entries for a user's session cookies.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 63: / Line 63: @@
 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 <tt>user_inactivity_timeout</tt> to &lt;1 hour.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 163: / Line 163: @@
 <!-- Pod2Wiki=head_methods -->
 ==METHODS==
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 171: / Line 180: @@
 </div>
 <!-- Pod2Wiki=item_get_system_field_info -->
-===get_system_field_info===
+====get_system_field_info====
   $fields = EPrints::DataObj::Access-&gt;get_system_field_info
@@ Line 184: / Line 193: @@
 </div>
 <!-- Pod2Wiki=item_get_dataset_id -->
-===get_dataset_id===
+====get_dataset_id====
   $dataset = EPrints::DataObj::LoginTicket-&gt;get_dataset_id
@@ Line 197: / Line 206: @@
 </div>
 <!-- Pod2Wiki=item_get_defaults -->
-===get_defaults===
+====get_defaults====
   $defaults = EPrints::DataObj::LoginTicket-&gt;get_defaults( $session, $data, $dataset )
@@ Line 210: / Line 219: @@
 </div>
 <!-- Pod2Wiki=item_new_from_request -->
-===new_from_request===
+====new_from_request====
   $loginticket = EPrints::DataObj::LoginTicket-&gt;new_from_request( $repo, $r )
@@ Line 225: / Line 234: @@
 </div>
 <!-- Pod2Wiki=item_expire_all -->
-===expire_all===
+====expire_all====
   EPrints::DataObj::LoginTicket-&gt;expire_all( $repo )
@@ Line 238: / Line 247: @@
 </div>
 <!-- Pod2Wiki=item_session_key -->
-===session_key===
+====session_key====
   EPrints::DataObj::LoginTicket-&gt;session_key( $repo )
@@ Line 258: / Line 267: @@
 </div>
 <!-- Pod2Wiki=item_secure_session_key -->
-===secure_session_key===
+====secure_session_key====
   EPrints::DataObj::LoginTicket-&gt;secure_session_key($repo)

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
 This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/LoginTicket.pm|package_name=EPrints::DataObj::LoginTicket}}[[Category:API|LOGINTICKET]][[Category:API:EPrints/DataObj|LOGINTICKET]][[Category:API:EPrints/DataObj/LoginTicket|LOGINTICKET]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataObj/LoginTicket.pm|package_name=EPrints::DataObj::LoginTicket}}[[Category:API|LOGINTICKET]][[Category:API:EPrints/DataObj|LOGINTICKET]][[Category:API:EPrints/DataObj/LoginTicket|LOGINTICKET]]<div><!-- Edit below this comment -->

← Older revision	Revision as of 12:27, 1 December 2011
Line 1:	Line 1:
	+	<!-- Pod2Wiki=_preamble_
	+	This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
	+	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj/LoginTicket.pm\|package_name=EPrints::DataObj::LoginTicket}}[[Category:API\|LOGINTICKET]][[Category:API:EPrints/DataObj\|LOGINTICKET]][[Category:API:EPrints/DataObj/LoginTicket\|LOGINTICKET]]<div><!-- Edit below this comment -->

	+
	+	<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
	+	==NAME==
	+	'''EPrints::DataObj::LoginTicket''' - user system loginticket
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_description -->
	+	==DESCRIPTION==
	+	Login tickets are the database entries for the user's session cookies.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_configuration_settings -->
	+	===Configuration Settings===
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_user_cookie_timeout_undef -->
	+	====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 {{API:PodLink\|file=CGI\|package_name=CGI\|section=\|text=CGI}}'s cookie constructor. This allows settings like <tt>+1h</tt> and <tt>+7d</tt>.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_user_inactivity_timeout_86400_7 -->
	+	====user_inactivity_timeout = 86400 * 7====
	+
	+	How long to wait in seconds before logging the user out after their last activity.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_user_session_timeout_undef -->
	+	====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.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_methods -->
	+	==METHODS==
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_get_system_field_info -->
	+	===get_system_field_info===
	+
	+	$thing = EPrints::DataObj::Access->get_system_field_info
	+	Core fields.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_class_methods -->
	+	===Class Methods===
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_get_dataset_id -->
	+	====get_dataset_id====
	+
	+	$dataset = EPrints::DataObj::LoginTicket->get_dataset_id
	+	Returns the id of the [[API:EPrints/DataSet\|EPrints::DataSet]] object to which this record belongs.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_object_methods -->
	+	===Object Methods===
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_set_cookies -->
	+	====set_cookies====
	+
	+	$ticket->set_cookies()
	+	Set the session cookies for this login ticket.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=item_update -->
	+	====update====
	+
	+	$ticket->update()
	+	Update the login ticket by increasing the expiry time.
	+
	+	The expiry time is increased <tt>user_inactivity_timeout</tt> or 7 days.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_see_also -->
	+	==SEE ALSO==
	+	[[API:EPrints/DataObj\|EPrints::DataObj]] and [[API:EPrints/DataSet\|EPrints::DataSet]].
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=head_copyright -->
	+	==COPYRIGHT==
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<span style='display:none'>User Comments</span>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	</div>
	+	<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision		Revision as of 15:40, 12 August 2009
Line 1:		Line 1:
−	~~<!-- Pod2Wiki=_preamble_~~
−	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
−	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj/LoginTicket.pm\|package_name=EPrints::DataObj::LoginTicket}}[[Category:API\|LoginTicket]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~'''EPrints::DataObj::LoginTicket''' - user system loginticket~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
−	~~This is an internal class that shouldn't be used outside [[API:EPrints/Database\|EPrints::Database]].~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_methods -->=METHODS=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==~~
−
−	~~$thing = EPrints::DataObj::Access->get_system_field_info~~
−
−	~~Core fields.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new -->===new===~~
−
−	~~$thing = EPrints::DataObj::LoginTicket->new( $session, $id )~~
−
−	~~The data object identified by $id.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new_from_data -->===new_from_data===~~
−
−	~~$thing = EPrints::DataObj::LoginTicket->new_from_data( $session, $known )~~
−
−	~~A new <tt>EPrints::DataObj::LoginTicket</tt> object containing data $known (a hash reference).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_class_methods -->==Class Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_remove_all -->===remove_all===~~
−
−	~~EPrints::DataObj::LoginTicket::remove_all( $session )~~
−
−	~~Remove all records from the loginticket dataset.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_defaults -->===get_defaults===~~
−
−	~~$defaults = EPrints::DataObj::LoginTicket->get_defaults( $session, $data )~~
−
−	~~Return default values for this object based on the starting data.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_object_methods -->==Object Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_remove -->===remove===~~
−
−	~~$foo = $thing->remove()~~
−
−	~~Remove this record from the data set (see [[API:EPrints/Database\|EPrints::Database]]).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_see_also -->=SEE ALSO=~~
−	~~[[API:EPrints/DataObj\|EPrints::DataObj]] and [[API:EPrints/DataSet\|EPrints::DataSet]].~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~