RunCommand
extends Command
in package
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
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.
Table of Contents
- $pipeline : PipelineInterface
- $progressBar : ProgressBar
- $projectDescriptorBuilder : ProjectDescriptorBuilder
- $transformerProgressBar : ProgressBar
- __construct() : mixed
- configure() : void
- Initializes this command and sets the name, description, options and arguments.
- execute() : int
- Executes the business logic involved with this command.
- durationInText() : string
- observeProgressToShowProgressBars() : void
Properties
$pipeline
private
PipelineInterface
$pipeline
$progressBar
private
ProgressBar
$progressBar
$projectDescriptorBuilder
private
ProjectDescriptorBuilder
$projectDescriptorBuilder
$transformerProgressBar
private
ProgressBar
$transformerProgressBar
Methods
__construct()
public
__construct(ProjectDescriptorBuilder $projectDescriptorBuilder, PipelineInterface $pipeline) : mixed
Parameters
- $projectDescriptorBuilder : ProjectDescriptorBuilder
- $pipeline : PipelineInterface
Return values
mixed —configure()
Initializes this command and sets the name, description, options and arguments.
protected
configure() : void
Return values
void —execute()
Executes the business logic involved with this command.
protected
execute(InputInterface $input, OutputInterface $output) : int
Parameters
- $input : InputInterface
- $output : OutputInterface
Return values
int —durationInText()
private
durationInText(StopwatchEvent $event) : string
Parameters
- $event : StopwatchEvent
Return values
string —observeProgressToShowProgressBars()
private
observeProgressToShowProgressBars(OutputInterface $output) : void
Parameters
- $output : OutputInterface