TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser Class Reference

Inheritance diagram for TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser:

Public Member Functions
	__construct ()
	parseXml ($file)
	attach (\SplObserver $observer)
	detach (\SplObserver $observer)
	notify ()
	getAlldownloadcounter ()
	getAuthorcompany ()
	getAuthoremail ()
	getAuthorname ()
	getCategory ()
	getDependencies ()
	getDescription ()
	getDownloadcounter ()
	getExtkey ()
	getLastuploaddate ()
	getOwnerusername ()
	getReviewstate ()
	getState ()
	getT3xfilemd5 ()
	getTitle ()
	getUploadcomment ()
	getVersion ()
	isValidVersionNumber ()
	getDocumentationLink ()
	getDistributionImage ()
	getDistributionWelcomeImage ()

Protected Member Functions
	startElement ($parser, $elementName, $attrs)
	endElement ($parser, $elementName)
	resetProperties ($resetAll=false)
	characterData ($parser, string $data)

Protected Attributes
array	$observers = []
string	$elementData = ''
string	$authorcompany = ''
string	$authoremail = ''
string	$authorname = ''
string	$category = ''
string	$dependencies = ''
string	$description = ''
int	$extensionDownloadCounter = 0
string	$extensionKey = ''
int	$lastuploaddate = 0
string	$ownerusername = ''
int	$reviewstate = 0
string	$state = ''
string	$t3xfilemd5 = ''
string	$title = ''
string	$uploadcomment = ''
string	$version = ''
int	$versionDownloadCounter = 0
string	$documentationLink = ''
string	$distributionImage = ''
string	$distributionWelcomeImage = ''

Private Member Functions
	createUnableToOpenFileResourceException (string $file)
	createXmlErrorException ($parser, string $file)

Detailed Description

Parser for TYPO3's extension.xml file.

Depends on PHP ext/xml which is a required composer php extension and enabled in PHP by default since a long time.

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

Definition at line 30 of file ExtensionXmlParser.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::__construct

(

)

Definition at line 68 of file ExtensionXmlParser.php.

Member Function Documentation

attach()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::attach

(

\SplObserver

$observer

)

Method attaches an observer.

Parameters

\SplObserver

$observer

‪an observer to attach

See also

‪detach()

‪notify()

Definition at line 267 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\__construct().

characterData()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::characterData (   $parser, string  $data  )

protected

Method is invoked when parser accesses any character other than elements.

Parameters

resource | \XmlParser	$parser	‪XmlParser with PHP >= 8
string	$data	‪An element's value

Definition at line 255 of file ExtensionXmlParser.php.

createUnableToOpenFileResourceException()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::createUnableToOpenFileResourceException ( string  $file )

private

Definition at line 104 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\parseXml().

createXmlErrorException()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::createXmlErrorException (   $parser, string  $file  )

private

Definition at line 109 of file ExtensionXmlParser.php.

References $parser.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\parseXml().

detach()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::detach

(

\SplObserver

$observer

)

Method detaches an attached observer

Parameters

\SplObserver

$observer

‪an observer to detach

Definition at line 277 of file ExtensionXmlParser.php.

endElement()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::endElement (   $parser,   $elementName  )

protected

Method is invoked when parser accesses end tag of an element.

Parameters

resource	$parser	‪parser resource
string	$elementName	‪Element name at parser's current position

Definition at line 149 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$elementData, TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$version, TYPO3\CMS\Redirects\Message\description, TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\notify(), and TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\resetProperties().

getAlldownloadcounter()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getAlldownloadcounter

(

)

Returns download number sum of all extension's versions.

Definition at line 298 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$extensionDownloadCounter.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getAuthorcompany()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getAuthorcompany

(

)

Returns company name of extension author.

Definition at line 306 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$authorcompany.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getAuthoremail()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getAuthoremail

(

)

Returns e-mail address of extension author.

Definition at line 314 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$authoremail.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getAuthorname()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getAuthorname

(

)

Returns name of extension author.

Definition at line 322 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$authorname.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getCategory()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getCategory

(

)

Returns category of an extension.

Definition at line 330 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$category.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDependencies()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDependencies

(

)

Returns dependencies of an extension's version as a serialized string

Definition at line 338 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$dependencies.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDescription()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDescription

(

)

Returns description of an extension's version.

Definition at line 346 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$description.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDistributionImage()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDistributionImage

(

)

Returns distribution image url.

Definition at line 451 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$distributionImage.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDistributionWelcomeImage()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDistributionWelcomeImage

(

)

Returns distribution welcome image url.

Definition at line 459 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$distributionWelcomeImage.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDocumentationLink()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDocumentationLink

(

)

Returns documentation link.

Definition at line 443 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$documentationLink.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getDownloadcounter()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getDownloadcounter

(

)

Returns download number of an extension's version.

Definition at line 354 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$versionDownloadCounter.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getExtkey()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getExtkey

(

)

Returns key of an extension.

Definition at line 362 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$extensionKey.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getLastuploaddate()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getLastuploaddate

(

)

Returns last uploaddate of an extension's version.

Definition at line 370 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$lastuploaddate.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getOwnerusername()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getOwnerusername

(

)

Returns username of extension owner.

Definition at line 378 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$ownerusername.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getReviewstate()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getReviewstate

(

)

Returns review state of an extension's version.

Definition at line 386 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$reviewstate.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getState()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getState

(

)

Returns state of an extension's version.

Definition at line 394 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$state.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getT3xfilemd5()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getT3xfilemd5

(

)

Returns t3x file hash of an extension's version.

Definition at line 402 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$t3xfilemd5.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getTitle()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getTitle

(

)

Returns title of an extension's version.

Definition at line 410 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$title.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getUploadcomment()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getUploadcomment

(

)

Returns extension upload comment.

Definition at line 418 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$uploadcomment.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

getVersion()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::getVersion

(

)

Returns version number as unparsed string.

Definition at line 426 of file ExtensionXmlParser.php.

References TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\$version.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

isValidVersionNumber()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::isValidVersionNumber

(

)

Whether the current version number is valid

Definition at line 434 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Repository\BulkExtensionRepositoryWriter\loadIntoDatabase().

notify()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::notify

(

)

Method notifies attached observers.

Definition at line 288 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\endElement().

parseXml()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::parseXml

(

$file

)

Method parses an extensions.xml file.

Parameters

string

$file

‪GZIP stream resource

Exceptions

ExtensionManagerException

‪in case of parse errors

Definition at line 81 of file ExtensionXmlParser.php.

References $parser, TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\createUnableToOpenFileResourceException(), and TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\createXmlErrorException().

resetProperties()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::resetProperties (   $resetAll = false )

protected

Method resets version class properties.

Parameters

bool

$resetAll

‪If TRUE, additionally extension properties are reset

Definition at line 236 of file ExtensionXmlParser.php.

References TYPO3\CMS\Redirects\Message\description.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\endElement().

startElement()

TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::startElement (   $parser,   $elementName,   $attrs  )

protected

Method is invoked when parser accesses start tag of an element.

Parameters

resource	$parser	‪parser resource
string	$elementName	‪element name at parser's current position
array	$attrs	‪array of an element's attributes if available

Definition at line 129 of file ExtensionXmlParser.php.

Member Data Documentation

$authorcompany

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$authorcompany = ''

protected

Parsed property data

Definition at line 47 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getAuthorcompany().

$authoremail

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$authoremail = ''

protected

Definition at line 48 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getAuthoremail().

$authorname

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$authorname = ''

protected

Definition at line 49 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getAuthorname().

$category

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$category = ''

protected

Definition at line 50 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getCategory().

$dependencies

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$dependencies = ''

protected

Definition at line 51 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDependencies().

$description

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$description = ''

protected

Definition at line 52 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDescription().

$distributionImage

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$distributionImage = ''

protected

Definition at line 65 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDistributionImage().

$distributionWelcomeImage

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$distributionWelcomeImage = ''

protected

Definition at line 66 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDistributionWelcomeImage().

$documentationLink

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$documentationLink = ''

protected

Definition at line 64 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDocumentationLink().

$elementData

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$elementData = ''

protected

Keeps current data of element to process.

Definition at line 42 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\endElement().

$extensionDownloadCounter

int TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$extensionDownloadCounter = 0

protected

Definition at line 53 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getAlldownloadcounter().

$extensionKey

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$extensionKey = ''

protected

Definition at line 54 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getExtkey().

$lastuploaddate

int TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$lastuploaddate = 0

protected

Definition at line 55 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getLastuploaddate().

$observers

array TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$observers = []

protected

Definition at line 37 of file ExtensionXmlParser.php.

$ownerusername

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$ownerusername = ''

protected

Definition at line 56 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getOwnerusername().

$reviewstate

int TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$reviewstate = 0

protected

Definition at line 57 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getReviewstate().

$state

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$state = ''

protected

Definition at line 58 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getState().

$t3xfilemd5

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$t3xfilemd5 = ''

protected

Definition at line 59 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getT3xfilemd5().

$title

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$title = ''

protected

Definition at line 60 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getTitle().

$uploadcomment

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$uploadcomment = ''

protected

Definition at line 61 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getUploadcomment().

$version

string TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$version = ''

protected

Definition at line 62 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\endElement(), and TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getVersion().

$versionDownloadCounter

int TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser::$versionDownloadCounter = 0

protected

Definition at line 63 of file ExtensionXmlParser.php.

Referenced by TYPO3\CMS\Extensionmanager\Parser\ExtensionXmlParser\getDownloadcounter().