TYPO3\CMS\Core\Package\MetaData Class Reference

Public Member Functions
array	getConstraintTypes ()
	__construct ($packageKey)
string	getPackageKey ()
	isExtensionType ()
	isFrameworkType ()
string	getPackageType ()
	setPackageType ($packageType)
string	getVersion ()
	setVersion ($version)
	getTitle ()
	setTitle (?string $title)
string null	getDescription ()
	setDescription ($description)
array	getConstraints ()
array	getConstraintsByType ($constraintType)
	addConstraint (PackageConstraint $constraint)

Public Attributes
const	CONSTRAINT_TYPE_DEPENDS = 'depends'
const	CONSTRAINT_TYPE_CONFLICTS = 'conflicts'
const	CONSTRAINT_TYPE_SUGGESTS = 'suggests'

Protected Attributes
string	$packageKey
string null	$packageType
string	$version
string null	$title
string null	$description
array	$constraints = array( )

Static Protected Attributes
static array	$CONSTRAINT_TYPES = array( self::CONSTRAINT_TYPE_DEPENDS, self::CONSTRAINT_TYPE_CONFLICTS, self::CONSTRAINT_TYPE_SUGGESTS )

Private Attributes
const	FRAMEWORK_TYPE = 'typo3-cms-framework'

Detailed Description

The default TYPO3 Package MetaData implementation

Definition at line 23 of file MetaData.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Package\MetaData::__construct

(

$packageKey

)

Package metadata constructor

Parameters

string

$packageKey

‪The package key

Definition at line 79 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$packageKey.

Member Function Documentation

addConstraint()

TYPO3\CMS\Core\Package\MetaData::addConstraint

(

PackageConstraint

$constraint

)

Add a constraint

Parameters

MetaData\PackageConstraint

$constraint

‪The constraint to add

Definition at line 193 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\PackageConstraint\getConstraintType().

getConstraints()

array TYPO3\CMS\Core\Package\MetaData::getConstraints

(

)

Get all constraints

Returns

‪array Package constraints

Definition at line 169 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$constraints.

getConstraintsByType()

array TYPO3\CMS\Core\Package\MetaData::getConstraintsByType

(

$constraintType

)

Get the constraints by type

Parameters

string

$constraintType

‪Type of the constraints to get: CONSTRAINT_TYPE_*

Returns

‪array Package constraints

Definition at line 180 of file MetaData.php.

getConstraintTypes()

array TYPO3\CMS\Core\Package\MetaData::getConstraintTypes

(

)

Get all available constraint types

Returns

‪array All constraint types

Definition at line 69 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$CONSTRAINT_TYPES.

getDescription()

string null TYPO3\CMS\Core\Package\MetaData::getDescription

(

)

Returns

‪string|null The package description

Definition at line 151 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$description.

getPackageKey()

string TYPO3\CMS\Core\Package\MetaData::getPackageKey

(

)

Returns

‪string The package key

Definition at line 87 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$packageKey.

getPackageType()

string TYPO3\CMS\Core\Package\MetaData::getPackageType

(

)

Get package type

Returns

‪string

Definition at line 107 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$packageType.

getTitle()

TYPO3\CMS\Core\Package\MetaData::getTitle

(

)

Definition at line 138 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$title.

getVersion()

string TYPO3\CMS\Core\Package\MetaData::getVersion

(

)

Returns

‪string The package version

Definition at line 125 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$version.

isExtensionType()

TYPO3\CMS\Core\Package\MetaData::isExtensionType

(

)

Definition at line 92 of file MetaData.php.

isFrameworkType()

TYPO3\CMS\Core\Package\MetaData::isFrameworkType

(

)

Definition at line 97 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\FRAMEWORK_TYPE.

setDescription()

TYPO3\CMS\Core\Package\MetaData::setDescription

(

$description

)

Parameters

string | null

$description

‪The package description to set

Definition at line 159 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$description, and TYPO3\CMS\Redirects\Message\description.

setPackageType()

TYPO3\CMS\Core\Package\MetaData::setPackageType

(

$packageType

)

Set package type

Parameters

string | null

$packageType

Definition at line 117 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$packageType.

setTitle()

TYPO3\CMS\Core\Package\MetaData::setTitle

(

?string

$title

)

Definition at line 143 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$title.

setVersion()

TYPO3\CMS\Core\Package\MetaData::setVersion

(

$version

)

Parameters

string

$version

‪The package version to set

Definition at line 133 of file MetaData.php.

References TYPO3\CMS\Core\Package\MetaData\$version.

Member Data Documentation

$CONSTRAINT_TYPES

array TYPO3\CMS\Core\Package\MetaData::$CONSTRAINT_TYPES = array( self::CONSTRAINT_TYPE_DEPENDS, self::CONSTRAINT_TYPE_CONFLICTS, self::CONSTRAINT_TYPE_SUGGESTS )

staticprotected

Definition at line 32 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getConstraintTypes().

$constraints

array TYPO3\CMS\Core\Package\MetaData::$constraints = array( )

protected

constraints by constraint type (depends, conflicts, suggests)

Definition at line 62 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getConstraints().

$description

string null TYPO3\CMS\Core\Package\MetaData::$description

protected

Package description

Definition at line 57 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getDescription(), and TYPO3\CMS\Core\Package\MetaData\setDescription().

$packageKey

string TYPO3\CMS\Core\Package\MetaData::$packageKey

protected

Definition at line 36 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\__construct(), and TYPO3\CMS\Core\Package\MetaData\getPackageKey().

$packageType

string null TYPO3\CMS\Core\Package\MetaData::$packageType

protected

Package type

Definition at line 42 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getPackageType(), and TYPO3\CMS\Core\Package\MetaData\setPackageType().

$title

string null TYPO3\CMS\Core\Package\MetaData::$title

protected

Package title

Definition at line 52 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getTitle(), and TYPO3\CMS\Core\Package\MetaData\setTitle().

$version

string TYPO3\CMS\Core\Package\MetaData::$version

protected

The version number

Definition at line 47 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\getVersion(), and TYPO3\CMS\Core\Package\MetaData\setVersion().

CONSTRAINT_TYPE_CONFLICTS

const TYPO3\CMS\Core\Package\MetaData::CONSTRAINT_TYPE_CONFLICTS = 'conflicts'

Definition at line 26 of file MetaData.php.

CONSTRAINT_TYPE_DEPENDS

const TYPO3\CMS\Core\Package\MetaData::CONSTRAINT_TYPE_DEPENDS = 'depends'

Definition at line 25 of file MetaData.php.

CONSTRAINT_TYPE_SUGGESTS

const TYPO3\CMS\Core\Package\MetaData::CONSTRAINT_TYPE_SUGGESTS = 'suggests'

Definition at line 27 of file MetaData.php.

FRAMEWORK_TYPE

const TYPO3\CMS\Core\Package\MetaData::FRAMEWORK_TYPE = 'typo3-cms-framework'

private

Definition at line 28 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\MetaData\isFrameworkType().