Cli

Extends \Joomla\CMS\Input\Input

Joomla! Input CLI Class

deprecated

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

since

1.7.0

deprecated

5.0 Use the joomla/console package instead

Methods

__construct

Constructor.

__construct(array $source = null, array $options = array()) 
inherited deprecated
since

1.7.0

deprecated

5.0 Use Joomla\Input\Input instead

Arguments

$source

arraySource data (Optional, default is $_REQUEST)

$options

arrayArray of configuration parameters (Optional)

__get

Magic method to get an input object

__get(mixed $name) : \Joomla\Input\Input
inherited deprecated
since

1.7.0

deprecated

5.0 Use Joomla\Input\Input instead

Arguments

$name

mixedName of the input object to retrieve.

Response

\Joomla\Input\InputThe request input object

getArray

Gets an array of values from the request.

getArray(array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown') : mixed
inherited deprecated
since

1.7.0

deprecated

5.0 Use Joomla\Input\Input instead

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 filter given by the parameter defaultFilter in InputFilter::clean.

$datasource

mixedArray to retrieve data from, or null.

$defaultFilter

stringDefault filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.

Response

mixedThe filtered input data.

getArrayRecursive

Gets an array of values from the request.

getArrayRecursive(array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown', boolean $recursion = false) : mixed
inherited deprecated
since

3.4.2

deprecated

5.0 Use Joomla\Input\Input instead

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 filter given by the parameter defaultFilter in InputFilter::clean.

$datasource

mixedArray to retrieve data from, or null.

$defaultFilter

stringDefault filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.

$recursion

booleanFlag to indicate a recursive function call.

Response

mixedThe filtered input data.

parseArguments

Initialise the options and arguments

parseArguments() : void
deprecated

Not supported: -abc c-value

since

1.7.0

deprecated

5.0 Use the joomla/console package instead

serialize

Method to serialize the input.

serialize() : string
deprecated
since

3.0.0

deprecated

5.0 Use the joomla/console package instead

Response

stringThe serialized input.

unserialize

Method to unserialize the input.

unserialize(string $input) : \Joomla\CMS\Input\Input
inherited deprecated
since

3.0.0

deprecated

5.0 Use Joomla\Input\Input instead

Arguments

$input

stringThe serialized input.

Response

\Joomla\CMS\Input\InputThe input object.

Properties

executable

The executable that was called to run the CLI script.

deprecated
since

1.7.0

deprecated

5.0 Use the joomla/console package instead

Type(s)

string

args

The additional arguments passed to the script that are not associated with a specific argument name.

deprecated
since

1.7.0

deprecated

5.0 Use the joomla/console package instead

Type(s)

array

allowedGlobals

Container with allowed superglobals

inherited static deprecated
since

3.8.9

deprecated

5.0 Use Joomla\Input\Input instead

Type(s)

array

inputs

Input objects

inherited deprecated
since

1.7.0

deprecated

5.0 Use Joomla\Input\Input instead

Type(s)

array<mixed,\Joomla\CMS\Input\Input>

get

inherited

Type(s)

\Joomla\CMS\Input\Input

post

inherited

Type(s)

\Joomla\CMS\Input\Input

request

inherited

Type(s)

\Joomla\CMS\Input\Input

server

inherited

Type(s)

\Joomla\CMS\Input\Input

env

inherited

Type(s)

\Joomla\CMS\Input\Input

files

inherited

Type(s)

\Joomla\CMS\Input\Files