Actions

API16

JRequest/checkToken

From Joomla! Documentation

< API16:JRequest
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

Checks for a form token in the request.

[Edit Descripton]

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

[Edit See Also] SeeAlso:JRequest/checkToken

Examples

<CodeExamplesForm />