TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
DocumentTranslation Class Reference
Inheritance diagram for DocumentTranslation:
AbstractEntity AbstractDomainObject DomainObjectInterface ObjectMonitoringInterface

Public Member Functions

 __construct ()
 
 getLanguage ()
 
 setLanguage ($language)
 
 getTitle ()
 
 setTitle ($title)
 
 getDescription ()
 
 setDescription ($description)
 
 addFormat (\TYPO3\CMS\Documentation\Domain\Model\DocumentFormat $format)
 
 removeFormat (\TYPO3\CMS\Documentation\Domain\Model\DocumentFormat $formatToRemove)
 
 getFormats ()
 
 setFormats (\TYPO3\CMS\Extbase\Persistence\ObjectStorage $formats)
 
- Public Member Functions inherited from AbstractDomainObject
 getUid ()
 
 setPid ($pid)
 
 getPid ()
 
 _setProperty ($propertyName, $propertyValue)
 
 _getProperty ($propertyName)
 
 _getProperties ()
 
 _hasProperty ($propertyName)
 
 _isNew ()
 
 _memorizeCleanState ($propertyName=null)
 
 _memorizePropertyCleanState ($propertyName)
 
 _getCleanProperties ()
 
 _getCleanProperty ($propertyName)
 
 _isDirty ($propertyName=null)
 
 _isClone ()
 
 _setClone ($clone)
 
 __clone ()
 
 __toString ()
 
- Public Member Functions inherited from ObjectMonitoringInterface
 _memorizeCleanState ()
 
 _isDirty ()
 

Protected Member Functions

 initStorageObjects ()
 
- Protected Member Functions inherited from AbstractDomainObject
 isPropertyDirty ($previousValue, $currentValue)
 

Protected Attributes

 $language
 
 $title
 
 $description
 
 $formats
 
- Protected Attributes inherited from AbstractDomainObject
 $uid
 
 $_localizedUid
 
 $_languageUid
 
 $_versionedUid
 
 $pid
 

Detailed Description

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

Definition at line 22 of file DocumentTranslation.php.

Constructor & Destructor Documentation

__construct ( )

Default constructor.

Definition at line 57 of file DocumentTranslation.php.

References DocumentTranslation\initStorageObjects().

Member Function Documentation

Adds a documentation format.

Parameters
\TYPO3\CMS\Documentation\Domain\Model\DocumentFormat$format
Returns
DocumentTranslation

Definition at line 150 of file DocumentTranslation.php.

getDescription ( )

Returns the description.

Returns
string $description

Definition at line 127 of file DocumentTranslation.php.

References DocumentTranslation\$description.

getFormats ( )

Returns the formats.

Returns
<> $formats

Definition at line 173 of file DocumentTranslation.php.

References DocumentTranslation\$formats.

getLanguage ( )

Returns the language.

Returns
string $language

Definition at line 83 of file DocumentTranslation.php.

References DocumentTranslation\$language.

getTitle ( )

Returns the title.

Returns
string $title

Definition at line 105 of file DocumentTranslation.php.

References DocumentTranslation\$title.

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 DocumentTranslation.php.

Referenced by DocumentTranslation\__construct().

removeFormat ( \TYPO3\CMS\Documentation\Domain\Model\DocumentFormat  $formatToRemove)

Removes a documentation format.

Parameters
\TYPO3\CMS\Documentation\Domain\Model\DocumentFormat$formatToRemoveThe DocumentFormat to be removed
Returns
DocumentTranslation

Definition at line 162 of file DocumentTranslation.php.

setDescription (   $description)

Sets the description.

Parameters
string$description
Returns
DocumentTranslation

Definition at line 138 of file DocumentTranslation.php.

References DocumentTranslation\$description.

Sets the formats.

Parameters
TYPO3<> $formats
Returns
DocumentTranslation

Definition at line 184 of file DocumentTranslation.php.

References DocumentTranslation\$formats.

setLanguage (   $language)

Sets the language.

Parameters
string$language
Returns
DocumentTranslation

Definition at line 94 of file DocumentTranslation.php.

References DocumentTranslation\$language.

setTitle (   $title)

Sets the title.

Parameters
string$title
Returns
DocumentTranslation

Definition at line 116 of file DocumentTranslation.php.

References DocumentTranslation\$title.

Member Data Documentation

$description
protected
$formats
protected
$language
protected
$title
protected