Guides

RenderContext
in package

Table of Contents

Properties

$allDocuments  : array<string|int, DocumentNode>
$currentFileName  : string|null
$destination  : FilesystemInterface
$destinationPath  : string
$document  : DocumentNode
$iterator  : DocumentListIterator
$origin  : FilesystemInterface
$outputFilePath  : string
$outputFormat  : string
$projectNode  : ProjectNode

Methods

forDocument()  : self
forProject()  : self
getAllDocuments()  : array<string|int, DocumentNode>
getCurrentDocumentEntry()  : DocumentEntryNode|null
getCurrentFileName()  : string
getCurrentFileRootline()  : array<string|int, string>
getDestination()  : FilesystemInterface
getDestinationPath()  : string
getDirName()  : string
getDocument()  : DocumentNode
getDocumentNodeForEntry()  : DocumentNode
getIterator()  : DocumentListIterator
getLink()  : string
getLoggerInformation()  : array<string, string|null>
getOrigin()  : FilesystemInterface
getOutputFilePath()  : string
getOutputFormat()  : string
getProjectNode()  : ProjectNode
getRootDocumentNode()  : DocumentNode
getVariable()  : mixed
hasCurrentFileName()  : bool
withDocument()  : self
withIterator()  : self
withOutputFilePath()  : RenderContext
__construct()  : mixed

Properties

$currentFileName read-only

private string|null $currentFileName

$destination read-only

private FilesystemInterface $destination

Methods

forDocument()

public static forDocument(DocumentNode $documentNode, array<string|int, DocumentNode> $allDocumentNodes, FilesystemInterface $origin, FilesystemInterface $destination, string $destinationPath, string $ouputFormat, ProjectNode $projectNode) : self
Parameters
$documentNode : DocumentNode
$allDocumentNodes : array<string|int, DocumentNode>
$origin : FilesystemInterface
$destination : FilesystemInterface
$destinationPath : string
$ouputFormat : string
$projectNode : ProjectNode
Return values
self

forProject()

public static forProject(ProjectNode $projectNode, array<string|int, DocumentNode> $allDocumentNodes, FilesystemInterface $origin, FilesystemInterface $destination, string $destinationPath, string $ouputFormat) : self
Parameters
$projectNode : ProjectNode
$allDocumentNodes : array<string|int, DocumentNode>
$origin : FilesystemInterface
$destination : FilesystemInterface
$destinationPath : string
$ouputFormat : string
Return values
self

getCurrentFileName()

public getCurrentFileName() : string
Return values
string

getCurrentFileRootline()

public getCurrentFileRootline() : array<string|int, string>
Return values
array<string|int, string>

getDestination()

public getDestination() : FilesystemInterface
Return values
FilesystemInterface

getDestinationPath()

public getDestinationPath() : string
Return values
string

getDirName()

public getDirName() : string
Return values
string

getLink()

public getLink(string $name) : string
Parameters
$name : string
Return values
string

getLoggerInformation()

public getLoggerInformation() : array<string, string|null>
Return values
array<string, string|null>

getOrigin()

public getOrigin() : FilesystemInterface
Return values
FilesystemInterface

getOutputFilePath()

public getOutputFilePath() : string
Return values
string

getOutputFormat()

public getOutputFormat() : string
Return values
string

getVariable()

public getVariable(string $variable[, TType $default = null ]) : mixed
Parameters
$variable : string
$default : TType = null
Tags
phpstan-return

TType|string|Node

hasCurrentFileName()

public hasCurrentFileName() : bool
Return values
bool

__construct()

private __construct(string $destinationPath, string|null $currentFileName, FilesystemInterface $origin, FilesystemInterface $destination, string $outputFormat, ProjectNode $projectNode) : mixed
Parameters
$destinationPath : string
$currentFileName : string|null
$origin : FilesystemInterface
$destination : FilesystemInterface
$outputFormat : string
$projectNode : ProjectNode 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results