\phpDocumentor\Console\Command\ProjectRunCommand

Parse and transform the given directory (-d|-f) to the given location (-t).

phpDocumentor creates documentation from PHP source files. The simplest way to use it is:

$ phpdoc run -d <directory to parse> -t <output directory>

This will parse every file ending with .php, .php3 and .phtml in and then output a HTML site containing easily readable documentation in .

phpDocumentor will try to look for a phpdoc.dist.xml or phpdoc.xml file in your current working directory and use that to override the default settings if present. In the configuration file can you specify the same settings (and more) as the command line provides.

Summary

Methods
Properties
Constants
__construct()
No public properties found
No constants found
configure()
execute()
No protected properties found
N/A
observeProgressToShowProgressBars()
durationInText()
$projectDescriptorBuilder
$pipeline
$progressBar
$transformerProgressBar
$eventDispatcher
N/A

Properties

$projectDescriptorBuilder

$projectDescriptorBuilder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder

Type

ProjectDescriptorBuilder

$pipeline

$pipeline : \League\Pipeline\PipelineInterface

Type

\League\Pipeline\PipelineInterface —

$progressBar

$progressBar : \Symfony\Component\Console\Helper\ProgressBar

Type

\Symfony\Component\Console\Helper\ProgressBar —

$transformerProgressBar

$transformerProgressBar : \Symfony\Component\Console\Helper\ProgressBar

Type

\Symfony\Component\Console\Helper\ProgressBar —

$eventDispatcher

$eventDispatcher : \Symfony\Component\EventDispatcher\EventDispatcherInterface

Type

\Symfony\Component\EventDispatcher\EventDispatcherInterface —

Methods

__construct()

__construct(\phpDocumentor\Descriptor\ProjectDescriptorBuilder  $projectDescriptorBuilder, \League\Pipeline\PipelineInterface  $pipeline, \Symfony\Component\EventDispatcher\EventDispatcherInterface  $eventDispatcher) : mixed

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $projectDescriptorBuilder
\League\Pipeline\PipelineInterface $pipeline
\Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher

Returns

mixed —

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) : int

Executes the business logic involved with this command.

Parameters

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

Returns

int —

observeProgressToShowProgressBars()

observeProgressToShowProgressBars(\Symfony\Component\Console\Output\OutputInterface  $output) : void

Parameters

\Symfony\Component\Console\Output\OutputInterface $output

durationInText()

durationInText(\Symfony\Component\Stopwatch\StopwatchEvent  $event) : string

Parameters

\Symfony\Component\Stopwatch\StopwatchEvent $event

Returns

string —