TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue Class Reference

Inheritance diagram for TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue:

Public Member Functions
array	getExtensionQueue ()
	removeExtensionFromQueue (Extension $extension, $stack='download')
	addExtensionToInstallQueue ($extension)
array	getExtensionInstallStorage ()
bool	isQueueEmpty ($stack)
array	resetExtensionQueue ($stack=null)
array	resetExtensionInstallStorage ()

Public Attributes
if(array_key_exists($extension->getExtensionKey(), $this->extensionStorage[$stack])) $this	extensionStorage [$stack][$extension->getExtensionKey()] = $extension

Protected Attributes
array< string, $extensionStorage=array();protected array $extensionInstallStorage=array();public function addExtensionToQueue(Extension $extension, $stack='download') { if(!is_string( $stack)||!in_array( $stack,[ 'download', 'update'])) { throw new ExtensionManagerException( 'Stack has to be either "download" or "update"', 1342432103);} if(!isset( $this->extensionStorage[ $stack])) { $this->	extensionStorage [$stack] = []

Detailed Description

Download Queue - storage for extensions to be downloaded

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

Definition at line 25 of file DownloadQueue.php.

Member Function Documentation

addExtensionToInstallQueue()

TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::addExtensionToInstallQueue

(

$extension

)

Adds an extension to the install queue for later installation

Parameters

Extension

$extension

Definition at line 100 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey().

getExtensionInstallStorage()

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::getExtensionInstallStorage

(

)

Gets the extension installation queue

Returns

‪array

Definition at line 110 of file DownloadQueue.php.

getExtensionQueue()

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::getExtensionQueue

(

)

Returns

‪array

Definition at line 71 of file DownloadQueue.php.

isQueueEmpty()

bool TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::isQueueEmpty

(

$stack

)

Return whether the queue contains extensions or not

Parameters

string

$stack

‪either "download" or "update"

Returns

‪bool

Definition at line 121 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\extensionStorage.

removeExtensionFromQueue()

TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::removeExtensionFromQueue	(	Extension	$extension,
			$stack = 'download'
	)

Remove an extension from download queue

Parameters

Extension	$extension
string	$stack	‪Stack to remove extension from (download, update or install)

Exceptions

ExtensionManagerException

Definition at line 83 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\extensionStorage, and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey().

resetExtensionInstallStorage()

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::resetExtensionInstallStorage

(

)

Resets the install queue and returns the old extensions

Returns

‪array

Definition at line 150 of file DownloadQueue.php.

resetExtensionQueue()

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::resetExtensionQueue

(

$stack = null

)

Resets the extension queue and returns old extensions

Parameters

string | null

$stack

‪if null, all stacks are reset

Returns

‪array

Definition at line 132 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\extensionStorage.

Member Data Documentation

extensionStorage [1/2]

array<string, $extensionStorage = array( ); protected array $extensionInstallStorage = array( ); public function addExtensionToQueue(Extension $extension, $stack = 'download') { if (!is_string($stack) || !in_array($stack, ['download', 'update'])) { throw new ExtensionManagerException('Stack has to be either "download" or "update"', 1342432103); } if (!isset($this->extensionStorage[$stack])) { $this-> TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::extensionStorage[ $stack] = []

protected

Storage for extensions to be downloaded

array<string>>

Definition at line 54 of file DownloadQueue.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\isQueueEmpty(), TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\removeExtensionFromQueue(), and TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\resetExtensionQueue().

extensionStorage [2/2]

if (array_key_exists( $extension->getExtensionKey(), $this->extensionStorage[ $stack])) $this TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::extensionStorage[ $stack][ $extension->getExtensionKey()] = $extension

Definition at line 65 of file DownloadQueue.php.