ParseCommand

Extends \phpDocumentor\Command\Command

Parses the given source code and creates a structure file.

The parse task uses the source files defined either by -f or -d options and generates a structure file (structure.xml) at the target location (which is the folder 'output' unless the option -t is provided).

package

Default

Methods

__

__( $text,  $parameters = array()) 

Arguments

$text

$parameters

__construct

__construct( $builder,  $parser,  $translator,  $files) 

Arguments

$builder

$parser

$translator

$files

Initializes this command and sets the name, description, options and arguments.

configure() : void

Executes the business logic involved with this command.

execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : integer
Throws
\Exception

if the target location is not a folder.

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

$output

\Symfony\Component\Console\Output\OutputInterface

Response

integer

getBuilder

getBuilder() : \phpDocumentor\Descriptor\ProjectDescriptorBuilder

Returns the Cache.

getCache() : \Zend\Cache\Storage\StorageInterface

Response

\Zend\Cache\Storage\StorageInterface

Returns the collection of files based on the input and configuration.

getFileCollection(\Symfony\Component\Console\Input\InputInterface $input) : \phpDocumentor\Fileset\Collection

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\phpDocumentor\Fileset\Collection

getParser

getParser() : \phpDocumentor\Parser\Parser

Returns the Progress bar helper.

getProgressBar(\Symfony\Component\Console\Input\InputInterface $input) : \Symfony\Component\Console\Helper\ProgressHelper
inherited

With this helper it is possible to display a progress bar and make it fill.

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\Symfony\Component\Console\Helper\ProgressHelper

populateParser

populateParser(\Symfony\Component\Console\Input\InputInterface $input, \phpDocumentor\Fileset\Collection $files) 

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

$files

\phpDocumentor\Fileset\Collection

Registers the current command.

setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet) 
inherited

Arguments

$helperSet

\Symfony\Component\Console\Helper\HelperSet

Properties

files

files : \phpDocumentor\Fileset\Collection
var

Type(s)

\phpDocumentor\Fileset\Collection

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder

parser

parser : \phpDocumentor\Parser\Parser

translator

translator : \Zend\I18n\Translator\Translator
var

Type(s)

\Zend\I18n\Translator\Translator