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

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

Public Member Functions
	injectListUtility (\TYPO3\CMS\Extensionmanager\Utility\ListUtility $listUtility)
	addExtensionToQueue (\TYPO3\CMS\Extensionmanager\Domain\Model\Extension $extension, $stack='download')
array	getExtensionQueue ()
	removeExtensionFromQueue (\TYPO3\CMS\Extensionmanager\Domain\Model\Extension $extension, $stack='download')
	addExtensionToInstallQueue ($extension)
	removeExtensionFromInstallQueue ($extensionKey)
	addExtensionToCopyQueue ($extensionKey, $sourceFolder)
	removeExtensionFromCopyQueue ($extensionKey)
array	getExtensionInstallStorage ()
array	getExtensionCopyStorage ()
bool	isQueueEmpty ($stack='download')
bool	isCopyQueueEmpty ()
bool	isInstallQueueEmpty ()
array	resetExtensionQueue ($stack=null)
array	resetExtensionCopyStorage ()
array	resetExtensionInstallStorage ()

Protected Attributes
Extension[string][string]	$extensionStorage = array( )
array	$extensionInstallStorage = array( )
array	$extensionCopyStorage = array( )
TYPO3 CMS Extensionmanager Utility ListUtility	$listUtility

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

addExtensionToQueue()

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

Adds an extension to the download queue. If the extension was already requested in a different version an exception is thrown.

Parameters

\TYPO3\CMS\Extensionmanager\Domain\Model\Extension	$extension
string	$stack

Exceptions

Definition at line 64 of file DownloadQueue.php.

getExtensionCopyStorage()

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

(

)

Gets the extension copy queue

Returns

‪array

Definition at line 171 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\$extensionCopyStorage.

getExtensionInstallStorage()

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

(

)

Gets the extension installation queue

Returns

‪array

Definition at line 161 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\$extensionInstallStorage.

getExtensionQueue()

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

(

)

Returns

‪array

Definition at line 87 of file DownloadQueue.php.

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

injectListUtility()

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

(

\TYPO3\CMS\Extensionmanager\Utility\ListUtility

$listUtility

)

Parameters

\TYPO3\CMS\Extensionmanager\Utility\ListUtility

$listUtility

Definition at line 50 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\$listUtility.

isCopyQueueEmpty()

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

(

)

Return whether the copy queue contains extensions or not

Returns

‪bool

Definition at line 192 of file DownloadQueue.php.

isInstallQueueEmpty()

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

(

)

Return whether the install queue contains extensions or not

Returns

‪bool

Definition at line 202 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 182 of file DownloadQueue.php.

removeExtensionFromCopyQueue()

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

(

$extensionKey

)

Remove an extension from extension copy storage

Parameters

$extensionKey

Definition at line 149 of file DownloadQueue.php.

removeExtensionFromInstallQueue()

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

(

$extensionKey

)

Removes an extension from the install queue

Parameters

string

$extensionKey

Definition at line 126 of file DownloadQueue.php.

removeExtensionFromQueue()

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

Remove an extension from download queue

Parameters

\TYPO3\CMS\Extensionmanager\Domain\Model\Extension	$extension
string	$stack	‪Stack to remove extension from (download, update or install)

Exceptions

Definition at line 99 of file DownloadQueue.php.

resetExtensionCopyStorage()

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

(

)

Resets the copy queue and returns the old extensions

Returns

‪array

Definition at line 231 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\$extensionCopyStorage.

resetExtensionInstallStorage()

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

(

)

Resets the install queue and returns the old extensions

Returns

‪array

Definition at line 243 of file DownloadQueue.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\$extensionInstallStorage.

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

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

Member Data Documentation

$extensionCopyStorage

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::$extensionCopyStorage = array( )

protected

Storage for extensions to be copied

Definition at line 41 of file DownloadQueue.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\getExtensionCopyStorage(), and TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\resetExtensionCopyStorage().

$extensionInstallStorage

array TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::$extensionInstallStorage = array( )

protected

Storage for extensions to be installed

Definition at line 35 of file DownloadQueue.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\getExtensionInstallStorage(), and TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\resetExtensionInstallStorage().

$extensionStorage

Extension [string][string] TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::$extensionStorage = array( )

protected

Storage for extensions to be downloaded

Definition at line 29 of file DownloadQueue.php.

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

$listUtility

TYPO3 CMS Extensionmanager Utility ListUtility TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue::$listUtility

protected

Definition at line 45 of file DownloadQueue.php.

Referenced by TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue\injectListUtility().