Référence de la classe ApplicationDescription

Fonctions membres publiques
	__construct (Application $application, string $namespace='', bool $showHidden=false)
	getNamespaces ()
	getCommands ()
	getCommand (string $name)

Champs de données
const	GLOBAL_NAMESPACE = '_global'

Fonctions membres privées
	extractNamespace (string $name, ?int $limit=null)
	inspectApplication ()
	sortCommands (array $commands)

Attributs privés
	$aliases
	$application
	$commands
	$namespace = ''
	$namespaces
	$showHidden

Description détaillée

Describes an application.

Depuis

2.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	Application	$application,
		string	$namespace = '',
		bool	$showHidden = false
	)

Constructor.

Paramètres

Application	$application	The application being described.
string	$namespace	The command namespace to process.
boolean	$showHidden	Flag indicating hidden commands should be displayed.

Depuis

2.0.0

Références ApplicationDescription\$application, ApplicationDescription\$namespace, et ApplicationDescription\$showHidden.

Documentation des fonctions membres

extractNamespace()

extractNamespace ( string  $name, ?int  $limit = null  )

private

Returns the namespace part of the command name.

Paramètres

string	$name	The command name to process
integer	$limit	The maximum number of parts of the namespace

Renvoie

string

Depuis

2.0.0

Références $limit, $name, $parts, et null.

Référencé par ApplicationDescription\sortCommands().

getCommand()

getCommand

(

string

$name

)

Get a command by name.

Paramètres

string

$name

The name of the command to retrieve.

Renvoie

AbstractCommand

Depuis

2.0.0

Exceptions

CommandNotFoundException

Références $name.

getCommands()

getCommands

(

)

Get the application's commands.

Renvoie

AbstractCommand[]

Depuis

2.0.0

Références ApplicationDescription\$commands, ApplicationDescription\inspectApplication(), et null.

getNamespaces()

getNamespaces

(

)

Get the application's command namespaces.

Renvoie

array[]

Depuis

2.0.0

Références ApplicationDescription\$namespaces, ApplicationDescription\inspectApplication(), et null.

inspectApplication()

inspectApplication ( )

private

Inspects the application.

Renvoie

void

Depuis

2.0.0

Références ApplicationDescription\$commands, $name, $names, ApplicationDescription\$namespace, $this, et ApplicationDescription\sortCommands().

Référencé par ApplicationDescription\getCommands(), et ApplicationDescription\getNamespaces().

sortCommands()

sortCommands ( array  $commands )

private

Sort a set of commands.

Paramètres

AbstractCommand[]

$commands The commands to sort.

Renvoie

AbstractCommand[][]

Depuis

2.0.0

Références ApplicationDescription\$commands, $key, $name, et ApplicationDescription\extractNamespace().

Référencé par ApplicationDescription\inspectApplication().

Documentation des champs

$aliases

$aliases

private

$application

$application

private

Référencé par ApplicationDescription\__construct().

$commands

$commands

private

Référencé par ApplicationDescription\getCommands(), ApplicationDescription\inspectApplication(), et ApplicationDescription\sortCommands().

$namespace

$namespace = ''

private

Référencé par ApplicationDescription\__construct(), et ApplicationDescription\inspectApplication().

$namespaces

$namespaces

private

Référencé par ApplicationDescription\getNamespaces().

$showHidden

$showHidden

private

Référencé par ApplicationDescription\__construct().

GLOBAL_NAMESPACE

const GLOBAL_NAMESPACE = '_global'

Référencé par TextDescriptor\describeJoomlaApplication().

---

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

• joomla/console/src/Descriptor/ApplicationDescription.php