TYPO3\Flow\Package\Documentation Class Reference

Public Member Functions
	__construct ($package, $documentationName, $documentationPath)
	getPackage ()
	getDocumentationName ()
	getDocumentationPath ()
	getDocumentationFormats ()

Protected Attributes
	$package
	$documentationName
	$documentationPath

Detailed Description

Documentation for a package

Definition at line 19 of file Documentation.php.

Constructor & Destructor Documentation

__construct()

TYPO3\Flow\Package\Documentation::__construct	(		$package,
			$documentationName,
			$documentationPath
	)

Constructor

Parameters

\TYPO3\Flow\Package\PackageInterface	$package	Reference to the package of this documentation
string	$documentationName	Name of the documentation
string	$documentationPath	Absolute path to the documentation directory

Definition at line 45 of file Documentation.php.

References TYPO3\Flow\Package\Documentation\$documentationName, and TYPO3\Flow\Package\Documentation\$documentationPath.

Member Function Documentation

getDocumentationFormats()

TYPO3\Flow\Package\Documentation::getDocumentationFormats

(

)

Returns the available documentation formats for this documentation

Returns

array Array of

Definition at line 87 of file Documentation.php.

getDocumentationName()

TYPO3\Flow\Package\Documentation::getDocumentationName

(

)

Get the name of this documentation

Returns

string The name of this documentation

Definition at line 67 of file Documentation.php.

References TYPO3\Flow\Package\Documentation\$documentationName.

getDocumentationPath()

TYPO3\Flow\Package\Documentation::getDocumentationPath

(

)

Get the full path to the directory of this documentation

Returns

string Path to the directory of this documentation

Definition at line 77 of file Documentation.php.

References TYPO3\Flow\Package\Documentation\$documentationPath.

getPackage()

TYPO3\Flow\Package\Documentation::getPackage

(

)

Get the package of this documentation

Returns

The package of this documentation

Definition at line 57 of file Documentation.php.

References TYPO3\Flow\Package\Documentation\$package.

Member Data Documentation

$documentationName

TYPO3\Flow\Package\Documentation::$documentationName

protected

Definition at line 30 of file Documentation.php.

Referenced by TYPO3\Flow\Package\Documentation\__construct(), and TYPO3\Flow\Package\Documentation\getDocumentationName().

$documentationPath

TYPO3\Flow\Package\Documentation::$documentationPath

protected

Definition at line 36 of file Documentation.php.

Referenced by TYPO3\Flow\Package\Documentation\__construct(), and TYPO3\Flow\Package\Documentation\getDocumentationPath().

$package

TYPO3\Flow\Package\Documentation::$package

protected

Definition at line 25 of file Documentation.php.

Referenced by TYPO3\Flow\Package\Documentation\getPackage().