TYPO3\Flow\Package\PackageManagerInterface Interface Reference

Inheritance diagram for TYPO3\Flow\Package\PackageManagerInterface:

Public Member Functions
	initialize (\TYPO3\Flow\Core\Bootstrap $bootstrap)
	isPackageAvailable ($packageKey)
	isPackageActive ($packageKey)
	getPackage ($packageKey)
	getPackageOfObject ($object)
	getAvailablePackages ()
	getActivePackages ()
	getFilteredPackages ($packageState='available', $packagePath=NULL, $packageType=NULL)
	getCaseSensitivePackageKey ($unknownCasedPackageKey)
	isPackageKeyValid ($packageKey)
	createPackage ($packageKey, \TYPO3\Flow\Package\MetaData $packageMetaData=NULL, $packagesPath=NULL, $packageType=NULL)
	deactivatePackage ($packageKey)
	activatePackage ($packageKey)
	freezePackage ($packageKey)
	isPackageFrozen ($packageKey)
	unfreezePackage ($packageKey)
	refreezePackage ($packageKey)
	registerPackage (PackageInterface $package, $sortAndSave=TRUE)
	unregisterPackage (PackageInterface $package)
	deletePackage ($packageKey)

Detailed Description

Interface for the TYPO3 Package Manager

Definition at line 19 of file PackageManagerInterface.php.

Member Function Documentation

activatePackage()

TYPO3\Flow\Package\PackageManagerInterface::activatePackage

(

$packageKey

)

Activates a package

Parameters

string

$packageKey

The package to activate

Returns

void

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

createPackage()

TYPO3\Flow\Package\PackageManagerInterface::createPackage	(		$packageKey,
		\TYPO3\Flow\Package\MetaData	$packageMetaData = NULL,
			$packagesPath = NULL,
			$packageType = NULL
	)

Create a new package, given the package key

Parameters

string	$packageKey	The package key to use for the new package
\TYPO3\Flow\Package\MetaData	$packageMetaData	Package metadata
string	$packagesPath	If specified, the package will be created in this path
string	$packageType	If specified, the package type will be set

Returns

The newly created package

Implemented in TYPO3\Flow\Package\PackageManager.

deactivatePackage()

TYPO3\Flow\Package\PackageManagerInterface::deactivatePackage

(

$packageKey

)

Deactivates a package if it is in the list of active packages

Parameters

string

$packageKey

The package to deactivate

Returns

void

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

deletePackage()

TYPO3\Flow\Package\PackageManagerInterface::deletePackage

(

$packageKey

)

Removes a package from registry and deletes it from filesystem

Parameters

string

$packageKey

package to delete

Returns

void

Implemented in TYPO3\Flow\Package\PackageManager, and TYPO3\CMS\Core\Package\PackageManager.

freezePackage()

TYPO3\Flow\Package\PackageManagerInterface::freezePackage

(

$packageKey

)

Freezes a package

Parameters

string

$packageKey

The package to freeze

Returns

void

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

getActivePackages()

TYPO3\Flow\Package\PackageManagerInterface::getActivePackages

(

)

Returns an array of objects of all active packages. A package is active, if it is available and has been activated in the package manager settings.

Returns

array Array of

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

getAvailablePackages()

TYPO3\Flow\Package\PackageManagerInterface::getAvailablePackages

(

)

Returns an array of objects of all available packages. A package is available, if the package directory contains valid meta information.

Returns

array Array of

Implemented in TYPO3\Flow\Package\PackageManager.

getCaseSensitivePackageKey()

TYPO3\Flow\Package\PackageManagerInterface::getCaseSensitivePackageKey

(

$unknownCasedPackageKey

)

Returns the upper camel cased version of the given package key or FALSE if no such package is available.

Parameters

string

$unknownCasedPackageKey

The package key to convert

Returns

mixed The upper camel cased package key or FALSE if no such package exists

Implemented in TYPO3\Flow\Package\PackageManager.

getFilteredPackages()

TYPO3\Flow\Package\PackageManagerInterface::getFilteredPackages	(		$packageState = 'available',
			$packagePath = NULL,
			$packageType = NULL
	)

Returns an array of objects of all packages that match the given package state, path, and type filters. All three filters must match, if given.

Parameters

string	$packageState	defaults to available
string	$packagePath
string	$packageType

Returns

array Array of

Implemented in TYPO3\Flow\Package\PackageManager.

getPackage()

TYPO3\Flow\Package\PackageManagerInterface::getPackage

(

$packageKey

)

Returns a object for the specified package. A package is available, if the package directory contains valid meta information.

Parameters

string

$packageKey

Returns

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

getPackageOfObject()

TYPO3\Flow\Package\PackageManagerInterface::getPackageOfObject

(

$object

)

Finds a package by a given object of that package; if no such package could be found, NULL is returned.

Parameters

object

$object

The object to find the possessing package of

Returns

The package the given object belongs to or NULL if it could not be found

Implemented in TYPO3\Flow\Package\PackageManager.

initialize()

TYPO3\Flow\Package\PackageManagerInterface::initialize

(

\TYPO3\Flow\Core\Bootstrap

$bootstrap

)

Initializes the package manager

Parameters

\TYPO3\Flow\Core\Bootstrap

$bootstrap

The current bootstrap

Returns

void

Implemented in TYPO3\Flow\Package\PackageManager.

isPackageActive()

TYPO3\Flow\Package\PackageManagerInterface::isPackageActive

(

$packageKey

)

Returns TRUE if a package is activated or FALSE if it's not.

Parameters

string

$packageKey

The key of the package to check

Returns

boolean TRUE if package is active, otherwise FALSE

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

isPackageAvailable()

TYPO3\Flow\Package\PackageManagerInterface::isPackageAvailable

(

$packageKey

)

Returns TRUE if a package is available (the package's files exist in the packages directory) or FALSE if it's not. If a package is available it doesn't mean necessarily that it's active!

Parameters

string

$packageKey

The key of the package to check

Returns

boolean TRUE if the package is available, otherwise FALSE

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

isPackageFrozen()

TYPO3\Flow\Package\PackageManagerInterface::isPackageFrozen

(

$packageKey

)

Tells if a package is frozen

Parameters

string

$packageKey

The package to check

Returns

boolean

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

isPackageKeyValid()

TYPO3\Flow\Package\PackageManagerInterface::isPackageKeyValid

(

$packageKey

)

Check the conformance of the given package key

Parameters

string

$packageKey

The package key to validate

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

refreezePackage()

TYPO3\Flow\Package\PackageManagerInterface::refreezePackage

(

$packageKey

)

Refreezes a package

Parameters

string

$packageKey

The package to refreeze

Returns

void

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

registerPackage()

TYPO3\Flow\Package\PackageManagerInterface::registerPackage	(	PackageInterface	$package,
			$sortAndSave = TRUE
	)

Register a native Flow package

Parameters

PackageInterface	$packageKey	The Package to be registered
boolean	$sortAndSave	allows for not saving packagestates when used in loops etc.

Returns

PackageInterface

Exceptions

Exception

Implemented in TYPO3\Flow\Package\PackageManager.

unfreezePackage()

TYPO3\Flow\Package\PackageManagerInterface::unfreezePackage

(

$packageKey

)

Unfreezes a package

Parameters

string

$packageKey

The package to unfreeze

Returns

void

Implemented in TYPO3\CMS\Core\Package\PackageManager, and TYPO3\Flow\Package\PackageManager.

unregisterPackage()

TYPO3\Flow\Package\PackageManagerInterface::unregisterPackage

(

PackageInterface

$package

)

Unregisters a package from the list of available packages

Parameters

PackageInterface

$package

The package to be unregistered

Exceptions

Exception

Implemented in TYPO3\Flow\Package\PackageManager.