Extension.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Domain\Model;

class Extension extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {

    const DISTRIBUTION_CATEGORY = 10;

    static protected $defaultCategories = array(
        0 => 'be',
        1 => 'module',
        2 => 'fe',
        3 => 'plugin',
        4 => 'misc',
        5 => 'services',
        6 => 'templates',
        8 => 'doc',
        9 => 'example',
        Extension::DISTRIBUTION_CATEGORY => 'distribution'
    );

    static protected $defaultStates = array(
        0 => 'alpha',
        1 => 'beta',
        2 => 'stable',
        3 => 'experimental',
        4 => 'test',
        5 => 'obsolete',
        6 => 'excludeFromUpdates',
        999 => 'n/a'
    );

    protected $objectManager;

    protected $extensionKey = '';

    protected $version = '';

    protected $integerVersion = 0;

    protected $title = '';

    protected $description = '';

    protected $state = 0;

    protected $category = 0;

    protected $lastUpdated;

    protected $updateComment = '';

    protected $authorName = '';

    protected $authorEmail = '';

    protected $currentVersion = FALSE;

    protected $md5hash = '';

    protected $reviewState;

    protected $alldownloadcounter;

    protected $serializedDependencies = '';

    protected $dependencies = NULL;

    protected $position = 0;

    public function setAuthorEmail($authorEmail) {
        $this->authorEmail = $authorEmail;
    }

    public function getAuthorEmail() {
        return $this->authorEmail;
    }

    public function setAuthorName($authorName) {
        $this->authorName = $authorName;
    }

    public function getAuthorName() {
        return $this->authorName;
    }

    public function setCategory($category) {
        $this->category = $category;
    }

    public function getCategory() {
        return $this->category;
    }

    public function getCategoryString() {
        $categoryString = '';
        if (isset(self::$defaultCategories[$this->getCategory()])) {
            $categoryString = self::$defaultCategories[$this->getCategory()];
        }
        return $categoryString;
    }

    public function getCategoryIndexFromStringOrNumber($category) {
        $categoryIndex = 4;
        if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($category)) {
            $categoryIndex = (int)$category;
            if ($categoryIndex < 0 || $categoryIndex > 10) {
                $categoryIndex = 4;
            }
        } elseif (is_string($category)) {
            $categoryIndex = array_search($category, self::$defaultCategories);
            if ($categoryIndex === FALSE) {
                $categoryIndex = 4;
            }
        }
        return $categoryIndex;
    }

    public function setDescription($description) {
        $this->description = $description;
    }

    public function getDescription() {
        return $this->description;
    }

    public function setExtensionKey($extensionKey) {
        $this->extensionKey = $extensionKey;
    }

    public function getExtensionKey() {
        return $this->extensionKey;
    }

    public function setLastUpdated(\DateTime $lastUpdated) {
        $this->lastUpdated = $lastUpdated;
    }

    public function getLastUpdated() {
        return $this->lastUpdated;
    }

    public function setState($state) {
        $this->state = $state;
    }

    public function getState() {
        return $this->state;
    }

    public function getStateString() {
        $stateString = '';
        if (isset(self::$defaultStates[$this->getState()])) {
            $stateString = self::$defaultStates[$this->getState()];
        }
        return $stateString;
    }

    public function getDefaultState($state = NULL) {
        $defaultState = '';
        if (is_null($state)) {
            $defaultState = self::$defaultStates;
        } else {
            if (is_string($state)) {
                $stateIndex = array_search(strtolower($state), self::$defaultStates);
                if ($stateIndex === FALSE) {
                    // default state
                    $stateIndex = 999;
                }
                $defaultState = $stateIndex;
            } else {
                if (is_int($state) && $state >= 0) {
                    if (array_key_exists($state, self::$defaultStates)) {
                        $stateTitle = self::$defaultStates[$state];
                    } else {
                        // default state
                        $stateTitle = 'n/a';
                    }
                    $defaultState = $stateTitle;
                }
            }
        }
        return $defaultState;
    }

    public function setTitle($title) {
        $this->title = $title;
    }

    public function getTitle() {
        return $this->title;
    }

    public function setUpdateComment($updateComment) {
        $this->updateComment = $updateComment;
    }

    public function getUpdateComment() {
        return $this->updateComment;
    }

    public function setVersion($version) {
        $this->version = $version;
    }

    public function getVersion() {
        return $this->version;
    }

    public function setCurrentVersion($currentVersion) {
        $this->currentVersion = $currentVersion;
    }

    public function getCurrentVersion() {
        return $this->currentVersion;
    }

    public function setMd5hash($md5hash) {
        $this->md5hash = $md5hash;
    }

    public function getMd5hash() {
        return $this->md5hash;
    }

    static public function returnInstallPaths() {
        $installPaths = array(
            'System' => PATH_typo3 . 'sysext/',
            'Global' => PATH_typo3 . 'ext/',
            'Local' => PATH_typo3conf . 'ext/'
        );
        return $installPaths;
    }

    static public function returnAllowedInstallPaths() {
        $installPaths = self::returnInstallPaths();
        if (empty($GLOBALS['TYPO3_CONF_VARS']['EXT']['allowSystemInstall'])) {
            unset($installPaths['System']);
        }
        if (empty($GLOBALS['TYPO3_CONF_VARS']['EXT']['allowGlobalInstall'])) {
            unset($installPaths['Global']);
        }
        if (empty($GLOBALS['TYPO3_CONF_VARS']['EXT']['allowLocalInstall'])) {
            unset($installPaths['Local']);
        }
        return $installPaths;
    }

    static public function returnAllowedInstallTypes() {
        $installPaths = self::returnAllowedInstallPaths();
        return array_keys($installPaths);
    }

    public function setSerializedDependencies($dependencies) {
        $this->serializedDependencies = $dependencies;
    }

    public function getSerializedDependencies() {
        return $this->serializedDependencies;
    }

    public function setDependencies($dependencies) {
        $this->dependencies = $dependencies;
    }

    public function getDependencies() {
        if (!is_object($this->dependencies)) {
            $extensionModelUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\ExtensionModelUtility');
            $this->setDependencies($extensionModelUtility->convertDependenciesToObjects($this->getSerializedDependencies()));
        }
        return $this->dependencies;
    }

    public function addDependency(\TYPO3\CMS\Extensionmanager\Domain\Model\Dependency $dependency) {
        $this->dependencies->attach($dependency);
    }

    public function setIntegerVersion($integerVersion) {
        $this->integerVersion = $integerVersion;
    }

    public function getIntegerVersion() {
        return $this->integerVersion;
    }

    public function setReviewState($reviewState) {
        $this->reviewState = $reviewState;
    }

    public function getReviewState() {
        return $this->reviewState;
    }

    public function setPosition($position) {
        $this->position = $position;
    }

    public function getPosition() {
        return $this->position;
    }

    public function setAlldownloadcounter($alldownloadcounter) {
        $this->alldownloadcounter = $alldownloadcounter;
    }

    public function getAlldownloadcounter() {
        return $this->alldownloadcounter;
    }

}