TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | List of all members
TYPO3\Flow\Package\PackageInterface Interface Reference
Inheritance diagram for TYPO3\Flow\Package\PackageInterface:
TYPO3\CMS\Core\Package\PackageInterface TYPO3\Flow\Package\Package TYPO3\CMS\Core\Package\Package TYPO3\CMS\Core\Package\Package

Public Member Functions

 boot (\TYPO3\Flow\Core\Bootstrap $bootstrap)
 
 getPackageMetaData ()
 
 getClassFiles ()
 
 getPackageKey ()
 
 getNamespace ()
 
 isProtected ()
 
 isObjectManagementEnabled ()
 
 setProtected ($protected)
 
 getPackagePath ()
 
 getClassesPath ()
 
 getClassesNamespaceEntryPath ()
 
 getResourcesPath ()
 
 getConfigurationPath ()
 
 getMetaPath ()
 
 getDocumentationPath ()
 
 getPackageDocumentations ()
 

Public Attributes

const PATTERN_MATCH_PACKAGEKEY = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'
 
const DIRECTORY_CLASSES = 'Classes/'
 
const DIRECTORY_CONFIGURATION = 'Configuration/'
 
const DIRECTORY_DOCUMENTATION = 'Documentation/'
 
const DIRECTORY_METADATA = 'Meta/'
 
const DIRECTORY_TESTS_FUNCTIONAL = 'Tests/Functional/'
 
const DIRECTORY_TESTS_UNIT = 'Tests/Unit/'
 
const DIRECTORY_RESOURCES = 'Resources/'
 

Detailed Description

Interface for a Flow Package class

Definition at line 19 of file PackageInterface.php.

Member Function Documentation

◆ boot()

TYPO3\Flow\Package\PackageInterface::boot ( \TYPO3\Flow\Core\Bootstrap  $bootstrap)

Invokes custom PHP code directly after the package manager has been initialized.

Parameters
\TYPO3\Flow\Core\Bootstrap$bootstrapThe current bootstrap
Returns
void

Implemented in TYPO3\Flow\Package\Package.

◆ getClassesNamespaceEntryPath()

TYPO3\Flow\Package\PackageInterface::getClassesNamespaceEntryPath ( )

Returns the full path to the package's classes namespace entry path, e.g. "My.Package/ClassesPath/My/Package/"

Returns
string Path to this package's Classes directory

Implemented in TYPO3\Flow\Package\Package.

◆ getClassesPath()

TYPO3\Flow\Package\PackageInterface::getClassesPath ( )

Returns the full path to this package's Classes directory

Returns
string Path to this package's Classes directory

Implemented in TYPO3\Flow\Package\Package.

Referenced by TYPO3\CMS\Core\Core\ClassLoader\buildPackageClassPathsForLegacyExtension(), and TYPO3\Flow\Package\PackageManager\registerPackage().

◆ getClassFiles()

TYPO3\Flow\Package\PackageInterface::getClassFiles ( )

Returns the array of filenames of the class files

Returns
array An array of class names (key) and their filename, including the relative path to the package's directory

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

◆ getConfigurationPath()

TYPO3\Flow\Package\PackageInterface::getConfigurationPath ( )

Returns the full path to this package's Configuration directory

Returns
string Path to this package's Configuration directory

Implemented in TYPO3\Flow\Package\Package.

◆ getDocumentationPath()

TYPO3\Flow\Package\PackageInterface::getDocumentationPath ( )

Returns the full path to the package's documentation directory

Returns
string Full path to the package's documentation directory

Implemented in TYPO3\Flow\Package\Package.

◆ getMetaPath()

TYPO3\Flow\Package\PackageInterface::getMetaPath ( )

Returns the full path to this package's Package.xml file

Returns
string Path to this package's Package.xml file

Implemented in TYPO3\Flow\Package\Package.

◆ getNamespace()

TYPO3\Flow\Package\PackageInterface::getNamespace ( )

Returns the PHP namespace of classes in this package.

Returns
string

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

◆ getPackageDocumentations()

TYPO3\Flow\Package\PackageInterface::getPackageDocumentations ( )

Returns the available documentations for this package

Returns
array Array of

Implemented in TYPO3\Flow\Package\Package.

◆ getPackageKey()

TYPO3\Flow\Package\PackageInterface::getPackageKey ( )

Returns the package key of this package.

Returns
string

Implemented in TYPO3\Flow\Package\Package.

Referenced by TYPO3\CMS\Core\Core\ClassLoader\buildPackageClassPathsForLegacyExtension(), TYPO3\Flow\Package\PackageManager\registerPackage(), and TYPO3\Flow\Package\PackageManager\unregisterPackage().

◆ getPackageMetaData()

TYPO3\Flow\Package\PackageInterface::getPackageMetaData ( )

Returns the package meta object of this package.

Returns

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

◆ getPackagePath()

TYPO3\Flow\Package\PackageInterface::getPackagePath ( )

Returns the full path to this package's main directory

Returns
string Path to this package's main directory

Implemented in TYPO3\Flow\Package\Package.

Referenced by TYPO3\CMS\Extensionmanager\Utility\ListUtility\getInstallTypeForPackage(), TYPO3\Flow\Package\PackageManager\getPackageOfObject(), and TYPO3\Flow\Package\PackageManager\registerPackage().

◆ getResourcesPath()

TYPO3\Flow\Package\PackageInterface::getResourcesPath ( )

Returns the full path to this package's Resources directory

Returns
string Path to this package's Resources directory

Implemented in TYPO3\Flow\Package\Package.

◆ isObjectManagementEnabled()

TYPO3\Flow\Package\PackageInterface::isObjectManagementEnabled ( )

Tells if files in the Classes directory should be registered and object management enabled for this package.

Returns
boolean

Implemented in TYPO3\Flow\Package\Package.

◆ isProtected()

TYPO3\Flow\Package\PackageInterface::isProtected ( )

Tells if this package is protected and therefore cannot be deactivated or deleted

Returns
boolean

Implemented in TYPO3\Flow\Package\Package.

◆ setProtected()

TYPO3\Flow\Package\PackageInterface::setProtected (   $protected)

Sets the protection flag of the package

Parameters
boolean$protectedTRUE if the package should be protected, otherwise FALSE
Returns
void

Implemented in TYPO3\Flow\Package\Package.

Member Data Documentation

◆ DIRECTORY_CLASSES

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_CLASSES = 'Classes/'

Definition at line 23 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\activatePackage(), TYPO3\Flow\Package\PackageManager\createPackage(), TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders(), TYPO3\CMS\Core\Package\PackageManager\scanAvailablePackages(), and TYPO3\Flow\Package\PackageManager\scanAvailablePackages().

◆ DIRECTORY_CONFIGURATION

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_CONFIGURATION = 'Configuration/'

Definition at line 24 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders().

◆ DIRECTORY_DOCUMENTATION

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_DOCUMENTATION = 'Documentation/'

Definition at line 25 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders().

◆ DIRECTORY_METADATA

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_METADATA = 'Meta/'

Definition at line 26 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\deletePackageRemovesPackageFromAvailableAndActivePackagesAndDeletesThePackageDirectory().

◆ DIRECTORY_RESOURCES

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_RESOURCES = 'Resources/'

Definition at line 29 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders().

◆ DIRECTORY_TESTS_FUNCTIONAL

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_TESTS_FUNCTIONAL = 'Tests/Functional/'

Definition at line 27 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders().

◆ DIRECTORY_TESTS_UNIT

const TYPO3\Flow\Package\PackageInterface::DIRECTORY_TESTS_UNIT = 'Tests/Unit/'

Definition at line 28 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\createPackage(), and TYPO3\CMS\Core\Tests\Unit\Package\PackageManagerTest\createPackageCreatesCommonFolders().

◆ PATTERN_MATCH_PACKAGEKEY

const TYPO3\Flow\Package\PackageInterface::PATTERN_MATCH_PACKAGEKEY = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'

Definition at line 21 of file PackageInterface.php.

Referenced by TYPO3\Flow\Package\PackageManager\isPackageKeyValid().