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

Public Member Functions

 __construct ($key= '', $title= '', $icon= '')
 
 setIcon ($icon)
 
 getIcon ()
 
 getIconWidth ()
 
 setIconWidth ($iconWidth)
 
 getIconHeight ()
 
 setIconHeight ($iconHeight)
 
 setKey ($key)
 
 getKey ()
 
 setTitle ($title)
 
 getTitle ()
 
 setVersion ($version)
 
 setVersionFromString ($version)
 
 getVersion ()
 
 setUpdateResult ($updateResult)
 
 getUpdateResult ()
 
 toArray ()
 
- 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 Attributes

 $key = ''
 
 $title = ''
 
 $icon = ''
 
 $iconWidth = 28
 
 $iconHeight = 28
 
 $version = ''
 
 $updateResult = []
 
- Protected Attributes inherited from AbstractDomainObject
 $uid
 
 $_localizedUid
 
 $_languageUid
 
 $_versionedUid
 
 $pid
 

Additional Inherited Members

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

Detailed Description

Extension model

Definition at line 23 of file lang/Classes/Domain/Model/Extension.php.

Constructor & Destructor Documentation

__construct (   $key = '',
  $title = '',
  $icon = '' 
)

Constructor of the extension model.

Parameters
string$keyThe extension key
string$titleTitle of the extension
string$iconIcon representing the extension

Definition at line 67 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$icon, Extension\$key, Extension\$title, Extension\setIcon(), Extension\setKey(), and Extension\setTitle().

Member Function Documentation

getIcon ( )

Getter for the icon

Returns
string ext_icon path relative to typo3 folder

Definition at line 90 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$icon.

Referenced by Extension\toArray().

getIconHeight ( )
Returns
int

Definition at line 114 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$iconHeight.

Referenced by Extension\toArray().

getIconWidth ( )
Returns
int

Definition at line 98 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$iconWidth.

Referenced by Extension\toArray().

getKey ( )

Getter for the key

Returns
string

Definition at line 143 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$key.

Referenced by Extension\toArray().

getTitle ( )

Getter for the title

Returns
string

Definition at line 164 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$title.

Referenced by Extension\toArray().

getUpdateResult ( )

Getter for updateResult

Returns
array returns the update result as an array in the structure like array('icon' => '', 'message' => '')

Definition at line 218 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$updateResult.

getVersion ( )

Getter for the version

Returns
int interpretation of the extension version

Definition at line 197 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$version.

Referenced by Extension\toArray().

setIcon (   $icon)

Setter for the icon

Parameters
string$iconext_icon path relative to typo3 folder like ../typo3conf/ext/extensionkey/ext_icon.png
Returns
void

Definition at line 80 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$icon.

Referenced by Extension\__construct().

setIconHeight (   $iconHeight)
Parameters
int$iconHeight

Definition at line 122 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$iconHeight.

setIconWidth (   $iconWidth)
Parameters
int$iconWidth

Definition at line 106 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$iconWidth.

setKey (   $key)

Setter for the key

Parameters
string$key
Returns
void

Definition at line 133 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$key.

Referenced by Extension\__construct().

setTitle (   $title)

Setter for the title

Parameters
string$title
Returns
void

Definition at line 154 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$title.

Referenced by Extension\__construct().

setUpdateResult (   $updateResult)

Setter for updateResult

Parameters
array$updateResultNeeds to be in a structure like array('icon' => '', 'message' => '')
Returns
void

Definition at line 208 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$updateResult.

setVersion (   $version)

Setter for the version

Parameters
int$versionNeeds to have a valid version format like 1003007
Returns
void

Definition at line 175 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$version.

setVersionFromString (   $version)

Setter for the version from string

Parameters
string$versionNeeds to have a format like '1.3.7' and converts it into an integer like 1003007 before setting the version
See also
::convertVersionNumberToInteger
Returns
void

Definition at line 187 of file lang/Classes/Domain/Model/Extension.php.

References Extension\$version, and VersionNumberUtility\convertVersionNumberToInteger().

toArray ( )

Returns an array represetation of current model

Returns
array The properties

Definition at line 228 of file lang/Classes/Domain/Model/Extension.php.

References Extension\getIcon(), Extension\getIconHeight(), Extension\getIconWidth(), Extension\getKey(), Extension\getTitle(), and Extension\getVersion().

Member Data Documentation

$icon = ''
protected
$iconHeight = 28
protected
$iconWidth = 28
protected
$key = ''
protected
$title = ''
protected
$updateResult = []
protected
$version = ''
protected