Joomla! API

Download
Launch

Input

Implements Countable

Joomla! Input Base Class

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

since

1.0
property-read Input
package

Joomla Framework

Methods

__call

Magic method to get filtered input data.

__call(string name, array arguments) : mixed
since

1.0

Arguments

name

stringName of the filter type prefixed with 'get'.

arguments

array[0] The name of the variable [1] The default value.

Response

mixedThe filtered input value.

__construct

Constructor.

__construct(array|null source = null, array options = []) : mixed
since

1.0

Arguments

source

array|nullOptional source data. If omitted, a copy of the server variable '_REQUEST' is used.

options

arrayAn optional associative array of configuration parameters: filter: An instance of Filter\Input. If omitted, a default filter is initialised.

Response

mixed

__get

Magic method to get an input object

__get(mixed name) : \Joomla\Input\Input
since

1.0

Arguments

name

mixedName of the input object to retrieve.

Response

\Joomla\Input\InputThe request input object

count

Get the number of variables.

count() : int
since

1.0
see Countable::count()

Response

intThe number of variables in the input.

def

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

def(string name, mixed value) : void
since

1.0

Arguments

name

stringName of the value to define.

value

mixedValue to assign to the input.

exists

Check if a value name exists.

exists(string name) : bool
since

1.2.0

Arguments

name

stringValue name

Response

bool

get

Gets a value from the input data.

get(string name, mixed default = null, string filter = 'cmd') : mixed
see InputFilter::clean()
since

1.0

Arguments

name

stringName of the value to get.

default

mixedDefault value to return if variable does not exist.

filter

stringFilter to apply to the value.

Response

mixedThe filtered input value.

getAlnum

getAlnum(mixed name, mixed default) : string

Get an alphanumeric string.

Arguments

name

mixed

default

mixed

Response

string

getArray

Gets an array of values from the request.

getArray(array vars = [], mixed datasource = null) : mixed
since

1.0

Arguments

vars

arrayAssociative 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 default case in InputFilter::clean.

datasource

mixedArray to retrieve data from, or null

Response

mixedThe filtered input data.

getBase64

getBase64(mixed name, mixed default) : string

Get a base64 encoded string.

Arguments

name

mixed

default

mixed

Response

string

getBool

getBool(mixed name, mixed default) : bool

Get a boolean value.

Arguments

name

mixed

default

mixed

Response

bool

getCmd

getCmd(mixed name, mixed default) : string

Get a CMD filtered string.

Arguments

name

mixed

default

mixed

Response

string

getFloat

getFloat(mixed name, mixed default) : float

Get a floating-point number.

Arguments

name

mixed

default

mixed

Response

float

getHtml

getHtml(mixed name, mixed default) : string

Get a HTML string.

Arguments

name

mixed

default

mixed

Response

string

getInputForRequestMethod

Get the Input instance holding the data for the current request method

getInputForRequestMethod() : \Joomla\Input\Input
since

1.3.0

Response

\Joomla\Input\Input

getInt

getInt(mixed name, mixed default) : int

Get a signed integer.

Arguments

name

mixed

default

mixed

Response

int

getMethod

Gets the request method.

getMethod() : string
since

1.0

Response

stringThe request method.

getPath

getPath(mixed name, mixed default) : string

Get a file path.

Arguments

name

mixed

default

mixed

Response

string

getRaw

getRaw(mixed name, mixed default) : mixed

Get an unfiltered value.

Arguments

name

mixed

default

mixed

Response

mixed

getString

getString(mixed name, mixed default) : string

Get a string.

Arguments

name

mixed

default

mixed

Response

string

getUint

getUint(mixed name, mixed default) : int

Get an unsigned integer.

Arguments

name

mixed

default

mixed

Response

int

getUsername

getUsername(mixed name, mixed default) : string

Get a username.

Arguments

name

mixed

default

mixed

Response

string

getWord

getWord(mixed name, mixed default) : string

Get a word.

Arguments

name

mixed

default

mixed

Response

string

set

Sets a value

set(string name, mixed value) : void
since

1.0

Arguments

name

stringName of the value to set.

value

mixedValue to assign to the input.

Constants

ALLOWED_GLOBALS

Container with allowed superglobals

Value ['REQUEST', 'GET', 'POST', 'FILES', 'SERVER', 'ENV']
since

1.3.0

Type(s)

array

Properties

options

Options array for the Input instance.

since

1.0

Type(s)

array

filter

Filter object to use.

since

1.0

Type(s)

\Joomla\Filter\InputFilter

data

Input data.

since

1.0

Type(s)

array

inputs

Input objects

since

1.0

Type(s)

\Joomla\Input\Input[]

get

Type(s)

\Joomla\Input\Input

post

Type(s)

\Joomla\Input\Input

request

Type(s)

\Joomla\Input\Input

server

Type(s)

\Joomla\Input\Input

env

Type(s)

\Joomla\Input\Input

files

Type(s)

\Joomla\Input\Files

cookie

Type(s)

\Joomla\Input\Cookie
  • \ Joomla
  • \ Input
  • \ Input