phpDocumentor

Transform
in package

Transforms the structure file into the specified output format

This task will execute the transformation rules described in the given template with the given source and writes these to the target location (defaults to 'output').

It is possible for the user to receive additional information using the verbose option or stop additional information using the quiet option. Please take note that the quiet option also disables logging to file.

Table of Contents

$compiler  : Compiler
$exampleFinder  : ExampleFinder
$logger  : LoggerInterface
$transformer  : Transformer
__construct()  : mixed
Initializes the command with all necessary dependencies to construct human-suitable output from the AST.
__invoke()  : Payload
Executes the business logic involved with this command.
connectOutputToEvents()  : void
Connect a series of output messages to various events to display progress.
doTransform()  : void
loadTemplatesBasedOnNames()  : void
provideLocationsOfExamples()  : void
setTargetLocationBasedOnDsn()  : void

Properties

$exampleFinder

private ExampleFinder $exampleFinder

Methods

__construct()

Initializes the command with all necessary dependencies to construct human-suitable output from the AST.

public __construct(Transformer $transformer, Compiler $compiler, LoggerInterface $logger, ExampleFinder $exampleFinder) : mixed
Parameters
$transformer : Transformer
$compiler : Compiler
$logger : LoggerInterface
$exampleFinder : ExampleFinder
Return values
mixed

__invoke()

Executes the business logic involved with this command.

public __invoke(Payload $payload) : Payload
Parameters
$payload : Payload
Tags
throws
Exception

If the target location is not a folder.

Return values
Payload

connectOutputToEvents()

Connect a series of output messages to various events to display progress.

private connectOutputToEvents() : void
Return values
void

loadTemplatesBasedOnNames()

private loadTemplatesBasedOnNames(array<int, string> $templateNames) : void
Parameters
$templateNames : array<int, string>
Return values
void

provideLocationsOfExamples()

private provideLocationsOfExamples() : void
Return values
void

setTargetLocationBasedOnDsn()

private setTargetLocationBasedOnDsn(Dsn $dsn) : void
Parameters
$dsn : Dsn
Return values
void

Search results