Class JInput

Description

Joomla! Input Base Class

This is an abstracted input class used to manage retrieving data from the application environment.

  • method: integer getInt(): getInt($name, $default) Get a signed integer.
  • method: integer getUint(): getUint($name, $default) Get an unsigned integer.
  • method: float getFloat(): getFloat($name, $default) Get a floating-point number.
  • method: boolean getBool(): getBool($name, $default) Get a boolean.
  • method: string getWord(): getWord($name, $default)
  • method: string getAlnum(): getAlnum($name, $default)
  • method: string getCmd(): getCmd($name, $default)
  • method: string getBase64(): getBase64($name, $default)
  • method: string getString(): getString($name, $default)
  • method: string getHtml(): getHtml($name, $default)
  • method: string getPath(): getPath($name, $default)
  • method: string getUsername(): getUsername($name, $default)
  • since: 11.1

Located in /libraries/joomla/application/input.php (line 36)


	
			
Direct descendents
Class Description
JInputCLI Joomla! Input CLI Class
JInputFiles Joomla! Input Files Class
JInputCookie Joomla! Input Cookie Class
Variable Summary
Method Summary
JInput __construct ([array $source = null], [array $options = array()])
void def (string $name, mixed $value)
mixed get (string $name, [mixed $default = null], [string $filter = 'cmd'])
mixed getArray (array $vars, [mixed $datasource = null])
string getMethod ()
void set (string $name, mixed $value)
boolean __call (mixed $name, string $arguments)
JInput __get (mixed $name)
Variables
array $data = array() (line 60)

Input data.

  • since: 11.1
  • access: protected
JFilterInput $filter = null (line 52)

Filter object to use.

  • since: 11.1
  • access: protected
array $inputs = array() (line 68)

Input objects

  • since: 11.1
  • access: protected
array $options = array() (line 44)

Options array for the JInput instance.

  • since: 11.1
  • access: protected
Methods
Constructor __construct (line 78)

Constructor.

  • since: 11.1
  • access: public
JInput __construct ([array $source = null], [array $options = array()])
  • array $source: Source data (Optional, default is $_REQUEST)
  • array $options: Array of configuration parameters (Optional)

Redefined in descendants as:
def (line 223)

Define a value. The value will only be set if there's no value for the name or if it is null.

  • since: 12.1
  • access: public
void def (string $name, mixed $value)
  • string $name: Name of the value to define.
  • mixed $value: Value to assign to the input.
get (line 146)

Gets a value from the input data.

  • return: The filtered input value.
  • since: 11.1
  • access: public
mixed get (string $name, [mixed $default = null], [string $filter = 'cmd'])
  • string $name: Name of the value to get.
  • mixed $default: Default value to return if variable does not exist.
  • string $filter: Filter to apply to the value.

Redefined in descendants as:
getArray (line 166)

Gets an array of values from the request.

  • return: The filtered input data.
  • since: 11.1
  • access: public
mixed getArray (array $vars, [mixed $datasource = null])
  • array $vars: Associative array of keys and filter types to apply.
  • mixed $datasource: Array to retrieve data from, or null
getMethod (line 267)

Gets the request method.

  • return: The request method.
  • since: 11.1
  • access: public
string getMethod ()
set (line 208)

Sets a value

  • since: 11.1
  • access: public
void set (string $name, mixed $value)
  • string $name: Name of the value to set.
  • mixed $value: Value to assign to the input.

Redefined in descendants as:
__call (line 243)

Magic method to get filtered input data.

  • return: The filtered boolean input value.
  • since: 11.1
  • access: public
boolean __call (mixed $name, string $arguments)
  • mixed $name: Name of the value to get.
  • string $arguments: Default value to return if variable does not exist.
__get (line 111)

Magic method to get an input object

  • return: The request input object
  • since: 11.1
  • access: public
JInput __get (mixed $name)
  • mixed $name: Name of the input object to retrieve.

Documentation generated on Mon, 25 Jun 2012 13:55:49 -0500 by phpDocumentor 1.4.4