Extension extends AbstractEntity

Main extension model

Internal

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

Table of Contents

Constants

DISTRIBUTION_CATEGORY  = 10
Category index for distributions
PROPERTY_LANGUAGE_UID  = '_languageUid'
PROPERTY_LOCALIZED_UID  = '_localizedUid'
PROPERTY_PID  = 'pid'
PROPERTY_UID  = 'uid'
PROPERTY_VERSIONED_UID  = '_versionedUid'

Properties

$_languageUid  : int<-1, max>|null
$_localizedUid  : int<0, max>|null
$_versionedUid  : int|null
The uid of the versioned record.
$alldownloadcounter  : int
$authorEmail  : string
$authorName  : string
$category  : int
$currentVersion  : bool
$defaultCategories  : array<string|int, mixed>
Contains default categories.
$defaultStates  : array<string|int, mixed>
Contains default states.
$dependencies  : SplObjectStorage<string|int, Dependency>
$description  : string
$distributionImage  : string
$distributionWelcomeImage  : string
$documentationLink  : string
$extensionKey  : string
$integerVersion  : int
$lastUpdated  : DateTime
$md5hash  : string
$pid  : int<0, max>|null
$position  : int
$remote  : string
$reviewState  : int
$serializedDependencies  : string
$state  : int
$title  : string
$uid  : int<1, max>|null
$updateComment  : string
$version  : string

Methods

__clone()  : mixed
__toString()  : non-empty-string
_getCleanProperties()  : array<non-empty-string, mixed>
Returns a hash map of clean properties and $values.
_getCleanProperty()  : mixed
Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.
_getProperties()  : array<non-empty-string, mixed>
_getProperty()  : mixed
_hasProperty()  : bool
_isClone()  : bool
_isDirty()  : bool
Returns TRUE if the properties were modified after reconstitution
_isNew()  : bool
Returns TRUE if the object is new (the uid was not set, yet)
_memorizeCleanState()  : void
Register an object's clean state, e.g. after it has been reconstituted from the database.
_memorizePropertyCleanState()  : void
Register a property's clean state, e.g. after it has been reconstituted from the database.
_setClone()  : mixed
Setter whether this Domain Object is a clone of another one.
_setProperty()  : bool
addDependency()  : mixed
createFromExtensionArray()  : self
Map a legacy extension array to an object
getAlldownloadcounter()  : int
getAuthorEmail()  : string
getAuthorName()  : string
getCategory()  : int
getCategoryIndexFromStringOrNumber()  : int
Returns category index from a given string or an integer.
getCategoryString()  : string
Get Category String
getCurrentVersion()  : bool
getDefaultState()  : mixed
Returns either array with all default states or index/title of a state entry.
getDependencies()  : SplObjectStorage<string|int, Dependency>
getDescription()  : string
getDistributionImage()  : string
getDistributionWelcomeImage()  : string
getDocumentationLink()  : string
getExtensionKey()  : string
getIntegerVersion()  : int
getLastUpdated()  : DateTime
getMd5hash()  : string
getPid()  : int<0, max>|null
getPosition()  : int
getRemoteIdentifier()  : string
getReviewState()  : int
getSerializedDependencies()  : string
getState()  : int
getStateString()  : string
Get State string
getTitle()  : string
getTypo3Dependency()  : Dependency|null
getUid()  : int<1, max>|null
getUpdateComment()  : string
getVersion()  : string
returnAllowedInstallTypes()  : array<string|int, mixed>
Allowed install names: System, Local
returnInstallPaths()  : array<string|int, mixed>
Possible install paths
setAlldownloadcounter()  : mixed
setAuthorEmail()  : mixed
setAuthorName()  : mixed
setCategory()  : mixed
setCurrentVersion()  : mixed
setDependencies()  : mixed
setDescription()  : mixed
setDistributionImage()  : void
setDistributionWelcomeImage()  : void
setDocumentationLink()  : void
setExtensionKey()  : mixed
setIntegerVersion()  : mixed
setLastUpdated()  : mixed
setMd5hash()  : mixed
setPid()  : void
setPosition()  : mixed
setReviewState()  : mixed
setSerializedDependencies()  : mixed
setState()  : mixed
setTitle()  : mixed
setUpdateComment()  : mixed
setVersion()  : mixed
convertDependenciesToObjects()  : SplObjectStorage<string|int, Dependency>
Converts string dependencies to an object storage of dependencies
isPropertyDirty()  : bool
Checks the $value against the $cleanState.

Constants

DISTRIBUTION_CATEGORY

Category index for distributions

public mixed DISTRIBUTION_CATEGORY = 10

PROPERTY_LANGUAGE_UID

public mixed PROPERTY_LANGUAGE_UID = '_languageUid'

PROPERTY_LOCALIZED_UID

public mixed PROPERTY_LOCALIZED_UID = '_localizedUid'

PROPERTY_PID

public mixed PROPERTY_PID = 'pid'

PROPERTY_UID

public mixed PROPERTY_UID = 'uid'

PROPERTY_VERSIONED_UID

public mixed PROPERTY_VERSIONED_UID = '_versionedUid'

Properties

$_languageUid

protected int<-1, max>|null $_languageUid = null

The uid of the language of the object. This is the id of the corresponding sing language.

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_localizedUid

protected int<0, max>|null $_localizedUid = null

The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_versionedUid

The uid of the versioned record.

protected int|null $_versionedUid = null
Internal
Tags
todo

make private in 13.0 and expose value via getter

$alldownloadcounter

protected int $alldownloadcounter

$authorEmail

protected string $authorEmail = ''

$authorName

protected string $authorName = ''

$currentVersion

protected bool $currentVersion = false

$defaultCategories

Contains default categories.

protected static array<string|int, mixed> $defaultCategories = [0 => 'be', 1 => 'module', 2 => 'fe', 3 => 'plugin', 4 => 'misc', 5 => 'services', 6 => 'templates', 8 => 'doc', 9 => 'example', self::DISTRIBUTION_CATEGORY => 'distribution']

$defaultStates

Contains default states.

protected static array<string|int, mixed> $defaultStates = [0 => 'alpha', 1 => 'beta', 2 => 'stable', 3 => 'experimental', 4 => 'test', 5 => 'obsolete', 6 => 'excludeFromUpdates', 7 => 'deprecated', 999 => 'n/a']

$description

protected string $description = ''

$distributionImage

protected string $distributionImage = ''

$distributionWelcomeImage

protected string $distributionWelcomeImage = ''

$documentationLink

protected string $documentationLink = ''

$extensionKey

protected string $extensionKey = ''

$integerVersion

protected int $integerVersion = 0

$lastUpdated

protected DateTime $lastUpdated

$pid

protected int<0, max>|null $pid

The id of the page the record is "stored".

Tags
todo

introduce type declarations in 13.0 (possibly breaking)

$position

protected int $position = 0
Internal

$serializedDependencies

protected string $serializedDependencies = ''

$uid

protected int<1, max>|null $uid

The uid of the record. The uid is only unique in the context of the database table.

Tags
todo

introduce type declarations in 13.0 (possibly breaking)

$updateComment

protected string $updateComment = ''

Methods

__toString()

public __toString() : non-empty-string
Return values
non-empty-string

_getCleanProperties()

Returns a hash map of clean properties and $values.

public _getCleanProperties() : array<non-empty-string, mixed>
Return values
array<non-empty-string, mixed>

_getCleanProperty()

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

public _getCleanProperty(non-empty-string $propertyName) : mixed
Parameters
$propertyName : non-empty-string

The name of the property to be memorized.

Internal
Return values
mixed —

The clean property value or NULL

_getProperties()

public _getProperties() : array<non-empty-string, mixed>
Internal
Return values
array<non-empty-string, mixed> —

a hash map of property names and property values.

_getProperty()

public _getProperty(string $propertyName) : mixed
Parameters
$propertyName : string
Internal

_hasProperty()

public _hasProperty(non-empty-string $propertyName) : bool
Parameters
$propertyName : non-empty-string
Internal
Return values
bool

_isClone()

public _isClone() : bool
Return values
bool

_isDirty()

Returns TRUE if the properties were modified after reconstitution

public _isDirty([non-empty-string|null $propertyName = null ]) : bool
Parameters
$propertyName : non-empty-string|null = null

An optional name of a property to be checked if its value is dirty

Tags
throws
TooDirtyException
Return values
bool

_isNew()

Returns TRUE if the object is new (the uid was not set, yet)

public _isNew() : bool
Internal
Return values
bool

_memorizeCleanState()

Register an object's clean state, e.g. after it has been reconstituted from the database.

public _memorizeCleanState([non-empty-string|null $propertyName = null ]) : void
Parameters
$propertyName : non-empty-string|null = null

The name of the property to be memorized. If omitted all persistable properties are memorized.

_memorizePropertyCleanState()

Register a property's clean state, e.g. after it has been reconstituted from the database.

public _memorizePropertyCleanState(non-empty-string $propertyName) : void
Parameters
$propertyName : non-empty-string

The name of the property to be memorized. If omitted all persistable properties are memorized.

_setClone()

Setter whether this Domain Object is a clone of another one.

public _setClone(bool $clone) : mixed

NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.

Parameters
$clone : bool
Internal

_setProperty()

public _setProperty(string $propertyName, mixed $propertyValue) : bool
Parameters
$propertyName : string
$propertyValue : mixed
Internal
Return values
bool

createFromExtensionArray()

Map a legacy extension array to an object

public static createFromExtensionArray(array<string|int, mixed> $extensionArray) : self
Parameters
$extensionArray : array<string|int, mixed>
Return values
self

getAlldownloadcounter()

public getAlldownloadcounter() : int
Return values
int

getAuthorEmail()

public getAuthorEmail() : string
Return values
string

getAuthorName()

public getAuthorName() : string
Return values
string

getCategory()

public getCategory() : int
Return values
int

getCategoryIndexFromStringOrNumber()

Returns category index from a given string or an integer.

public getCategoryIndexFromStringOrNumber(string|int $category) : int

Fallback to 4 - 'misc' in case string is not found or integer ist out of range.

Parameters
$category : string|int

Category string or integer

Return values
int —

Valid category index

getCategoryString()

Get Category String

public getCategoryString() : string
Return values
string

getCurrentVersion()

public getCurrentVersion() : bool
Return values
bool

getDefaultState()

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

public getDefaultState([mixed $state = null ]) : mixed
Parameters
$state : mixed = null

state title or state index

getDescription()

public getDescription() : string
Return values
string

getDistributionImage()

public getDistributionImage() : string
Return values
string

getDistributionWelcomeImage()

public getDistributionWelcomeImage() : string
Return values
string

getDocumentationLink()

public getDocumentationLink() : string
Return values
string

getExtensionKey()

public getExtensionKey() : string
Return values
string

getIntegerVersion()

public getIntegerVersion() : int
Return values
int

getLastUpdated()

public getLastUpdated() : DateTime
Return values
DateTime

getMd5hash()

public getMd5hash() : string
Return values
string

getPid()

public getPid() : int<0, max>|null
Return values
int<0, max>|null

getPosition()

public getPosition() : int
Return values
int

getRemoteIdentifier()

public getRemoteIdentifier() : string
Return values
string

getReviewState()

public getReviewState() : int
Return values
int

getSerializedDependencies()

public getSerializedDependencies() : string
Return values
string

getState()

public getState() : int
Return values
int

getStateString()

Get State string

public getStateString() : string
Return values
string

getTitle()

public getTitle() : string
Return values
string

getUid()

public getUid() : int<1, max>|null
Return values
int<1, max>|null

getUpdateComment()

public getUpdateComment() : string
Return values
string

getVersion()

public getVersion() : string
Return values
string

returnAllowedInstallTypes()

Allowed install names: System, Local

public static returnAllowedInstallTypes() : array<string|int, mixed>
Tags
static
Return values
array<string|int, mixed>

returnInstallPaths()

Possible install paths

public static returnInstallPaths() : array<string|int, mixed>
Tags
static
Return values
array<string|int, mixed>

setAlldownloadcounter()

public setAlldownloadcounter(int $alldownloadcounter) : mixed
Parameters
$alldownloadcounter : int

setAuthorEmail()

public setAuthorEmail(string $authorEmail) : mixed
Parameters
$authorEmail : string

setAuthorName()

public setAuthorName(string $authorName) : mixed
Parameters
$authorName : string

setCategory()

public setCategory(int $category) : mixed
Parameters
$category : int

setCurrentVersion()

public setCurrentVersion(bool $currentVersion) : mixed
Parameters
$currentVersion : bool

setDependencies()

public setDependencies(SplObjectStorage<string|int, Dependency> $dependencies) : mixed
Parameters
$dependencies : SplObjectStorage<string|int, Dependency>

setDescription()

public setDescription(string $description) : mixed
Parameters
$description : string

setDistributionImage()

public setDistributionImage(string $imageUrl) : void
Parameters
$imageUrl : string

setDistributionWelcomeImage()

public setDistributionWelcomeImage(string $imageUrl) : void
Parameters
$imageUrl : string

setDocumentationLink()

public setDocumentationLink(string $documentationLink) : void
Parameters
$documentationLink : string

setExtensionKey()

public setExtensionKey(string $extensionKey) : mixed
Parameters
$extensionKey : string

setIntegerVersion()

public setIntegerVersion(int $integerVersion) : mixed
Parameters
$integerVersion : int

setLastUpdated()

public setLastUpdated(DateTime $lastUpdated) : mixed
Parameters
$lastUpdated : DateTime

setMd5hash()

public setMd5hash(string $md5hash) : mixed
Parameters
$md5hash : string

setPid()

public setPid(int<0, max> $pid) : void
Parameters
$pid : int<0, max>

setPosition()

public setPosition(int $position) : mixed
Parameters
$position : int

setReviewState()

public setReviewState(int $reviewState) : mixed
Parameters
$reviewState : int

setSerializedDependencies()

public setSerializedDependencies(string $dependencies) : mixed
Parameters
$dependencies : string

setState()

public setState(int $state) : mixed
Parameters
$state : int

setTitle()

public setTitle(string $title) : mixed
Parameters
$title : string

setUpdateComment()

public setUpdateComment(string $updateComment) : mixed
Parameters
$updateComment : string

setVersion()

public setVersion(string $version) : mixed
Parameters
$version : string

convertDependenciesToObjects()

Converts string dependencies to an object storage of dependencies

protected convertDependenciesToObjects(string $dependencies) : SplObjectStorage<string|int, Dependency>
Parameters
$dependencies : string
Return values
SplObjectStorage<string|int, Dependency>

isPropertyDirty()

Checks the $value against the $cleanState.

protected isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
$previousValue : mixed
$currentValue : mixed
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results