Properties

$urlGenerator

$urlGenerator : \phpDocumentor\Guides\UrlGenerator

Type

UrlGenerator

$initialHeaderLevel

$initialHeaderLevel : int

Type

int

$currentTitleLevel

$currentTitleLevel : int

Type

int

$titleLetters

$titleLetters : string[]

Type

string[]

$currentFileName

$currentFileName : string

Type

string

$origin

$origin : \League\Flysystem\FilesystemInterface

Type

\League\Flysystem\FilesystemInterface —

$currentDirectory

$currentDirectory : string

Type

string

$references

$references : \phpDocumentor\Guides\References\Reference[]

Type

Reference[]

$metas

$metas : \phpDocumentor\Guides\Metas

Type

Metas

$dependencies

$dependencies : string[]

Type

string[]

$unresolvedDependencies

$unresolvedDependencies : string[]

Type

string[]

$originalDependencyNames

$originalDependencyNames : string[]

Type

string[]

$variables

$variables : string[]

Type

string[]

$links

$links : string[]

Type

string[]

$levels

$levels : int[]

Type

int[]

$counters

$counters : int[]

Type

int[]

$anonymous

$anonymous : string[]

Type

string[]

$invalidLinks

$invalidLinks : \phpDocumentor\Guides\InvalidLink[]

Type

InvalidLink[]

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$renderer

$renderer : \phpDocumentor\Guides\Renderer

Type

Renderer

$nodeRendererFactory

$nodeRendererFactory : \phpDocumentor\Guides\NodeRenderers\NodeRendererFactory

Type

NodeRendererFactory

$outputFolder

$outputFolder : string

Type

string

Methods

__construct()

__construct(\phpDocumentor\Guides\Configuration  $configuration, \phpDocumentor\Guides\Renderer  $renderer, \Psr\Log\LoggerInterface  $logger, \League\Flysystem\FilesystemInterface  $origin, \phpDocumentor\Guides\Metas  $metas) : mixed

Parameters

\phpDocumentor\Guides\Configuration $configuration
\phpDocumentor\Guides\Renderer $renderer
\Psr\Log\LoggerInterface $logger
\League\Flysystem\FilesystemInterface $origin
\phpDocumentor\Guides\Metas $metas

Returns

mixed —

reset()

reset() : void

getInitialHeaderLevel()

getInitialHeaderLevel() : int

Returns

int —

setMetas()

setMetas(\phpDocumentor\Guides\Metas  $metas) : void

Parameters

\phpDocumentor\Guides\Metas $metas

getRenderer()

getRenderer() : \phpDocumentor\Guides\Renderer

Returns

\phpDocumentor\Guides\Renderer —

registerReference()

registerReference(\phpDocumentor\Guides\References\Reference  $reference) : void

Parameters

\phpDocumentor\Guides\References\Reference $reference

resolve()

resolve(string  $section, string  $data) : ?\phpDocumentor\Guides\References\ResolvedReference

Parameters

string $section
string $data

Returns

?\phpDocumentor\Guides\References\ResolvedReference —

addInvalidLink()

addInvalidLink(\phpDocumentor\Guides\InvalidLink  $invalidLink) : void

Parameters

\phpDocumentor\Guides\InvalidLink $invalidLink

getInvalidLinks()

getInvalidLinks() : \phpDocumentor\Guides\InvalidLink[]

Returns

\phpDocumentor\Guides\InvalidLink[] —

found()

found(string  $section, string  $data) : string[]|null

Parameters

string $section
string $data

Returns

string[]|null —

setVariable()

setVariable(string  $variable, mixed  $value) : void

Parameters

string $variable
mixed $value

createTitle()

createTitle(int  $level) : string

Parameters

int $level

Returns

string —

getNumber()

getNumber(int  $level) : int

Parameters

int $level

Returns

int —

getVariable()

getVariable(string  $variable, mixed|null  $default = null) : mixed

Parameters

string $variable
mixed|null $default

Returns

mixed —

setLink()

setLink(string  $name, string  $url) : void

Parameters

string $name
string $url

resetAnonymousStack()

resetAnonymousStack() : void

pushAnonymous()

pushAnonymous(string  $name) : void

Parameters

string $name

getLinks()

getLinks() : string[]

Returns

string[] —

getLink()

getLink(string  $name, bool  $relative = true) : string

Parameters

string $name
bool $relative

Returns

string —

addDependency()

addDependency(string  $dependency, bool  $requiresResolving = false) : void

Parameters

string $dependency
bool $requiresResolving

getDependencies()

getDependencies() : string[]

Returns

string[] —

relativeUrl()

relativeUrl(?string  $url) : string

Parameters

?string $url

Returns

string —

absoluteUrl()

absoluteUrl(string  $url) : string

Parameters

string $url

Returns

string —

canonicalUrl()

canonicalUrl(string  $url) : ?string

Parameters

string $url

Returns

?string —

outputUrl()

outputUrl(string  $url) : ?string

Parameters

string $url

Returns

?string —

generateUrl()

generateUrl(string  $path) : string

Parameters

string $path

Returns

string —

absoluteRelativePath()

absoluteRelativePath(string  $url) : string

Parameters

string $url

Returns

string —

getDirName()

getDirName() : string

Returns

string —

setCurrentFileName()

setCurrentFileName(string  $filename) : void

Parameters

string $filename

getCurrentFileName()

getCurrentFileName() : string

Returns

string —

getOrigin()

getOrigin() : \League\Flysystem\FilesystemInterface

Returns

\League\Flysystem\FilesystemInterface —

setCurrentDirectory()

setCurrentDirectory(string  $directory) : void

Parameters

string $directory

getUrl()

getUrl() : string

Returns

string —

setUrl()

setUrl(string  $url) : void

Parameters

string $url

getMetas()

getMetas() : \phpDocumentor\Guides\Metas

Returns

\phpDocumentor\Guides\Metas —

getMetaEntry()

getMetaEntry() : ?\phpDocumentor\Guides\Meta\Entry

Returns

?\phpDocumentor\Guides\Meta\Entry —

getLevel()

getLevel(string  $letter) : int

Parameters

string $letter

Returns

int —

getTitleLetters()

getTitleLetters() : string[]

Returns

string[] —

addError()

addError(string  $message) : void

Parameters

string $message

setNodeRendererFactory()

setNodeRendererFactory(\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory  $nodeRendererFactory) : void

Parameters

\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory $nodeRendererFactory

getNodeRendererFactory()

getNodeRendererFactory() : \phpDocumentor\Guides\NodeRenderers\NodeRendererFactory

Returns

\phpDocumentor\Guides\NodeRenderers\NodeRendererFactory —

addMissingReferenceSectionError()

addMissingReferenceSectionError(string  $section) : void

Parameters

string $section