TYPO3\Flow\Package\MetaData Class Reference

Inheritance diagram for TYPO3\Flow\Package\MetaData:

Public Member Functions
	getConstraintTypes ()
	__construct ($packageKey)
	getPackageKey ()
	getPackageType ()
	setPackageType ($packageType)
	getVersion ()
	setVersion ($version)
	getDescription ()
	setDescription ($description)
	getCategories ()
	addCategory ($category)
	getParties ()
	addParty (\TYPO3\Flow\Package\MetaData\AbstractParty $party)
	getConstraints ()
	getConstraintsByType ($constraintType)
	addConstraint (\TYPO3\Flow\Package\MetaData\AbstractConstraint $constraint)

Protected Attributes
	$packageKey
	$packageType
	$version
	$title
	$description
	$categories = array()
	$parties = array()
	$constraints = array()

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

Additional Inherited Members
Public Attributes inherited from TYPO3\Flow\Package\MetaDataInterface
const	CONSTRAINT_TYPE_DEPENDS = 'depends'
const	CONSTRAINT_TYPE_CONFLICTS = 'conflicts'
const	CONSTRAINT_TYPE_SUGGESTS = 'suggests'
const	PARTY_TYPE_PERSON = 'person'
const	PARTY_TYPE_COMPANY = 'company'
const	CONSTRAINT_SCOPE_PACKAGE = 'package'
const	CONSTRAINT_SCOPE_SYSTEM = 'system'

Detailed Description

The default TYPO3 Package MetaData implementation

Definition at line 18 of file MetaData.php.

Constructor & Destructor Documentation

__construct()

TYPO3\Flow\Package\MetaData::__construct

(

$packageKey

)

Package metadata constructor

Parameters

string

$packageKey

The package key

Definition at line 87 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$packageKey.

Member Function Documentation

addCategory()

TYPO3\Flow\Package\MetaData::addCategory

(

$category

)

Adds a package category

Parameters

string

$category

Returns

void

Definition at line 159 of file MetaData.php.

addConstraint()

TYPO3\Flow\Package\MetaData::addConstraint

(

\TYPO3\Flow\Package\MetaData\AbstractConstraint

$constraint

)

Add a constraint

Parameters

\TYPO3\Flow\Package\MetaData\AbstractConstraint

$constraint

The constraint to add

Returns

void

Definition at line 208 of file MetaData.php.

addParty()

TYPO3\Flow\Package\MetaData::addParty

(

\TYPO3\Flow\Package\MetaData\AbstractParty

$party

)

Add a party

Parameters

\TYPO3\Flow\Package\MetaData\AbstractParty

$party

Returns

void

Definition at line 176 of file MetaData.php.

getCategories()

TYPO3\Flow\Package\MetaData::getCategories

(

)

Returns

Array of string The package categories

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 149 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$categories.

getConstraints()

TYPO3\Flow\Package\MetaData::getConstraints

(

)

Get all constraints

Returns

array Package constraints

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 185 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$constraints.

getConstraintsByType()

TYPO3\Flow\Package\MetaData::getConstraintsByType

(

$constraintType

)

Get the constraints by type

Parameters

string

$constraintType

Type of the constraints to get: CONSTRAINT_TYPE_*

Returns

array Package constraints

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 195 of file MetaData.php.

getConstraintTypes()

TYPO3\Flow\Package\MetaData::getConstraintTypes

(

)

Get all available constraint types

Returns

array All constraint types

Definition at line 78 of file MetaData.php.

getDescription()

TYPO3\Flow\Package\MetaData::getDescription

(

)

Returns

string The package description

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 134 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$description.

getPackageKey()

TYPO3\Flow\Package\MetaData::getPackageKey

(

)

Returns

string The package key

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 94 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$packageKey.

getPackageType()

TYPO3\Flow\Package\MetaData::getPackageType

(

)

Get package type

Returns

string

Definition at line 103 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$packageType.

getParties()

TYPO3\Flow\Package\MetaData::getParties

(

)

Returns

Array of TYPO3 The package parties

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 166 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$parties.

getVersion()

TYPO3\Flow\Package\MetaData::getVersion

(

)

Returns

string The package version

Implements TYPO3\Flow\Package\MetaDataInterface.

Definition at line 119 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$version.

setDescription()

TYPO3\Flow\Package\MetaData::setDescription

(

$description

)

Parameters

string

$description

The package description to set

Returns

void

Definition at line 142 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$description.

setPackageType()

TYPO3\Flow\Package\MetaData::setPackageType

(

$packageType

)

Set package type

Parameters

string

$packageType

Definition at line 112 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$packageType.

setVersion()

TYPO3\Flow\Package\MetaData::setVersion

(

$version

)

Parameters

string

$version

The package version to set

Returns

void

Definition at line 127 of file MetaData.php.

References TYPO3\Flow\Package\MetaData\$version.

Member Data Documentation

$categories

TYPO3\Flow\Package\MetaData::$categories = array()

protected

Definition at line 59 of file MetaData.php.

Referenced by TYPO3\Flow\Package\MetaData\getCategories().

$CONSTRAINT_TYPES

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

staticprotected

Definition at line 23 of file MetaData.php.

$constraints

TYPO3\Flow\Package\MetaData::$constraints = array()

protected

Definition at line 71 of file MetaData.php.

Referenced by TYPO3\Flow\Package\MetaData\getConstraints().

$description

TYPO3\Flow\Package\MetaData::$description

protected

Definition at line 53 of file MetaData.php.

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

$packageKey

TYPO3\Flow\Package\MetaData::$packageKey

protected

Definition at line 28 of file MetaData.php.

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

$packageType

TYPO3\Flow\Package\MetaData::$packageType

protected

Definition at line 35 of file MetaData.php.

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

$parties

TYPO3\Flow\Package\MetaData::$parties = array()

protected

Definition at line 65 of file MetaData.php.

Referenced by TYPO3\Flow\Package\MetaData\getParties().

$title

TYPO3\Flow\Package\MetaData::$title

protected

Definition at line 47 of file MetaData.php.

$version

TYPO3\Flow\Package\MetaData::$version

protected

Definition at line 41 of file MetaData.php.

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