modules/loginticket/README.txt

$Id: README.txt,v 1.2.2.1 2007/05/11 13:11:47 jpetso Exp $

Login Ticket API -
Facilities for other modules to let people log in as Drupal user
as long as their login ticket is valid.


SHORT DESCRIPTION
-----------------
This is a pure API module, providing functions for generating login tickets.

A login ticket consists of an automatically generated pass code,
an expiration date, and a user who may log in with the pass code.
This module provides functions for generating, retrieving and deleting
login tickets, as well as checking validness of a given pass code and,
given a valid code (while not requiring username and password),
logging the concerned user in.

The Login Ticket API was designed to act as backend for modules like
Temporary Invitation and Site Pass, with less (but still some) parts of the API
being suitable for the Invite module as well.

For the API documentation, have a look at the module file or run phpdoc over it
to get a fancier version of the docs.


AUTHOR/MAINTAINER
-----------------
Jakob Petsovits <jpetso at gmx DOT at>


CREDITS
-------
Some code in Login Ticket was taken from the Site Pass module for Drupal 5.x
which was written by D R Pratten <http://www.davidpratten.com>.
1	$Id: README.txt,v 1.2.2.1 2007/05/11 13:11:47 jpetso Exp $
2
3	Login Ticket API -
4	Facilities for other modules to let people log in as Drupal user
5	as long as their login ticket is valid.
6
7
8	SHORT DESCRIPTION
9	-----------------
10	This is a pure API module, providing functions for generating login tickets.
11
12	A login ticket consists of an automatically generated pass code,
13	an expiration date, and a user who may log in with the pass code.
14	This module provides functions for generating, retrieving and deleting
15	login tickets, as well as checking validness of a given pass code and,
16	given a valid code (while not requiring username and password),
17	logging the concerned user in.
18
19	The Login Ticket API was designed to act as backend for modules like
20	Temporary Invitation and Site Pass, with less (but still some) parts of the API
21	being suitable for the Invite module as well.
22
23	For the API documentation, have a look at the module file or run phpdoc over it
24	to get a fancier version of the docs.
25
26
27	AUTHOR/MAINTAINER
28	-----------------
29	Jakob Petsovits <jpetso at gmx DOT at>
30
31
32	CREDITS
33	-------
34	Some code in Login Ticket was taken from the Site Pass module for Drupal 5.x
35	which was written by D R Pratten <http://www.davidpratten.com>.