phpDocumentor

Entry
in package

Table of Contents

$depends  : array<string|int, string>
$file  : string
$links  : array<string|int, string>
$mtime  : int
$parent  : string|null
$resolvedDependencies  : array<string|int, string>
$title  : string
$titles  : array<string|int, array<string|int, string>>|array<string|int, array<string|int, array<string|int, string>>>
$tocs  : array<string|int, array<string|int, mixed>>
$url  : string
__construct()  : mixed
getDepends()  : array<string|int, string>
getFile()  : string
getLinks()  : array<string|int, string>
getMtime()  : int
getParent()  : string|null
getTitle()  : string
getTitles()  : array<string|int, array<string|int, string>>|array<string|int, array<string|int, array<string|int, string>>>
getTocs()  : array<string|int, array<string|int, mixed>>
getUrl()  : string
hasTitle()  : bool
removeDependency()  : void
resolveDependency()  : void
Call to replace a dependency with the resolved, real filename.
setParent()  : void
getAllTitles()  : array<string|int, string>

Properties

$depends

private array<string|int, string> $depends
private array<string|int, string> $links

$parent

private string|null $parent

$resolvedDependencies

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

$title

private string $title

$titles

private array<string|int, array<string|int, string>>|array<string|int, array<string|int, array<string|int, string>>> $titles

$tocs

private array<string|int, array<string|int, mixed>> $tocs

Methods

__construct()

public __construct(string $file, string $url, string $title, array<string|int, array<string|int, string>>|array<string|int, array<string|int, array<string|int, string>>> $titles, array<string|int, array<string|int, mixed>> $tocs, array<string|int, string> $depends, array<string|int, string> $links, int $mtime) : mixed
Parameters
$file : string
$url : string
$title : string
$titles : array<string|int, array<string|int, string>>|array<string|int, array<string|int, array<string|int, string>>>
$tocs : array<string|int, array<string|int, mixed>>
$depends : array<string|int, string>
$links : array<string|int, string>
$mtime : int
Return values
mixed

getDepends()

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

getFile()

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

getMtime()

public getMtime() : int
Return values
int

getParent()

public getParent() : string|null
Return values
string|null

getTitle()

public getTitle() : string
Return values
string

getTitles()

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

getTocs()

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

getUrl()

public getUrl() : string
Return values
string

hasTitle()

public hasTitle(string $text) : bool
Parameters
$text : string
Return values
bool

removeDependency()

public removeDependency(string $dependency) : void
Parameters
$dependency : string
Return values
void

resolveDependency()

Call to replace a dependency with the resolved, real filename.

public resolveDependency(string $originalDependency, string|null $newDependency) : void
Parameters
$originalDependency : string
$newDependency : string|null
Return values
void

setParent()

public setParent(string $parent) : void
Parameters
$parent : string
Return values
void

getAllTitles()

private getAllTitles([array<string|int, string>|array<string|int, array<string|int, string>>|null $entryTitles = null ]) : array<string|int, string>
Parameters
$entryTitles : array<string|int, string>|array<string|int, array<string|int, string>>|null = null
Return values
array<string|int, string>

Search results