‪TYPO3CMS  11.5
TYPO3\CMS\Extensionmanager\Domain\Model\Extension Class Reference
Inheritance diagram for TYPO3\CMS\Extensionmanager\Domain\Model\Extension:
TYPO3\CMS\Extbase\DomainObject\AbstractEntity TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface

Public Member Functions

 setAuthorEmail ($authorEmail)
 
string getAuthorEmail ()
 
 setAuthorName ($authorName)
 
string getAuthorName ()
 
 setCategory ($category)
 
int getCategory ()
 
string getCategoryString ()
 
int getCategoryIndexFromStringOrNumber ($category)
 
 setDescription ($description)
 
string getDescription ()
 
 setExtensionKey ($extensionKey)
 
string getExtensionKey ()
 
 setLastUpdated (\DateTime $lastUpdated)
 
DateTime getLastUpdated ()
 
 setState ($state)
 
int getState ()
 
string getStateString ()
 
mixed getDefaultState ($state=null)
 
 setTitle ($title)
 
string getTitle ()
 
 setUpdateComment ($updateComment)
 
string getUpdateComment ()
 
 setVersion ($version)
 
string getVersion ()
 
 setCurrentVersion ($currentVersion)
 
bool getCurrentVersion ()
 
 setMd5hash ($md5hash)
 
string getMd5hash ()
 
 setSerializedDependencies ($dependencies)
 
string getSerializedDependencies ()
 
 setDependencies ($dependencies)
 
SplObjectStorage< DependencygetDependencies ()
 
 getTypo3Dependency ()
 
 addDependency (Dependency $dependency)
 
 setIntegerVersion ($integerVersion)
 
int getIntegerVersion ()
 
 setReviewState ($reviewState)
 
int getReviewState ()
 
 setPosition ($position)
 
int getPosition ()
 
 setAlldownloadcounter ($alldownloadcounter)
 
int getAlldownloadcounter ()
 
string getDocumentationLink ()
 
 setDocumentationLink (string $documentationLink)
 
 getRemoteIdentifier ()
 
 setDistributionImage (string $imageUrl)
 
 getDistributionImage ()
 
 setDistributionWelcomeImage (string $imageUrl)
 
 getDistributionWelcomeImage ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
int null getUid ()
 
 setPid (int $pid)
 
int null getPid ()
 
bool _setProperty (string $propertyName, $propertyValue)
 
mixed _getProperty (string $propertyName)
 
array _getProperties ()
 
bool _hasProperty ($propertyName)
 
bool _isNew ()
 
 _memorizeCleanState ($propertyName=null)
 
 _memorizePropertyCleanState ($propertyName)
 
array _getCleanProperties ()
 
mixed _getCleanProperty (string $propertyName)
 
bool _isDirty ($propertyName=null)
 
bool _isClone ()
 
 _setClone ($clone)
 
 __clone ()
 
string __toString ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface
 _memorizeCleanState ()
 
bool _isDirty ()
 

Static Public Member Functions

static array returnInstallPaths ()
 
static array returnAllowedInstallPaths ()
 
static array returnAllowedInstallTypes ()
 
static Extension createFromExtensionArray (array $extensionArray)
 

Public Attributes

const DISTRIBUTION_CATEGORY = 10
 

Protected Member Functions

SplObjectStorage< DependencyconvertDependenciesToObjects (string $dependencies)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
bool isPropertyDirty ($previousValue, $currentValue)
 

Protected Attributes

string $extensionKey = ''
 
string $version = ''
 
int $integerVersion = 0
 
string $title = ''
 
string $description = ''
 
int $state = 0
 
int $category = 0
 
DateTime $lastUpdated
 
string $updateComment = ''
 
string $authorName = ''
 
string $authorEmail = ''
 
bool $currentVersion = false
 
string $md5hash = ''
 
int $reviewState
 
int $alldownloadcounter
 
string $serializedDependencies = ''
 
SplObjectStorage< Dependency$dependencies
 
string $documentationLink = ''
 
string $distributionImage = ''
 
string $distributionWelcomeImage = ''
 
string $remote
 
int $position = 0
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
int $uid
 
int $_localizedUid
 
int $_languageUid
 
int $_versionedUid
 
int $pid
 

Static Protected Attributes

static array $defaultCategories
 
static array $defaultStates
 

Detailed Description

Main extension model

This class is a specific domain model implementation and is not part of the Public TYPO3 API.

Definition at line 27 of file Extension.php.

Member Function Documentation

◆ addDependency()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::addDependency ( Dependency  $dependency)
Parameters
Dependency$dependency

Definition at line 529 of file Extension.php.

◆ convertDependenciesToObjects()

SplObjectStorage<Dependency> TYPO3\CMS\Extensionmanager\Domain\Model\Extension::convertDependenciesToObjects ( string  $dependencies)
protected

Converts string dependencies to an object storage of dependencies

Parameters
string$dependencies
Returns
‪\SplObjectStorage<Dependency>

Definition at line 645 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$dependencies, and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\createFromEmConf().

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getDependencies().

◆ createFromExtensionArray()

◆ getAlldownloadcounter()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getAlldownloadcounter ( )
Returns
‪int

Definition at line 593 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$alldownloadcounter.

◆ getAuthorEmail()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getAuthorEmail ( )
Returns
‪string

Definition at line 167 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$authorEmail.

◆ getAuthorName()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getAuthorName ( )
Returns
‪string

Definition at line 183 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$authorName.

◆ getCategory()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getCategory ( )

◆ getCategoryIndexFromStringOrNumber()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getCategoryIndexFromStringOrNumber (   $category)

Returns category index from a given string or an integer. Fallback to 4 - 'misc' in case string is not found or integer ist out of range.

Parameters
string | int$category‪Category string or integer
Returns
‪int Valid category index

Definition at line 225 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$category, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

◆ getCategoryString()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getCategoryString ( )

Get Category String

Returns
‪string

Definition at line 209 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getCategory().

◆ getCurrentVersion()

bool TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getCurrentVersion ( )
Returns
‪bool

Definition at line 414 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$currentVersion.

◆ getDefaultState()

mixed TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDefaultState (   $state = null)

Returns either array with all default states or index/title of a state entry.

Parameters
mixed$state‪state title or state index
Returns
‪mixed

Definition at line 327 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$defaultStates, and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$state.

◆ getDependencies()

◆ getDescription()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDescription ( )
Returns
‪string

Definition at line 253 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$description.

◆ getDistributionImage()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDistributionImage ( )

◆ getDistributionWelcomeImage()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDistributionWelcomeImage ( )

◆ getDocumentationLink()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDocumentationLink ( )
Returns
‪string

Definition at line 601 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$documentationLink.

◆ getExtensionKey()

◆ getIntegerVersion()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getIntegerVersion ( )

◆ getLastUpdated()

DateTime TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getLastUpdated ( )
Returns
‪\DateTime

Definition at line 285 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$lastUpdated.

◆ getMd5hash()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getMd5hash ( )

◆ getPosition()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getPosition ( )
Returns
‪int

Definition at line 577 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$position.

◆ getRemoteIdentifier()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getRemoteIdentifier ( )

◆ getReviewState()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getReviewState ( )
Returns
‪int

Definition at line 561 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$reviewState.

◆ getSerializedDependencies()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getSerializedDependencies ( )

◆ getState()

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getState ( )

◆ getStateString()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getStateString ( )

Get State string

Returns
‪string

Definition at line 311 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getState().

◆ getTitle()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getTitle ( )
Returns
‪string

Definition at line 366 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$title.

◆ getTypo3Dependency()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getTypo3Dependency ( )

◆ getUpdateComment()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getUpdateComment ( )
Returns
‪string

Definition at line 382 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$updateComment.

◆ getVersion()

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getVersion ( )

◆ returnAllowedInstallPaths()

static array TYPO3\CMS\Extensionmanager\Domain\Model\Extension::returnAllowedInstallPaths ( )
static

◆ returnAllowedInstallTypes()

static array TYPO3\CMS\Extensionmanager\Domain\Model\Extension::returnAllowedInstallTypes ( )
static

◆ returnInstallPaths()

◆ setAlldownloadcounter()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setAlldownloadcounter (   $alldownloadcounter)
Parameters
int$alldownloadcounter

Definition at line 585 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$alldownloadcounter.

◆ setAuthorEmail()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setAuthorEmail (   $authorEmail)
Parameters
string$authorEmail

Definition at line 159 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$authorEmail.

◆ setAuthorName()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setAuthorName (   $authorName)
Parameters
string$authorName

Definition at line 175 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$authorName.

◆ setCategory()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setCategory (   $category)
Parameters
int$category

Definition at line 191 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$category.

◆ setCurrentVersion()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setCurrentVersion (   $currentVersion)
Parameters
bool$currentVersion

Definition at line 406 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$currentVersion.

◆ setDependencies()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setDependencies (   $dependencies)

◆ setDescription()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setDescription (   $description)
Parameters
string$description

Definition at line 245 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$description.

◆ setDistributionImage()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setDistributionImage ( string  $imageUrl)

Definition at line 670 of file Extension.php.

◆ setDistributionWelcomeImage()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setDistributionWelcomeImage ( string  $imageUrl)

Definition at line 680 of file Extension.php.

◆ setDocumentationLink()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setDocumentationLink ( string  $documentationLink)
Parameters
string$documentationLink

Definition at line 609 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$documentationLink.

◆ setExtensionKey()

◆ setIntegerVersion()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setIntegerVersion (   $integerVersion)
Parameters
int$integerVersion

Definition at line 537 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$integerVersion.

◆ setLastUpdated()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setLastUpdated ( \DateTime  $lastUpdated)
Parameters
\DateTime$lastUpdated

Definition at line 277 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$lastUpdated.

◆ setMd5hash()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setMd5hash (   $md5hash)
Parameters
string$md5hash

Definition at line 422 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$md5hash.

◆ setPosition()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setPosition (   $position)
Parameters
int$position

Definition at line 569 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$position.

◆ setReviewState()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setReviewState (   $reviewState)
Parameters
int$reviewState

Definition at line 553 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$reviewState.

◆ setSerializedDependencies()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setSerializedDependencies (   $dependencies)
Parameters
string$dependencies

Definition at line 484 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$dependencies.

◆ setState()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setState (   $state)
Parameters
int$state

Definition at line 293 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$state.

◆ setTitle()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setTitle (   $title)
Parameters
string$title

Definition at line 358 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$title.

◆ setUpdateComment()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setUpdateComment (   $updateComment)
Parameters
string$updateComment

Definition at line 374 of file Extension.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\$updateComment.

◆ setVersion()

Member Data Documentation

◆ $alldownloadcounter

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$alldownloadcounter
protected

◆ $authorEmail

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$authorEmail = ''
protected

◆ $authorName

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$authorName = ''
protected

◆ $category

◆ $currentVersion

bool TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$currentVersion = false
protected

◆ $defaultCategories

array TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$defaultCategories
staticprotected
Initial value:
= array(
0 => 'be',
1 => 'module',
2 => 'fe',
3 => 'plugin',
4 => 'misc',
5 => 'services',
6 => 'templates',
8 => 'doc',
9 => 'example',
self::DISTRIBUTION_CATEGORY => 'distribution',
)

Contains default categories.

Definition at line 38 of file Extension.php.

◆ $defaultStates

array TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$defaultStates
staticprotected
Initial value:
= array(
0 => 'alpha',
1 => 'beta',
2 => 'stable',
3 => 'experimental',
4 => 'test',
5 => 'obsolete',
6 => 'excludeFromUpdates',
7 => 'deprecated',
999 => 'n/a',
)

Contains default states.

Definition at line 55 of file Extension.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getDefaultState().

◆ $dependencies

◆ $description

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$description = ''
protected

◆ $distributionImage

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$distributionImage = ''
protected

◆ $distributionWelcomeImage

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$distributionWelcomeImage = ''
protected

◆ $documentationLink

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$documentationLink = ''
protected

◆ $extensionKey

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$extensionKey = ''
protected

◆ $integerVersion

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$integerVersion = 0
protected

◆ $lastUpdated

DateTime TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$lastUpdated
protected

◆ $md5hash

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$md5hash = ''
protected

◆ $position

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$position = 0
protected

◆ $remote

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$remote
protected

◆ $reviewState

int TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$reviewState
protected

◆ $serializedDependencies

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$serializedDependencies = ''
protected

◆ $state

◆ $title

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$title = ''
protected

◆ $updateComment

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$updateComment = ''
protected

◆ $version

string TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$version = ''
protected

◆ DISTRIBUTION_CATEGORY

const TYPO3\CMS\Extensionmanager\Domain\Model\Extension::DISTRIBUTION_CATEGORY = 10