Actions

API15

JSession/getToken

From Joomla! Documentation

< API15:JSession
Revision as of 17:17, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

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

[Edit Descripton]

Description:JSession/getToken

Syntax

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

Returns

string The session token

Defined in

libraries/joomla/session/session.php

Importing

jimport( 'joomla.session.session' );

Source Body

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] SeeAlso:JSession/getToken

Examples

<CodeExamplesForm />