\JInputCli

Joomla! Input CLI Class

Synopsis

class JInputCli extends JInput {

• // members
• public  $executable;
• public  $args;
• // Inherited members from JInput
• protected  $options;
• protected JFilterInput  $filter;
• protected  $data;
• protected  $inputs;
• // methods
• public void __construct()
• public string serialize()
• public JInput unserialize()
• protected void parseArguments()
• // Inherited methods from JInput
• public void __construct()
• public JInput __get()
• public integer count()
• public mixed get()
• public mixed getArray()
• public void set()
• public void def()
• public mixed __call()
• public string getMethod()
• public string serialize()
• public JInput unserialize()
• protected void loadAllInputs()
}


Hierarchy

Extends

• JInput

Members

protected

• $data — array
  Input data.
• $filter — JFilterInput
  Filter object to use.
• $inputs — array
  Input objects
• $options — array
  Options array for the JInput instance.

public

• $args — array
  The additional arguments passed to the script that are not associated with a specific argument name.
• $executable — string
  The executable that was called to run the CLI script.

Methods

protected

• parseArguments() — Initialise the options and arguments

public

• __construct() — Constructor.
• serialize() — Method to serialize the input.
• unserialize() — Method to unserialize the input.

Inherited from JInput

protected

• loadAllInputs() — Method to load all of the global inputs.

public

• __call() — Magic method to get filtered input data.
• __get() — Magic method to get an input object
• count() — Get the number of variables.
• def() — Define a value. The value will only be set if there's no value for the name or if it is null.
• get() — Gets a value from the input data.
• getArray() — Gets an array of values from the request.
• getMethod() — Gets the request method.
• serialize() — Method to serialize the input.
• set() — Sets a value
• unserialize() — Method to unserialize the input.