\phpDocumentor\Pipeline\StageTransform

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.

Summary

Methods
Properties
Constants
__construct()
__invoke()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
connectOutputToEvents()
createFileSystem()
$transformer
$logger
$templateFactory
$flySystemFactory
N/A

Properties

$transformer

$transformer : \phpDocumentor\Transformer\Transformer

Type

Transformer — Principal object for guiding the transformation process

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$templateFactory

$templateFactory : \phpDocumentor\Transformer\Template\Factory

Type

Factory

$flySystemFactory

$flySystemFactory : \phpDocumentor\Parser\FlySystemFactory

Type

FlySystemFactory

Methods

__construct()

__construct(\phpDocumentor\Transformer\Transformer  $transformer, \phpDocumentor\Parser\FlySystemFactory  $flySystemFactory, \Psr\Log\LoggerInterface  $logger, \phpDocumentor\Transformer\Template\Factory  $templateFactory) : mixed

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

Parameters

\phpDocumentor\Transformer\Transformer $transformer
\phpDocumentor\Parser\FlySystemFactory $flySystemFactory
\Psr\Log\LoggerInterface $logger
\phpDocumentor\Transformer\Template\Factory $templateFactory

Returns

mixed —

__invoke()

__invoke(\phpDocumentor\Pipeline\Stage\Payload  $payload) : \phpDocumentor\Pipeline\Stage\Payload

Executes the business logic involved with this command.

Parameters

\phpDocumentor\Pipeline\Stage\Payload $payload

Throws

\Exception

If the target location is not a folder.

Returns

\phpDocumentor\Pipeline\Stage\Payload —

connectOutputToEvents()

connectOutputToEvents() : void

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

createFileSystem()

createFileSystem(\phpDocumentor\Dsn  $dsn) : \League\Flysystem\FilesystemInterface

Parameters

\phpDocumentor\Dsn $dsn

Returns

\League\Flysystem\FilesystemInterface —