TYPO3 CMS  TYPO3_7-6
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
TYPO3\CMS\Core\Package\MetaData Class Reference

Public Member Functions

 getConstraintTypes ()
 
 __construct ($packageKey)
 
 getPackageKey ()
 
 getPackageType ()
 
 setPackageType ($packageType)
 
 getVersion ()
 
 setVersion ($version)
 
 getDescription ()
 
 setDescription ($description)
 
 getConstraints ()
 
 getConstraintsByType ($constraintType)
 
 addConstraint (MetaData\PackageConstraint $constraint)
 

Public Attributes

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

Protected Attributes

 $packageKey
 
 $packageType
 
 $version
 
 $title
 
 $description
 
 $constraints = []
 

Static Protected Attributes

static $CONSTRAINT_TYPES = [self::CONSTRAINT_TYPE_DEPENDS, self::CONSTRAINT_TYPE_CONFLICTS, self::CONSTRAINT_TYPE_SUGGESTS]
 

Detailed Description

The default TYPO3 Package MetaData implementation Adapted from FLOW for TYPO3 CMS

Definition at line 21 of file MetaData.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Package\MetaData::__construct (   $packageKey)

Package metadata constructor

Parameters
string$packageKeyThe package key

Definition at line 83 of file MetaData.php.

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

Member Function Documentation

◆ addConstraint()

TYPO3\CMS\Core\Package\MetaData::addConstraint ( MetaData\PackageConstraint  $constraint)

Add a constraint

Parameters
MetaData\PackageConstraint$constraintThe constraint to add
Returns
void

Definition at line 180 of file MetaData.php.

◆ getConstraints()

TYPO3\CMS\Core\Package\MetaData::getConstraints ( )

Get all constraints

Returns
array Package constraints

Definition at line 155 of file MetaData.php.

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

◆ getConstraintsByType()

TYPO3\CMS\Core\Package\MetaData::getConstraintsByType (   $constraintType)

Get the constraints by type

Parameters
string$constraintTypeType of the constraints to get: CONSTRAINT_TYPE_*
Returns
array Package constraints

Definition at line 166 of file MetaData.php.

◆ getConstraintTypes()

TYPO3\CMS\Core\Package\MetaData::getConstraintTypes ( )

Get all available constraint types

Returns
array All constraint types

Definition at line 73 of file MetaData.php.

◆ getDescription()

TYPO3\CMS\Core\Package\MetaData::getDescription ( )
Returns
string The package description

Definition at line 136 of file MetaData.php.

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

◆ getPackageKey()

TYPO3\CMS\Core\Package\MetaData::getPackageKey ( )
Returns
string The package key

Definition at line 91 of file MetaData.php.

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

◆ getPackageType()

TYPO3\CMS\Core\Package\MetaData::getPackageType ( )

Get package type

Returns
string

Definition at line 101 of file MetaData.php.

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

◆ getVersion()

TYPO3\CMS\Core\Package\MetaData::getVersion ( )
Returns
string The package version

Definition at line 119 of file MetaData.php.

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

◆ setDescription()

TYPO3\CMS\Core\Package\MetaData::setDescription (   $description)
Parameters
string$descriptionThe package description to set
Returns
void

Definition at line 145 of file MetaData.php.

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

◆ setPackageType()

TYPO3\CMS\Core\Package\MetaData::setPackageType (   $packageType)

Set package type

Parameters
string$packageType

Definition at line 111 of file MetaData.php.

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

◆ setVersion()

TYPO3\CMS\Core\Package\MetaData::setVersion (   $version)
Parameters
string$versionThe package version to set
Returns
void

Definition at line 128 of file MetaData.php.

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

Member Data Documentation

◆ $CONSTRAINT_TYPES

TYPO3\CMS\Core\Package\MetaData::$CONSTRAINT_TYPES = [self::CONSTRAINT_TYPE_DEPENDS, self::CONSTRAINT_TYPE_CONFLICTS, self::CONSTRAINT_TYPE_SUGGESTS]
staticprotected

Definition at line 30 of file MetaData.php.

◆ $constraints

TYPO3\CMS\Core\Package\MetaData::$constraints = []
protected

Definition at line 66 of file MetaData.php.

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

◆ $description

TYPO3\CMS\Core\Package\MetaData::$description
protected

Definition at line 60 of file MetaData.php.

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

◆ $packageKey

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

Definition at line 35 of file MetaData.php.

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

◆ $packageType

TYPO3\CMS\Core\Package\MetaData::$packageType
protected

Definition at line 42 of file MetaData.php.

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

◆ $title

TYPO3\CMS\Core\Package\MetaData::$title
protected

Definition at line 54 of file MetaData.php.

◆ $version

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

Definition at line 48 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 24 of file MetaData.php.

◆ CONSTRAINT_TYPE_DEPENDS

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

Definition at line 23 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\PackageManager\getDependencyArrayForPackage(), and TYPO3\CMS\Core\Package\Package\getPackageMetaData().

◆ CONSTRAINT_TYPE_SUGGESTS

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

Definition at line 25 of file MetaData.php.

Referenced by TYPO3\CMS\Core\Package\Package\getPackageMetaData(), and TYPO3\CMS\Core\Package\PackageManager\getSuggestionArrayForPackage().