[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/environment/ -> request.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: request.php 14401 2010-01-26 14:10:00Z louis $
File Size: 596 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JRequest:: (17 methods):
  getURI()
  getMethod()
  getVar()
  getInt()
  getFloat()
  getBool()
  getWord()
  getCmd()
  getString()
  setVar()
  get()
  set()
  checkToken()
  clean()
  _cleanArray()
  _cleanVar()
  _stripSlashesRecursive()


Class: JRequest  - X-Ref

JRequest Class

This class serves to provide the Joomla Framework with a common interface to access
request variables.  This includes $_POST, $_GET, and naturally $_REQUEST.  Variables
can be passed through an input filter to avoid injection or returned raw.

getURI()   X-Ref
Gets the full request path

return: string

getMethod()   X-Ref
Gets the request method

return: string

getVar($name, $default = null, $hash = 'default', $type = 'none', $mask = 0)   X-Ref
Fetches and returns a given variable.

The default behaviour is fetching variables depending on the
current request method: GET and HEAD will result in returning
an entry from $_GET, POST and PUT will result in returning an
entry from $_POST.

You can force the source by setting the $hash parameter:

post        $_POST
get        $_GET
files        $_FILES
cookie        $_COOKIE
env        $_ENV
server        $_SERVER
method        via current $_SERVER['REQUEST_METHOD']
default    $_REQUEST

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
param: string    $type        Return type for the variable, for valid values see {@link JFilterInput::clean()}
param: int        $mask        Filter mask for the variable
return: mixed    Requested variable

getInt($name, $default = 0, $hash = 'default')   X-Ref
Fetches and returns a given filtered variable. The integer
filter will allow only digits to be returned. This is currently
only a proxy function for getVar().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
return: integer    Requested variable

getFloat($name, $default = 0.0, $hash = 'default')   X-Ref
Fetches and returns a given filtered variable.  The float
filter only allows digits and periods.  This is currently
only a proxy function for getVar().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
return: float    Requested variable

getBool($name, $default = false, $hash = 'default')   X-Ref
Fetches and returns a given filtered variable. The bool
filter will only return true/false bool values. This is
currently only a proxy function for getVar().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
return: bool        Requested variable

getWord($name, $default = '', $hash = 'default')   X-Ref
Fetches and returns a given filtered variable. The word
filter only allows the characters [A-Za-z_]. This is currently
only a proxy function for getVar().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
return: string    Requested variable

getCmd($name, $default = '', $hash = 'default')   X-Ref
Fetches and returns a given filtered variable. The cmd
filter only allows the characters [A-Za-z0-9.-_]. This is
currently only a proxy function for getVar().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
return: string    Requested variable

getString($name, $default = '', $hash = 'default', $mask = 0)   X-Ref
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().

See getVar() for more in-depth documentation on the parameters.

param: string    $name        Variable name
param: string    $default    Default value if the variable does not exist
param: string    $hash        Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
param: int        $mask        Filter mask for the variable
return: string    Requested variable

setVar($name, $value = null, $hash = 'method', $overwrite = true)   X-Ref
Set a variabe in on of the request variables

param: string    $name        Name
param: string    $value        Value
param: string    $hash        Hash
param: boolean    $overwrite    Boolean
return: string    Previous value

get($hash = 'default', $mask = 0)   X-Ref
Fetches and returns a request array.

The default behaviour is fetching variables depending on the
current request method: GET and HEAD will result in returning
$_GET, POST and PUT will result in returning $_POST.

You can force the source by setting the $hash parameter:

post        $_POST
get        $_GET
files        $_FILES
cookie        $_COOKIE
env        $_ENV
server        $_SERVER
method        via current $_SERVER['REQUEST_METHOD']
default    $_REQUEST

param: string    $hash    to get (POST, GET, FILES, METHOD)
param: int        $mask    Filter mask for the variable
return: mixed    Request hash

set( $array, $hash = 'default', $overwrite = true )   X-Ref
Sets a request variable

param: array    An associative array of key-value pairs
param: string    The request variable to set (POST, GET, FILES, METHOD)
param: boolean    If true and an existing key is found, the value is overwritten, otherwise it is ingored

checkToken( $method = 'post' )   X-Ref
Checks for a form token in the request

Use in conjuction with JHTML::_( 'form.token' )

param: string    The request method in which to look for the token key
return: boolean    True if found and valid, false otherwise

clean()   X-Ref
Cleans the request from script injection.

return: void

_cleanArray( &$array, $globalise=false )   X-Ref
Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked

param: array    $array    Array to clean
param: boolean    True if the array is to be added to the GLOBALS

_cleanVar($var, $mask = 0, $type=null)   X-Ref
Clean up an input variable.

param: mixed The input variable.
param: int Filter bit mask. 1=no trim: If this flag is cleared and the
param: string The variable type {@see JFilterInput::clean()}.

_stripSlashesRecursive( $value )   X-Ref
Strips slashes recursively on an array

param: array    $array        Array of (nested arrays of) strings
return: array    The input array with stripshlashes applied to it



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1