Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JInputCli
+ Graphe d'héritage de JInputCli:
+ Graphe de collaboration de JInputCli:

Liste de tous les membres

Fonctions membres publiques

 __construct (array $source=null, array $options=array())
 serialize ()
 unserialize ($input)
- Fonctions membres publiques inherited from JInput
 __construct ($source=null, array $options=array())
 __get ($name)
 count ()
 get ($name, $default=null, $filter= 'cmd')
 getArray (array $vars=array(), $datasource=null)
 set ($name, $value)
 def ($name, $value)
 __call ($name, $arguments)
 getMethod ()

Attributs publics

 $executable
 $args = array()

Fonctions membres protégées

 parseArguments ()
- Fonctions membres protégées inherited from JInput
 loadAllInputs ()

Additional Inherited Members

- Attributs protégés inherited from JInput
 $options = array()
 $filter = null
 $data = array()
 $inputs = array()

Description détaillée

Définition à la ligne 19 du fichier cli.php.


Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:
array$sourceSource data (Optional, default is $_REQUEST)
array$optionsArray of configuration parameters (Optional)
Depuis:
11.1

Définition à la ligne 46 du fichier cli.php.

Références JFilterInput\getInstance().

{
if (isset($options['filter']))
{
$this->filter = $options['filter'];
}
else
{
$this->filter = JFilterInput::getInstance();
}
// Get the command line options
$this->parseArguments();
// Set the options for the class.
$this->options = $options;
}

+ Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JInputCli::parseArguments ( )
protected

Initialise the options and arguments

Not supported: -abc c-value

Renvoie:
void
Depuis:
11.1

Définition à la ligne 119 du fichier cli.php.

{
$argv = $_SERVER['argv'];
$this->executable = array_shift($argv);
$out = array();
for ($i = 0, $j = count($argv); $i < $j; $i++)
{
$arg = $argv[$i];
// --foo --bar=baz
if (substr($arg, 0, 2) === '--')
{
$eqPos = strpos($arg, '=');
// --foo
if ($eqPos === false)
{
$key = substr($arg, 2);
// --foo value
if ($i + 1 < $j && $argv[$i + 1][0] !== '-')
{
$value = $argv[$i + 1];
$i++;
}
else
{
$value = isset($out[$key]) ? $out[$key] : true;
}
$out[$key] = $value;
}
// --bar=baz
else
{
$key = substr($arg, 2, $eqPos - 2);
$value = substr($arg, $eqPos + 1);
$out[$key] = $value;
}
}
elseif (substr($arg, 0, 1) === '-')
// -k=value -abc
{
// -k=value
if (substr($arg, 2, 1) === '=')
{
$key = substr($arg, 1, 1);
$value = substr($arg, 3);
$out[$key] = $value;
}
else
// -abc
{
$chars = str_split(substr($arg, 1));
foreach ($chars as $char)
{
$key = $char;
$value = isset($out[$key]) ? $out[$key] : true;
$out[$key] = $value;
}
// -a a-value
if ((count($chars) === 1) && ($i + 1 < $j) && ($argv[$i + 1][0] !== '-'))
{
$out[$key] = $argv[$i + 1];
$i++;
}
}
}
else
{
// Plain-arg
$this->args[] = $arg;
}
}
$this->data = $out;
}
JInputCli::serialize ( )

Method to serialize the input.

Renvoie:
string The serialized input.
Depuis:
12.1

Réimplémentée à partir de JInput.

Définition à la ligne 71 du fichier cli.php.

{
// Load all of the inputs.
$this->loadAllInputs();
// Remove $_ENV and $_SERVER from the inputs.
unset($inputs['env']);
unset($inputs['server']);
// Serialize the executable, args, options, data, and inputs.
return serialize(array($this->executable, $this->args, $this->options, $this->data, $inputs));
}
JInputCli::unserialize (   $input)

Method to unserialize the input.

Paramètres:
string$inputThe serialized input.
Renvoie:
JInput The input object.
Depuis:
12.1

Réimplémentée à partir de JInput.

Définition à la ligne 94 du fichier cli.php.

Références JFilterInput\getInstance().

{
// Unserialize the executable, args, options, data, and inputs.
list($this->executable, $this->args, $this->options, $this->data, $this->inputs) = unserialize($input);
// Load the filter.
if (isset($this->options['filter']))
{
$this->filter = $this->options['filter'];
}
else
{
$this->filter = JFilterInput::getInstance();
}
}

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JInputCli::$args = array()

Définition à la ligne 36 du fichier cli.php.

JInputCli::$executable

Définition à la ligne 27 du fichier cli.php.


La documentation de cette classe a été générée à partir du fichier suivant :