TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile Class Reference

Public Member Functions
	__construct (string $changelogDir='')
string[]	findDocumentationDirectories (string $path)
array	findDocumentationFiles (string $path)
	getListEntry (string $file)

Private Member Functions
	extractTags (array $file)
array	extractTagsFromFile (array $file)
	extractCategoryFromHeadline (array $lines)
	extractHeadline (array $lines)
	getDocumentationFilesForVersion (string $docDirectory)
	parseContent (string $rstContent)
	parseIssueId (string $filename)
	getDocumentFinder ()

Private Attributes
string	$changelogPath

Detailed Description

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.

Definition at line 32 of file DocumentationFile.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::__construct

(

string

$changelogDir = ''

)

Definition at line 40 of file DocumentationFile.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

Member Function Documentation

extractCategoryFromHeadline()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::extractCategoryFromHeadline ( array  $lines )

private

Files contain a headline (provided as input parameter), it starts with the category string. This will be used as a tag.

Definition at line 178 of file DocumentationFile.php.

References TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractHeadline().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractTags().

extractHeadline()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::extractHeadline ( array  $lines )

private

Skip include line and markers, use the first line actually containing text.

Definition at line 190 of file DocumentationFile.php.

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractCategoryFromHeadline(), and TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getListEntry().

extractTags()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::extractTags ( array  $file )

private

Add tags from file

Parameters

array

$file

‪file content, each line is an array item

Definition at line 144 of file DocumentationFile.php.

References TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractCategoryFromHeadline(), and TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractTagsFromFile().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getListEntry().

extractTagsFromFile()

array TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::extractTagsFromFile ( array  $file )

private

Files must contain an index entry, detailing any number of manual tags each of these tags is extracted and added to the general tag structure for the file

Parameters

array

$file

‪file content, each line is an array item

Returns

‪array extracted tags

Definition at line 161 of file DocumentationFile.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractTags().

findDocumentationDirectories()

string [] TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::findDocumentationDirectories

(

string

$path

)

Traverse given directory, select directories

Returns

‪string[] Version directories

Exceptions

Definition at line 52 of file DocumentationFile.php.

References $finder, and TYPO3\CMS\Core\Utility\VersionNumberUtility\getNumericTypo3Version().

findDocumentationFiles()

array TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::findDocumentationFiles

(

string

$path

)

Traverse given directory, select files

Returns

‪array file details of affected documentation files

Exceptions

Definition at line 83 of file DocumentationFile.php.

References TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getDocumentationFilesForVersion().

getDocumentationFilesForVersion()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::getDocumentationFilesForVersion ( string  $docDirectory )

private

Handle a single directory.

Definition at line 202 of file DocumentationFile.php.

References $finder, TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getDocumentFinder(), and TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getListEntry().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\findDocumentationFiles().

getDocumentFinder()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::getDocumentFinder ( )

private

Definition at line 230 of file DocumentationFile.php.

References $finder.

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getDocumentationFilesForVersion().

getListEntry()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::getListEntry

(

string

$file

)

Get main information from a .rst file

Parameters

string

$file

‪Absolute path to documentation file

Exceptions

Definition at line 97 of file DocumentationFile.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractHeadline(), TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\extractTags(), TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\parseContent(), and TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\parseIssueId().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getDocumentationFilesForVersion().

parseContent()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::parseContent ( string  $rstContent )

private

Definition at line 214 of file DocumentationFile.php.

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getListEntry().

parseIssueId()

TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::parseIssueId ( string  $filename )

private

Definition at line 225 of file DocumentationFile.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile\getListEntry().

Member Data Documentation

$changelogPath

string TYPO3\CMS\Install\UpgradeAnalysis\DocumentationFile::$changelogPath

private

all files handled in this Class need to reside inside the changelog dir this is a security measure to protect system files

Definition at line 38 of file DocumentationFile.php.