TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
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 (   $packageKey)

Package metadata constructor

Parameters
string$packageKeyThe package key

Definition at line 83 of file MetaData.php.

References MetaData\$packageKey.

Member Function Documentation

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 ( )

Get all constraints

Returns
array Package constraints

Definition at line 155 of file MetaData.php.

References MetaData\$constraints.

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 ( )

Get all available constraint types

Returns
array All constraint types

Definition at line 73 of file MetaData.php.

getDescription ( )
Returns
string The package description

Definition at line 136 of file MetaData.php.

References MetaData\$description.

getPackageKey ( )
Returns
string The package key

Definition at line 91 of file MetaData.php.

References MetaData\$packageKey.

getPackageType ( )

Get package type

Returns
string

Definition at line 101 of file MetaData.php.

References MetaData\$packageType.

getVersion ( )
Returns
string The package version

Definition at line 119 of file MetaData.php.

References MetaData\$version.

setDescription (   $description)
Parameters
string$descriptionThe package description to set
Returns
void

Definition at line 145 of file MetaData.php.

References MetaData\$description.

setPackageType (   $packageType)

Set package type

Parameters
string$packageType

Definition at line 111 of file MetaData.php.

References MetaData\$packageType.

setVersion (   $version)
Parameters
string$versionThe package version to set
Returns
void

Definition at line 128 of file MetaData.php.

References MetaData\$version.

Member Data Documentation

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

Definition at line 30 of file MetaData.php.

$constraints = []
protected

Definition at line 66 of file MetaData.php.

Referenced by MetaData\getConstraints().

$description
protected

Definition at line 60 of file MetaData.php.

Referenced by MetaData\getDescription(), and MetaData\setDescription().

$packageKey
protected

Definition at line 35 of file MetaData.php.

Referenced by MetaData\__construct(), and MetaData\getPackageKey().

$packageType
protected

Definition at line 42 of file MetaData.php.

Referenced by MetaData\getPackageType(), and MetaData\setPackageType().

$title
protected

Definition at line 54 of file MetaData.php.

$version
protected

Definition at line 48 of file MetaData.php.

Referenced by MetaData\getVersion(), and MetaData\setVersion().

const CONSTRAINT_TYPE_CONFLICTS = 'conflicts'

Definition at line 24 of file MetaData.php.

const CONSTRAINT_TYPE_DEPENDS = 'depends'

Definition at line 23 of file MetaData.php.

const CONSTRAINT_TYPE_SUGGESTS = 'suggests'

Definition at line 25 of file MetaData.php.

Referenced by PackageManager\getSuggestionArrayForPackage().