Document Class Reference

Inheritance diagram for Document:

Public Member Functions
	__construct ()
	getPackageKey ()
	setPackageKey ($packageKey)
	getExtensionKey ()
	setExtensionKey ($extensionKey)
	getIcon ()
	setIcon ($icon)
	addTranslation (\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation $translation)
	removeTranslation (\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation $translationToRemove)
	getTranslations ()
	setTranslations (\TYPO3\CMS\Extbase\Persistence\ObjectStorage $translations)

Protected Member Functions
	initStorageObjects ()

Protected Attributes
	$packageKey
	$extensionKey
	$icon
	$translations

Detailed Description

An extension helper model to be used in ext:documentation context

Definition at line 22 of file Domain/Model/Document.php.

Constructor & Destructor Documentation

__construct

(

)

Default constructor.

Definition at line 57 of file Domain/Model/Document.php.

References Document\initStorageObjects().

Member Function Documentation

addTranslation

(

\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation

$translation

)

Adds a document translation.

Parameters

\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation

$translation

Returns

Document

Definition at line 150 of file Domain/Model/Document.php.

getExtensionKey

(

)

Returns the extension key.

Returns

string $extensionKey

Definition at line 105 of file Domain/Model/Document.php.

References Document\$extensionKey.

getIcon

(

)

Returns the icon.

Returns

string $icon

Definition at line 127 of file Domain/Model/Document.php.

References Document\$icon.

getPackageKey

(

)

Returns the package key.

Returns

string $packageKey

Definition at line 83 of file Domain/Model/Document.php.

References Document\$packageKey.

getTranslations

(

)

Returns the translations.

Returns

<> $translations

Definition at line 173 of file Domain/Model/Document.php.

References Document\$translations.

initStorageObjects ( )

protected

Initializes all ObjectStorage properties.

Returns

void

Do not modify this method! It will be rewritten on each save in the extension builder You may modify the constructor of this class instead

Definition at line 68 of file Domain/Model/Document.php.

Referenced by Document\__construct().

removeTranslation

(

\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation

$translationToRemove

)

Removes a document translation.

Parameters

\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation

$translationToRemove

The DocumentTranslation to be removed

Returns

Document

Definition at line 162 of file Domain/Model/Document.php.

setExtensionKey

(

$extensionKey

)

Sets the extension key.

Parameters

string

$extensionKey

Returns

Document

Definition at line 116 of file Domain/Model/Document.php.

References Document\$extensionKey.

setIcon

(

$icon

)

Sets the icon.

Parameters

string

$icon

Returns

Document

Definition at line 138 of file Domain/Model/Document.php.

References Document\$icon.

setPackageKey

(

$packageKey

)

Sets the package key.

Parameters

string

$packageKey

Returns

Document

Definition at line 94 of file Domain/Model/Document.php.

References Document\$packageKey.

setTranslations

(

\TYPO3\CMS\Extbase\Persistence\ObjectStorage

$translations

)

Sets the translations.

Parameters

\TYPO3\CMS\Extbase\Persistence\ObjectStorage<\TYPO3\CMS\Documentation\Domain\Model\DocumentTranslation>

$translations

Returns

Document

Definition at line 184 of file Domain/Model/Document.php.

References Document\$translations.

Member Data Documentation

$extensionKey

protected

Definition at line 38 of file Domain/Model/Document.php.

Referenced by Document\getExtensionKey(), and Document\setExtensionKey().

$icon

protected

Definition at line 45 of file Domain/Model/Document.php.

Referenced by Document\getIcon(), and Document\setIcon().

$packageKey

protected

Definition at line 30 of file Domain/Model/Document.php.

Referenced by Document\getPackageKey(), and Document\setPackageKey().

$translations

protected

Definition at line 52 of file Domain/Model/Document.php.

Referenced by Document\getTranslations(), and Document\setTranslations().