API16

JSession/getToken: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Get a session token, if a token isn't set yet one will be generated. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JSession/getTo...
 
m clean up
Line 2: Line 2:
Get a session token, if a token isn't set yet one will be generated.
Get a session token, if a token isn't set yet one will be generated.


<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JSession/getToken|Edit Descripton]]<nowiki>]</nowiki>
</span>


{{Description:JSession/getToken}}
 
{{subst:Description:JSession/getToken}}


===Syntax===
===Syntax===
Line 46: Line 44:
</source>
</source>


<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JSession/getToken|Edit See Also]]<nowiki>]</nowiki>
{{subst:SeeAlso:JSession/getToken}}
</span>
{{SeeAlso:JSession/getToken}}


===Examples===
===Examples===

Revision as of 14:23, 24 March 2017

Description

Get a session token, if a token isn't set yet one will be generated.


{{subst:Description:JSession/getToken}}

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;
}


{{subst:SeeAlso:JSession/getToken}}

Examples

<CodeExamplesForm />