\phpDocumentor\Parser\Command\ProjectParseCommand

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).

Summary

Methods
Properties
Constants
setHelperSet()
__construct()
getBuilder()
getParser()
No public properties found
No constants found
getProgressBar()
getCache()
configure()
execute()
populateParser()
getFileCollection()
__()
$builder
$parser
$translator
N/A
No private methods found
$files
N/A

Properties

$translator

$translator : \Zend\I18n\Translator\Translator

Type

\Zend\I18n\Translator\Translator

$files

$files : \phpDocumentor\Fileset\Collection

Type

\phpDocumentor\Fileset\Collection

Methods

setHelperSet()

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

Registers the current command.

Parameters

\Symfony\Component\Console\Helper\HelperSet $helperSet

__construct()

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

Parameters

$builder
$parser
$translator
$files

getProgressBar()

getProgressBar(\Symfony\Component\Console\Input\InputInterface  $input) : \Symfony\Component\Console\Helper\HelperInterface|null

Adds the parser.file.pre event to the advance the progressbar.

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

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\Symfony\Component\Console\Helper\HelperInterface|null

getCache()

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

Returns the Cache.

Returns

\Zend\Cache\Storage\StorageInterface

configure()

configure() : void

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

execute()

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

Executes the business logic involved with this command.

Parameters

\Symfony\Component\Console\Input\InputInterface $input
\Symfony\Component\Console\Output\OutputInterface $output

Throws

\Exception

if the target location is not a folder.

Returns

integer

populateParser()

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

Parameters

\Symfony\Component\Console\Input\InputInterface $input
\phpDocumentor\Fileset\Collection $files

getFileCollection()

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

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

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\phpDocumentor\Fileset\Collection

__()

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

Parameters

$text
$parameters