API15:JRequest/setVar

2010-06-23T13:33:35Z

Listurlaugson:

===Description===
Set a variabe in one of the request variables

<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JRequest/setVar|Edit Descripton]]<nowiki>]</nowiki>
</span>

{{Description:JRequest/setVar}}

===Syntax===
<source lang="php">setVar($name, $value=null, $hash= 'method', $overwrite=true)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $name
|
| $name Name
|-
| $value
| null
| $value Value
|-
| $hash
| 'method'
| $hash Hash
|-
| $overwrite
| true
| $overwrite Boolean
|}

===Returns===
string Previous value

===Defined in===
libraries/joomla/environment/request.php
===Importing===
<source lang="php">jimport( 'joomla.environment.request' );</source>

===Source Body===
<source lang="php">
function setVar($name, $value = null, $hash = 'method', $overwrite = true)
{
//If overwrite is true, makes sure the variable hasn't been set yet
if(!$overwrite && array_key_exists($name, $_REQUEST)) {
return $_REQUEST[$name];
}

// Clean global request var
$GLOBALS['_JREQUEST'][$name] = array();

// Get the request hash value
$hash = strtoupper($hash);
if ($hash === 'METHOD') {
$hash = strtoupper($_SERVER['REQUEST_METHOD']);
}

$previous = array_key_exists($name, $_REQUEST) ? $_REQUEST[$name] : null;

switch ($hash)
{
case 'GET' :
$_GET[$name] = $value;
$_REQUEST[$name] = $value;
break;
case 'POST' :
$_POST[$name] = $value;
$_REQUEST[$name] = $value;
break;
case 'COOKIE' :
$_COOKIE[$name] = $value;
$_REQUEST[$name] = $value;
break;
case 'FILES' :
$_FILES[$name] = $value;
break;
case 'ENV' :
$_ENV['name'] = $value;
break;
case 'SERVER' :
$_SERVER['name'] = $value;
break;
}

// Mark this variable as 'SET'
$GLOBALS['_JREQUEST'][$name]['SET.'.$hash] = true;
$GLOBALS['_JREQUEST'][$name]['SET.REQUEST'] = true;

return $previous;
}
</source>

<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JRequest/setVar|Edit See Also]]<nowiki>]</nowiki>
</span>
{{SeeAlso:JRequest/setVar}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=setVar
category=JRequest
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

Joomla! Documentation - User contributions [en]

API15:JRequest/setVar