DocumentationFile
FinalYes
Provide information about documentation files.
This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
Table of Contents
Methods
- __construct() : mixed
- findDocumentationDirectories() : string[]
- Traverse given directory, select directories
- findDocumentationFiles() : array
- Traverse given directory, select files
- getListEntry() : array
- Get main information from a .rst file
Methods
__construct()
public
__construct([string $changelogDir = '' ]) : mixed
Parameters
- $changelogDir : string = ''
findDocumentationDirectories()
Traverse given directory, select directories
public
findDocumentationDirectories(string $path) : string[]
Parameters
- $path : string
Tags
Return values
string[] —Version directories
findDocumentationFiles()
Traverse given directory, select files
public
findDocumentationFiles(string $path) : array
Parameters
- $path : string
Tags
Return values
array —file details of affected documentation files
getListEntry()
Get main information from a .rst file
public
getListEntry(string $file) : array
Parameters
- $file : string
-
Absolute path to documentation file