phpDocumentor

FileCollector
in package

Table of Contents

$fileInfos  : array<string|int, array<string|int, string>>
$metas  : Metas
__construct()  : mixed
getFiles()  : Files
Scans a directory recursively looking for all files to parse.
doesFileRequireParsing()  : bool
getFilenameFromFile()  : string
Converts foo/bar.rst to foo/bar (the document filename)
hasFileBeenUpdated()  : bool

Properties

$fileInfos

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

Methods

getFiles()

Scans a directory recursively looking for all files to parse.

public getFiles(FilesystemInterface $filesystem, string $directory, string $extension) : Files

This takes into account the presence of cached & fresh MetaEntry objects, and avoids adding files to the parse queue that have not changed and whose direct dependencies have not changed.

Parameters
$filesystem : FilesystemInterface
$directory : string
$extension : string
Return values
Files

doesFileRequireParsing()

private doesFileRequireParsing(string $filename) : bool
Parameters
$filename : string
Return values
bool

getFilenameFromFile()

Converts foo/bar.rst to foo/bar (the document filename)

private getFilenameFromFile(array<string|int, string> $fileInfo) : string
Parameters
$fileInfo : array<string|int, string>
Return values
string

hasFileBeenUpdated()

private hasFileBeenUpdated(string $filename) : bool
Parameters
$filename : string
Return values
bool

Search results