API16

API16:JSession/getToken

From Joomla! Documentation

Revision as of 22:42, 22 March 2010 by 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...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

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

[Edit Descripton]

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

[Edit See Also] Template:SeeAlso:JSession/getToken

Examples

<CodeExamplesForm />