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

Static Public Member Functions

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

Public Attributes

const DISTRIBUTION_CATEGORY = 10
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
const PROPERTY_UID = 'uid'
 
const PROPERTY_PID = 'pid'
 
const PROPERTY_LOCALIZED_UID = '_localizedUid'
 
const PROPERTY_LANGUAGE_UID = '_languageUid'
 
const PROPERTY_VERSIONED_UID = '_versionedUid'
 
int< 1, function getUid():?int { if( $this->uid !==null) { return(int) $this-> uid
 
return null
 
int< 0, function getPid():int|null { if( $this->pid===null) { return null;} return(int) $this-> pid
 
array< non-empty-string, function _getProperties():array { $properties=get_object_vars( $this);foreach( $properties as $propertyName=> $propertyValue) { if(str_starts_with( $propertyName, '_')) { unset( $properties[ $propertyName]);} } return $properties;} public function _hasProperty(string $propertyName):bool { return property_exists( $this, $propertyName);} public function _isNew():bool { return $this-> uid === null
 
array< non-empty-string, function _getCleanProperties():array { return $this-> _cleanProperties
 

Protected Member Functions

SplObjectStorage< DependencyconvertDependenciesToObjects (string $dependencies)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
 isPropertyDirty (mixed $previousValue, mixed $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 null $dependencies = null
 
string $documentationLink = ''
 
string $distributionImage = ''
 
string $distributionWelcomeImage = ''
 
string $remote
 
int $position = 0
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
int $uid = null
 
int $_localizedUid = null
 
int $_languageUid = null
 
int $_versionedUid = null
 
int $pid = null
 

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 29 of file Extension.php.

Member Function Documentation

◆ addDependency()

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

Definition at line 355 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

Returns
‪\SplObjectStorage<Dependency>

Definition at line 437 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()

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

◆ getAuthorEmail()

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

◆ getAuthorName()

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

◆ getCategory()

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

◆ getCategoryIndexFromStringOrNumber()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getCategoryIndexFromStringOrNumber ( mixed  $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.

Definition at line 144 of file Extension.php.

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

◆ getCategoryString()

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

Get Category String

Definition at line 131 of file Extension.php.

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

◆ getCurrentVersion()

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

◆ getDefaultState()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::getDefaultState ( int|string|null  $state = null)

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

Definition at line 214 of file Extension.php.

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

◆ getDependencies()

◆ getDescription()

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

◆ getDistributionImage()

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

◆ getDistributionWelcomeImage()

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

◆ getDocumentationLink()

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

◆ getExtensionKey()

◆ getIntegerVersion()

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

◆ getLastUpdated()

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

◆ getMd5hash()

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

◆ getPosition()

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

◆ getRemoteIdentifier()

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

◆ getReviewState()

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

◆ getSerializedDependencies()

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

◆ getState()

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

◆ getStateString()

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

◆ getTitle()

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

◆ getTypo3Dependency()

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

◆ getUpdateComment()

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

◆ getVersion()

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

◆ returnAllowedInstallTypes()

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

◆ returnInstallPaths()

◆ setAlldownloadcounter()

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

◆ setAuthorEmail()

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

◆ setAuthorName()

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

◆ setCategory()

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

◆ setCurrentVersion()

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

◆ setDependencies()

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

◆ setDescription()

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

◆ setDistributionImage()

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

Definition at line 462 of file Extension.php.

◆ setDistributionWelcomeImage()

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

Definition at line 472 of file Extension.php.

◆ setDocumentationLink()

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

◆ setExtensionKey()

◆ setIntegerVersion()

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

◆ setLastUpdated()

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

◆ setMd5hash()

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

◆ setPosition()

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

◆ setReviewState()

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

◆ setSerializedDependencies()

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

◆ setState()

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

◆ setTitle()

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

◆ setUpdateComment()

TYPO3\CMS\Extensionmanager\Domain\Model\Extension::setUpdateComment ( string  $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:
= [
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 39 of file Extension.php.

◆ $defaultStates

array TYPO3\CMS\Extensionmanager\Domain\Model\Extension::$defaultStates
staticprotected
Initial value:
= [
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