AbstractExtensionXmlParser.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extensionmanager\Utility\Parser;
 
abstract class ‪AbstractExtensionXmlParser extends ‪AbstractXmlParser
{
    protected ‪$authorcompany;
 
    protected ‪$authoremail;
 
    protected ‪$authorname;
 
    protected ‪$category;
 
    protected ‪$dependencies;
 
    protected ‪$description;
 
    protected ‪$extensionDownloadCounter;
 
    protected ‪$extensionKey;
 
    protected ‪$lastuploaddate;
 
    protected ‪$ownerusername;
 
    protected ‪$reviewstate;
 
    protected ‪$state;
 
    protected ‪$t3xfilemd5;
 
    protected ‪$title;
 
    protected ‪$uploadcomment;
 
    protected ‪$version;
 
    protected ‪$versionDownloadCounter;
 
    protected ‪$documentationLink;
 
    public function ‪getAll()
    {
        $versionProperties = [];
        $versionProperties['extkey'] = ‪$this->extensionKey;
        $versionProperties['version'] = ‪$this->version;
        $versionProperties['alldownloadcounter'] = ‪$this->extensionDownloadCounter;
        $versionProperties['downloadcounter'] = ‪$this->versionDownloadCounter;
        $versionProperties['title'] = ‪$this->title;
        $versionProperties['description'] = ‪$this->description;
        $versionProperties['state'] = ‪$this->state;
        $versionProperties['reviewstate'] = ‪$this->reviewstate;
        $versionProperties['category'] = ‪$this->category;
        $versionProperties['lastuploaddate'] = ‪$this->lastuploaddate;
        $versionProperties['uploadcomment'] = ‪$this->uploadcomment;
        $versionProperties['dependencies'] = ‪$this->dependencies;
        $versionProperties['authorname'] = ‪$this->authorname;
        $versionProperties['authoremail'] = ‪$this->authoremail;
        $versionProperties['authorcompany'] = ‪$this->authorcompany;
        $versionProperties['ownerusername'] = ‪$this->ownerusername;
        $versionProperties['t3xfilemd5'] = ‪$this->t3xfilemd5;
        $versionProperties['documentationlink'] = ‪$this->documentationLink;
        return $versionProperties;
    }
 
    public function ‪getAlldownloadcounter()
    {
        return ‪$this->extensionDownloadCounter;
    }
 
    public function ‪getAuthorcompany()
    {
        return ‪$this->authorcompany;
    }
 
    public function ‪getAuthoremail()
    {
        return ‪$this->authoremail;
    }
 
    public function ‪getAuthorname()
    {
        return ‪$this->authorname;
    }
 
    public function ‪getCategory()
    {
        return ‪$this->category;
    }
 
    public function ‪getDependencies()
    {
        return ‪$this->dependencies;
    }
 
    public function ‪getDescription()
    {
        return ‪$this->description;
    }
 
    public function ‪getDownloadcounter()
    {
        return ‪$this->versionDownloadCounter;
    }
 
    public function ‪getExtkey()
    {
        return ‪$this->extensionKey;
    }
 
    public function ‪getLastuploaddate()
    {
        return ‪$this->lastuploaddate;
    }
 
    public function ‪getOwnerusername()
    {
        return ‪$this->ownerusername;
    }
 
    public function ‪getReviewstate()
    {
        return ‪$this->reviewstate;
    }
 
    public function ‪getState()
    {
        return ‪$this->state;
    }
 
    public function ‪getT3xfilemd5()
    {
        return ‪$this->t3xfilemd5;
    }
 
    public function ‪getTitle()
    {
        return ‪$this->title;
    }
 
    public function ‪getUploadcomment()
    {
        return ‪$this->uploadcomment;
    }
 
    public function ‪getVersion()
    {
        return ‪$this->version;
    }
 
    public function ‪isValidVersionNumber(): bool
    {
        // Validate the version number, see `isValidVersionNumber` in TER API
        return (bool)preg_match('/^(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})$/', $this->version);
    }
 
    public function ‪getDocumentationLink()
    {
        return ‪$this->documentationLink;
    }
 
    protected function ‪resetProperties($resetAll = false)
    {
        // resetting at least class property "version" is mandatory
        // as we need to do some magic in regards to
        // an extension's and version's child node "downloadcounter"
        $this->version = $this->title = $this->versionDownloadCounter = $this->description = $this->state = $this->reviewstate = $this->category = $this->lastuploaddate = $this->uploadcomment = $this->dependencies = $this->authorname = $this->authoremail = $this->authorcompany = $this->ownerusername = $this->t3xfilemd5 = $this->documentationLink = null;
        if ($resetAll) {
            $this->extensionKey = $this->extensionDownloadCounter = null;
        }
    }
 
    protected function ‪convertDependencies(‪$dependencies)
    {
        $newDependencies = [];
        $dependenciesArray = unserialize(‪$dependencies, ['allowed_classes' => false]);
        if (is_array($dependenciesArray)) {
            foreach ($dependenciesArray as ‪$version) {
                if (!empty(‪$version['kind']) && !empty(‪$version['extensionKey'])) {
                    $newDependencies[‪$version['kind']][‪$version['extensionKey']] = ‪$version['versionRange'];
                }
            }
        }
        return serialize($newDependencies);
    }
}