JsonDescriptor Class Reference

Inheritance diagram for JsonDescriptor:

Protected Member Functions
	describeInputArgument (InputArgument $argument, array $options=array())
	describeInputOption (InputOption $option, array $options=array())
	describeInputDefinition (InputDefinition $definition, array $options=array())
	describeCommand (Command $command, array $options=array())
	describeApplication (Application $application, array $options=array())
Protected Member Functions inherited from Descriptor
	write ($content, $decorated=false)
	describeInputArgument (InputArgument $argument, array $options=array())
	describeInputOption (InputOption $option, array $options=array())
	describeInputDefinition (InputDefinition $definition, array $options=array())
	describeCommand (Command $command, array $options=array())
	describeApplication (Application $application, array $options=array())

Private Member Functions
	writeData (array $data, array $options)
	getInputArgumentData (InputArgument $argument)
	getInputOptionData (InputOption $option)
	getInputDefinitionData (InputDefinition $definition)
	getCommandData (Command $command)

Additional Inherited Members
Public Member Functions inherited from Descriptor
	describe (OutputInterface $output, $object, array $options=array())

Detailed Description

JSON descriptor.

Author

Jean-François Simon conta.nosp@m.ct@j.nosp@m.fsimo.nosp@m.n.fr

Definition at line 27 of file JsonDescriptor.php.

Member Function Documentation

describeApplication ( Application  $application, array  $options = array()  )

protected

{}

Definition at line 64 of file JsonDescriptor.php.

References JsonDescriptor\getCommandData(), and JsonDescriptor\writeData().

describeCommand ( Command  $command, array  $options = array()  )

protected

{}

Definition at line 56 of file JsonDescriptor.php.

References JsonDescriptor\getCommandData(), and JsonDescriptor\writeData().

describeInputArgument ( InputArgument  $argument, array  $options = array()  )

protected

{}

Definition at line 32 of file JsonDescriptor.php.

References JsonDescriptor\getInputArgumentData(), and JsonDescriptor\writeData().

describeInputDefinition ( InputDefinition  $definition, array  $options = array()  )

protected

{}

Definition at line 48 of file JsonDescriptor.php.

References JsonDescriptor\getInputDefinitionData(), and JsonDescriptor\writeData().

describeInputOption ( InputOption  $option, array  $options = array()  )

protected

{}

Definition at line 40 of file JsonDescriptor.php.

References JsonDescriptor\getInputOptionData(), and JsonDescriptor\writeData().

getCommandData ( Command  $command )

private

Parameters

Command

$command

Returns

array

Definition at line 153 of file JsonDescriptor.php.

References Command\getAliases(), Command\getDescription(), JsonDescriptor\getInputDefinitionData(), Command\getName(), Command\getNativeDefinition(), Command\getProcessedHelp(), Command\getSynopsis(), Command\getUsages(), and Command\mergeApplicationDefinition().

Referenced by JsonDescriptor\describeApplication(), and JsonDescriptor\describeCommand().

getInputArgumentData ( InputArgument  $argument )

private

Parameters

InputArgument

$argument

Returns

array

Definition at line 99 of file JsonDescriptor.php.

References InputArgument\getDefault(), InputArgument\getDescription(), InputArgument\getName(), InputArgument\isArray(), and InputArgument\isRequired().

Referenced by JsonDescriptor\describeInputArgument(), and JsonDescriptor\getInputDefinitionData().

getInputDefinitionData ( InputDefinition  $definition )

private

Parameters

InputDefinition

$definition

Returns

array

Definition at line 133 of file JsonDescriptor.php.

References InputDefinition\getArguments(), JsonDescriptor\getInputArgumentData(), JsonDescriptor\getInputOptionData(), and InputDefinition\getOptions().

Referenced by JsonDescriptor\describeInputDefinition(), and JsonDescriptor\getCommandData().

getInputOptionData ( InputOption  $option )

private

Parameters

InputOption

$option

Returns

array

Definition at line 115 of file JsonDescriptor.php.

References InputOption\acceptValue(), InputOption\getDefault(), InputOption\getDescription(), InputOption\getName(), InputOption\getShortcut(), InputOption\isArray(), and InputOption\isValueRequired().

Referenced by JsonDescriptor\describeInputOption(), and JsonDescriptor\getInputDefinitionData().

writeData ( array  $data, array  $options  )

private

Writes data as json.

Parameters

array	$data
array	$options

Returns

array|string

Definition at line 89 of file JsonDescriptor.php.

References Descriptor\write().

Referenced by JsonDescriptor\describeApplication(), JsonDescriptor\describeCommand(), JsonDescriptor\describeInputArgument(), JsonDescriptor\describeInputDefinition(), and JsonDescriptor\describeInputOption().