\phpDocumentor\GuidesFileCollector

Summary

Methods
Properties
Constants
__construct()
getFiles()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
doesFileRequireParsing()
hasFileBeenUpdated()
getFilenameFromFile()
$metas
$fileInfos
N/A

Properties

$metas

$metas : \phpDocumentor\Guides\Metas

Type

Metas

$fileInfos

$fileInfos : string[][]

Type

string[][]

Methods

__construct()

__construct(\phpDocumentor\Guides\Metas  $metas) : mixed

Parameters

\phpDocumentor\Guides\Metas $metas

Returns

mixed —

getFiles()

getFiles(\League\Flysystem\FilesystemInterface  $filesystem, string  $directory, string  $extension) : \phpDocumentor\Guides\Files

Scans a directory recursively looking for all files to parse.

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

\League\Flysystem\FilesystemInterface $filesystem
string $directory
string $extension

Returns

\phpDocumentor\Guides\Files —

doesFileRequireParsing()

doesFileRequireParsing(string  $filename) : bool

Parameters

string $filename

Returns

bool —

hasFileBeenUpdated()

hasFileBeenUpdated(string  $filename) : bool

Parameters

string $filename

Returns

bool —

getFilenameFromFile()

getFilenameFromFile(string[]  $fileInfo) : string

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

Parameters

string[] $fileInfo

Returns

string —