API16

JSession/getToken

From Joomla! Documentation

< API16:JSession

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

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



Syntax[edit]

getToken($forceNew=false)
Parameter Name Default Value Description
$forceNew false If true, force a new token to be created

Returns[edit]

string The session token

Defined in[edit]

libraries/joomla/session/session.php

Importing[edit]

jimport( 'joomla.session.session' );

Source Body[edit]

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[edit]

Code Examples[edit]