Solutions Open Source

Référence de la classe tslib_feUserAuth

Graphe d'héritage de tslib_feUserAuth:

[légende]

Graphe de collaboration de tslib_feUserAuth:

[légende]

Liste de tous les membres

Fonctions membres publiques

start ()

getNewSessionRecord ($tempuser)

isSetSessionCookie ()

isRefreshTimeBasedCookie ()

getLoginFormData ()

fetchGroupData ()

getUserTSconf ()

fetchSessionData ()

storeSessionData ()

getKey ($type, $key)

setKey ($type, $key, $data)

record_registration ($recs, $maxSizeOfSessionData=0)

Attributs publics

$session_table = 'fe_sessions'

$name = 'fe_typo_user'

$get_name = 'ftu'

$user_table = 'fe_users'

$username_column = 'username'

$userident_column = 'password'

$userid_column = 'uid'

$lastLogin_column = 'lastlogin'

$enablecolumns

$formfield_uname = 'user'

$formfield_uident = 'pass'

$formfield_chalvalue = 'challenge'

$formfield_status = 'logintype'

$formfield_permanent = 'permalogin'

$security_level = ''

$auth_include = ''

$auth_timeout_field = 6000

$lifetime = 0

$sendNoCacheHeaders = 0

$getFallBack = 1

$hash_length = 10

$getMethodEnabled = 1

$usergroup_column = 'usergroup'

$usergroup_table = 'fe_groups'

$groupData

$TSdataArray = array()

$userTS = array()

$userTSUpdated = 0

$showHiddenRecords = 0

$sesData = Array()

$sesData_change = 0

$userData_change = 0

Documentation des fonctions membres

tslib_feUserAuth::start ( )

Starts a user session

Renvoie:: void

Voir également:: t3lib_userAuth::start()

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::getNewSessionRecord ( $ tempuser )

Returns a new session record for the current user for insertion into the DB.

Renvoie:: array user session record

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::isSetSessionCookie ( )

Determins whether a session cookie needs to be set (lifetime=0)

Renvoie:: boolean

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::isRefreshTimeBasedCookie ( )

Determins whether a non-session cookie needs to be set (lifetime>0)

Renvoie:: boolean

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::getLoginFormData ( )

Returns an info array with Login/Logout data submitted by a form or params

Renvoie:: array

Voir également:: t3lib_userAuth::getLoginFormData()

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::fetchGroupData ( )

Will select all fe_groups records that the current fe_user is member of - and which groups are also allowed in the current domain. It also accumulates the TSconfig for the fe_user/fe_groups in ->TSdataArray

Renvoie:: integer Returns the number of usergroups for the frontend users (if the internal user record exists and the usergroup field contains a value)

tslib_feUserAuth::getUserTSconf ( )

Returns the parsed TSconfig for the fe_user First time this function is called it will parse the TSconfig and store it in $this->userTS. Subsequent requests will not re-parse the TSconfig but simply return what is already in $this->userTS

Renvoie:: array TSconfig array for the fe_user

tslib_feUserAuth::fetchSessionData ( )

Fetches the session data for the user (from the fe_session_data table) based on the ->id of the current user-session. The session data is restored to $this->sesData 1/100 calls will also do a garbage collection.

Renvoie:: void private

Voir également:: storeSessionData()

tslib_feUserAuth::storeSessionData ( )

Will write UC and session data. If the flag $this->userData_change has been set, the function ->writeUC is called (which will save persistent user session data) If the flag $this->sesData_change has been set, the fe_session_data table is updated with the content of $this->sesData (deleting any old record, inserting new)

Renvoie:: void

Voir également:: fetchSessionData(), getKey(), setKey()

tslib_feUserAuth::getKey	(	$	type,
		$	key
	)

Returns session data for the fe_user; Either persistent data following the fe_users uid/profile (requires login) or current-session based (not available when browse is closed, but does not require login)

Paramètres:

	string	Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
	string	Key from the data array to return; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines which key to return the value for.

Renvoie:: mixed Returns whatever value there was in the array for the key, $key

Voir également:: setKey()

tslib_feUserAuth::setKey	(	$	type,
		$	key,
		$	data
	)

Saves session data, either persistent or bound to current session cookie. Please see getKey() for more details. When a value is set the flags $this->userData_change or $this->sesData_change will be set so that the final call to ->storeSessionData() will know if a change has occurred and needs to be saved to the database. Notice: The key "recs" is already used by the function record_registration() which stores table/uid=value pairs in that key. This is used for the shopping basket among other things. Notice: Simply calling this function will not save the data to the database! The actual saving is done in storeSessionData() which is called as some of the last things in index_ts.php. So if you exit before this point, nothing gets saved of course! And the solution is to call $GLOBALS['TSFE']->storeSessionData(); before you exit.

Paramètres:

	string	Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
	string	Key from the data array to store incoming data in; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines in which key the $data value will be stored.
	mixed	The data value to store in $key

Renvoie:: void

Voir également:: setKey(), storeSessionData(), record_registration()

tslib_feUserAuth::record_registration	(	$	recs,
		$	maxSizeOfSessionData = `0`
	)

Registration of records/"shopping basket" in session data This will take the input array, $recs, and merge into the current "recs" array found in the session data. If a change in the recs storage happens (which it probably does) the function setKey() is called in order to store the array again.

Paramètres:

	array	The data array to merge into/override the current recs values. The $recs array is constructed as [table]][uid] = scalar-value (eg. string/integer).
	integer	The maximum size of stored session data. If zero, no limit is applied and even confirmation of cookie session is discarded.

Renvoie:: void

Documentation des données membres

tslib_feUserAuth::$session_table = 'fe_sessions'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$name = 'fe_typo_user'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$get_name = 'ftu'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$user_table = 'fe_users'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$username_column = 'username'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$userident_column = 'password'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$userid_column = 'uid'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$lastLogin_column = 'lastlogin'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$enablecolumns

Valeur initiale :

 Array (
                'deleted' => 'deleted',
                'disabled' => 'disable',
                'starttime' => 'starttime',
                'endtime' => 'endtime'
        )

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$formfield_uname = 'user'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$formfield_uident = 'pass'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$formfield_chalvalue = 'challenge'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$formfield_status = 'logintype'

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$formfield_permanent = 'permalogin'

tslib_feUserAuth::$security_level = ''

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$auth_include = ''

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$auth_timeout_field = 6000

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$lifetime = 0

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$sendNoCacheHeaders = 0

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$getFallBack = 1

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$hash_length = 10

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$getMethodEnabled = 1

Réimplémentée à partir de t3lib_userAuth.

tslib_feUserAuth::$usergroup_column = 'usergroup'

tslib_feUserAuth::$usergroup_table = 'fe_groups'

tslib_feUserAuth::$groupData

Valeur initiale :

 Array(
                'title' =>Array(),
                'uid' =>Array(),
                'pid' =>Array()
        )

tslib_feUserAuth::$TSdataArray = array()

tslib_feUserAuth::$userTS = array()

tslib_feUserAuth::$userTSUpdated = 0

tslib_feUserAuth::$showHiddenRecords = 0

tslib_feUserAuth::$sesData = Array()

tslib_feUserAuth::$sesData_change = 0

tslib_feUserAuth::$userData_change = 0

La documentation de cette classe a été générée à partir du fichier suivant :

Z:/doxygen/typo3_src-4.1.2/typo3/sysext/cms/tslib/class.tslib_feuserauth.php

Généré le Fri Aug 31 11:43:21 2007 pour OBLADY - Typo3 API v4.1.2 par

1.5.3


Fonctions membres publiques
	start ()
	getNewSessionRecord ($tempuser)
	isSetSessionCookie ()
	isRefreshTimeBasedCookie ()
	getLoginFormData ()
	fetchGroupData ()
	getUserTSconf ()
	fetchSessionData ()
	storeSessionData ()
	getKey ($type, $key)
	setKey ($type, $key, $data)
	record_registration ($recs, $maxSizeOfSessionData=0)
Attributs publics
	$session_table = 'fe_sessions'
	$name = 'fe_typo_user'
	$get_name = 'ftu'
	$user_table = 'fe_users'
	$username_column = 'username'
	$userident_column = 'password'
	$userid_column = 'uid'
	$lastLogin_column = 'lastlogin'
	$enablecolumns
	$formfield_uname = 'user'
	$formfield_uident = 'pass'
	$formfield_chalvalue = 'challenge'
	$formfield_status = 'logintype'
	$formfield_permanent = 'permalogin'
	$security_level = ''
	$auth_include = ''
	$auth_timeout_field = 6000
	$lifetime = 0
	$sendNoCacheHeaders = 0
	$getFallBack = 1
	$hash_length = 10
	$getMethodEnabled = 1
	$usergroup_column = 'usergroup'
	$usergroup_table = 'fe_groups'
	$groupData
	$TSdataArray = array()
	$userTS = array()
	$userTSUpdated = 0
	$showHiddenRecords = 0
	$sesData = Array()
	$sesData_change = 0
	$userData_change = 0