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)
	addExtensionToCopyQueue ($extensionKey, $sourceFolder)
	removeExtensionFromCopyQueue ($extensionKey)
array	getExtensionInstallStorage ()
bool	isQueueEmpty ($stack='download')
bool	isCopyQueueEmpty ()
array	resetExtensionQueue ($stack=null)
array	resetExtensionCopyStorage ()
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();protected array $extensionCopyStorage=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

addExtensionToCopyQueue()

TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::addExtensionToCopyQueue	(		$extensionKey,
			$sourceFolder
	)

Adds an extension to the copy queue for later copying

Parameters

string	$extensionKey
string	$sourceFolder

Definition at line 117 of file DownloadQueue.php.

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 106 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 139 of file DownloadQueue.php.

getExtensionQueue()

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

(

)

Returns

‪array

Definition at line 77 of file DownloadQueue.php.

isCopyQueueEmpty()

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

(

)

Return whether the copy queue contains extensions or not

Returns

‪bool

Definition at line 160 of file DownloadQueue.php.

isQueueEmpty()

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

(

$stack = 'download'

)

Return whether the queue contains extensions or not

Parameters

string

$stack

Returns

‪bool

Definition at line 150 of file DownloadQueue.php.

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

removeExtensionFromCopyQueue()

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

(

$extensionKey

)

Remove an extension from extension copy storage

Parameters

string

$extensionKey

Definition at line 127 of file DownloadQueue.php.

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 89 of file DownloadQueue.php.

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

resetExtensionCopyStorage()

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

(

)

Resets the copy queue and returns the old extensions

Returns

‪array

Definition at line 189 of file DownloadQueue.php.

resetExtensionInstallStorage()

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

(

)

Resets the install queue and returns the old extensions

Returns

‪array

Definition at line 201 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 171 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( ); protected array $extensionCopyStorage = 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 60 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 71 of file DownloadQueue.php.