API16:JRequest/getString

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.

Description

Fetches and returns a given filtered variable. The string filter deletes 'bad' HTML code, if not overridden by the mask. This is currently only a proxy function for getVar().

Syntax

static getString($name, $default= '', $hash= 'default', $mask=0)

Parameter Name	Default Value	Description
$name		$name Variable name
$default		$default Default value if the variable does not exist
$hash	'default'	$hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
$mask	0	$mask Filter mask for the variable

Returns

string Requested variable

Defined in

libraries/joomla/environment/request.php

Importing

jimport( 'joomla.environment.request' );

Source Body

public static function getString($name, $default = '', $hash = 'default', $mask = 0)
{
        // Cast to string, in case JREQUEST_ALLOWRAW was specified for mask
        return (string) self::getVar($name, $default, $hash, 'string', $mask);
}

Examples

<CodeExamplesForm />