API16:JRequest/checkToken

Description

Checks for a form token in the request.

{{subst:Description:JRequest/checkToken}}

Syntax

static checkToken($method= 'post')

Parameter Name	Default Value	Description
$method	'post'	The request method in which to look for the token key.

Returns

boolean True if found and valid, false otherwise.

Defined in

libraries/joomla/environment/request.php

Importing

jimport( 'joomla.environment.request' );

Source Body

public static function checkToken($method = 'post')
{
        $token = JUtility::getToken();
        if (!self::getVar($token, '', $method, 'alnum'))
        {
                $session = JFactory::getSession();
                if ($session->isNew()) {
                        // Redirect to login screen.
                        $app = &JFactory::getApplication();
                        $return = JRoute::_('index.php');
                        $app->redirect($return, JText::_('SESSION_EXPIRED'));
                        $app->close();
                } else {
                        return false;
                }
        } else {
                return true;
        }
}

{{subst:SeeAlso:JRequest/checkToken}}

Examples

<CodeExamplesForm />