1. class
  2. Joomla
  3. CMS
  4. Input
  5. Files

Files

class Files extends Input

Joomla! Input Files Class

Methods

__construct( array $source = null, array $options = array())

The class constructor.

Input
__get( mixed $name)

Magic method to get an input object

from Input
mixed
getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

from Input
Input
unserialize( string $input)

Method to unserialize the input.

from Input
mixed
get( string $name, mixed $default = null, string $filter = 'cmd')

Gets a value from the input data.

void
set( string $name, mixed $value)

Sets a value.

Details

__construct( array $source = null, array $options = array())

The class constructor.

Parameters

array $source Source data (Optional, default is $_REQUEST)
array $options Array of configuration parameters (Optional)

Input __get( mixed $name)

Magic method to get an input object

Parameters

mixed $name Name of the input object to retrieve.

Return Value

Input The request input object

mixed getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

Parameters

array $vars Associative array of keys and filter types to apply. If empty and datasource is null, all the input data will be returned but filtered using the filter given by the parameter defaultFilter in JFilterInput::clean.
mixed $datasource Array to retrieve data from, or null.
string $defaultFilter Default filter used in JFilterInput::clean if vars is empty and datasource is null. If 'unknown', the default case is used in JFilterInput::clean.

Return Value

mixed The filtered input data.

Input unserialize( string $input)

Method to unserialize the input.

Parameters

string $input The serialized input.

Return Value

Input The input object.

mixed get( string $name, mixed $default = null, string $filter = 'cmd')

Gets a value from the input data.

Parameters

string $name The name of the input property (usually the name of the files INPUT tag) to get.
mixed $default The default value to return if the named property does not exist.
string $filter The filter to apply to the value.

Return Value

mixed The filtered input value.

See also

JFilterInput::clean()

void set( string $name, mixed $value)

Sets a value.

Parameters

string $name The name of the input property to set.
mixed $value The value to assign to the input property.

Return Value

void