phpDocumentor

Environment
in package

Table of Contents

$anonymous  : array<string|int, string>
$counters  : array<string|int, int>
$currentDirectory  : string
$currentFileName  : string
$currentTitleLevel  : int
$dependencies  : array<string|int, string>
$initialHeaderLevel  : int
$invalidLinks  : array<string|int, InvalidLink>
$levels  : array<string|int, int>
$links  : array<string|int, string>
$logger  : LoggerInterface
$metas  : Metas
$nodeRendererFactory  : NodeRendererFactory
$origin  : FilesystemInterface
$originalDependencyNames  : array<string|int, string>
$outputFolder  : string
$references  : array<string|int, Reference>
$renderer  : Renderer
$titleLetters  : array<string|int, string>
$unresolvedDependencies  : array<string|int, string>
$url  : string|null
$urlGenerator  : UrlGenerator
$variables  : array<string|int, string>
__construct()  : mixed
absoluteRelativePath()  : string
absoluteUrl()  : string
addDependency()  : void
addError()  : void
addInvalidLink()  : void
canonicalUrl()  : string|null
createTitle()  : string
found()  : array<string|int, string>|null
generateUrl()  : string
getCurrentFileName()  : string
getDependencies()  : array<string|int, string>
getDirName()  : string
getInitialHeaderLevel()  : int
getInvalidLinks()  : array<string|int, InvalidLink>
getLevel()  : int
getLink()  : string
getLinks()  : array<string|int, string>
getMetaEntry()  : Entry|null
getMetas()  : Metas
getNodeRendererFactory()  : NodeRendererFactory
getNumber()  : int
getOrigin()  : FilesystemInterface
getRenderer()  : Renderer
getTitleLetters()  : array<string|int, string>
getUrl()  : string
getVariable()  : mixed
outputUrl()  : string|null
pushAnonymous()  : void
registerReference()  : void
relativeUrl()  : string
reset()  : void
resetAnonymousStack()  : void
resolve()  : ResolvedReference|null
setCurrentDirectory()  : void
setCurrentFileName()  : void
setLink()  : void
setMetas()  : void
setNodeRendererFactory()  : void
setUrl()  : void
setVariable()  : void
addMissingReferenceSectionError()  : void

Properties

$anonymous

private array<string|int, string> $anonymous = []

$counters

private array<string|int, int> $counters = []

$currentDirectory

private string $currentDirectory = '.'

$currentFileName

private string $currentFileName = ''

$currentTitleLevel

private int $currentTitleLevel = 0

$dependencies

private array<string|int, string> $dependencies = []
private array<string|int, string> $links = []

$originalDependencyNames

private array<string|int, string> $originalDependencyNames = []

$titleLetters

private array<string|int, string> $titleLetters = []

$unresolvedDependencies

private array<string|int, string> $unresolvedDependencies = []

$variables

private array<string|int, string> $variables = []

Methods

__construct()

public __construct(Configuration $configuration, Renderer $renderer, LoggerInterface $logger, FilesystemInterface $origin, Metas $metas) : mixed
Parameters
$configuration : Configuration
$renderer : Renderer
$logger : LoggerInterface
$origin : FilesystemInterface
$metas : Metas
Return values
mixed

absoluteRelativePath()

public absoluteRelativePath(string $url) : string
Parameters
$url : string
Return values
string

absoluteUrl()

public absoluteUrl(string $url) : string
Parameters
$url : string
Return values
string

addDependency()

public addDependency(string $dependency[, bool $requiresResolving = false ]) : void
Parameters
$dependency : string
$requiresResolving : bool = false
Return values
void

addError()

public addError(string $message) : void
Parameters
$message : string
Return values
void

canonicalUrl()

public canonicalUrl(string $url) : string|null
Parameters
$url : string
Return values
string|null

createTitle()

public createTitle(int $level) : string
Parameters
$level : int
Tags
todo

is this used?

Return values
string

found()

public found(string $section, string $data) : array<string|int, string>|null
Parameters
$section : string
$data : string
Return values
array<string|int, string>|null

generateUrl()

public generateUrl(string $path) : string
Parameters
$path : string
Return values
string

getCurrentFileName()

public getCurrentFileName() : string
Return values
string

getDependencies()

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

getDirName()

public getDirName() : string
Return values
string

getInitialHeaderLevel()

public getInitialHeaderLevel() : int
Return values
int

getLevel()

public getLevel(string $letter) : int
Parameters
$letter : string
Return values
int
public getLink(string $name[, bool $relative = true ]) : string
Parameters
$name : string
$relative : bool = true
Return values
string
public getLinks() : array<string|int, string>
Return values
array<string|int, string>

getNumber()

public getNumber(int $level) : int
Parameters
$level : int
Return values
int

getOrigin()

public getOrigin() : FilesystemInterface
Return values
FilesystemInterface

getTitleLetters()

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

getUrl()

public getUrl() : string
Return values
string

getVariable()

public getVariable(string $variable[, mixed|null $default = null ]) : mixed
Parameters
$variable : string
$default : mixed|null = null
Return values
mixed

outputUrl()

public outputUrl(string $url) : string|null
Parameters
$url : string
Return values
string|null

pushAnonymous()

public pushAnonymous(string $name) : void
Parameters
$name : string
Return values
void

relativeUrl()

public relativeUrl(string|null $url) : string
Parameters
$url : string|null
Return values
string

reset()

public reset() : void
Return values
void

resetAnonymousStack()

public resetAnonymousStack() : void
Return values
void

setCurrentDirectory()

public setCurrentDirectory(string $directory) : void
Parameters
$directory : string
Return values
void

setCurrentFileName()

public setCurrentFileName(string $filename) : void
Parameters
$filename : string
Return values
void
public setLink(string $name, string $url) : void
Parameters
$name : string
$url : string
Return values
void

setUrl()

public setUrl(string $url) : void
Parameters
$url : string
Return values
void

setVariable()

public setVariable(string $variable, mixed $value) : void
Parameters
$variable : string
$value : mixed
Return values
void

addMissingReferenceSectionError()

private addMissingReferenceSectionError(string $section) : void
Parameters
$section : string
Return values
void

Search results