JSession/getToken: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 4: | Line 4: | ||
===Syntax=== | ===Syntax=== | ||
| Line 45: | Line 45: | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=getToken | category=getToken | ||
category=JSession | category=JSession | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
Latest revision as of 02:03, 25 March 2017
Description
Get a session token, if a token isn't set yet one will be generated.
Syntax
getToken($forceNew=false)
| Parameter Name | Default Value | Description |
|---|---|---|
| $forceNew | false | If true, force a new token to be created |
Returns
string The session token
Defined in
libraries/joomla/session/session.php
Importing
jimport( 'joomla.session.session' );
Source Body
public function getToken($forceNew = false)
{
$token = $this->get('session.token');
//create a token
if ($token === null || $forceNew) {
$token = $this->_createToken(12);
$this->set('session.token', $token);
}
return $token;
}
Examples
Code Examples