MetaData
The default TYPO3 Package MetaData implementation
Table of Contents
Constants
- CONSTRAINT_TYPE_CONFLICTS = 'conflicts'
- CONSTRAINT_TYPE_DEPENDS = 'depends'
- CONSTRAINT_TYPE_SUGGESTS = 'suggests'
Properties
- $CONSTRAINT_TYPES : array<string|int, mixed>
- $constraints : array<string|int, mixed>
- constraints by constraint type (depends, conflicts, suggests)
- $description : string|null
- Package description
- $packageKey : string
- $packageType : string|null
- Package type
- $title : string|null
- Package title
- $version : string
- The version number
Methods
- __construct() : mixed
- Package metadata constructor
- addConstraint() : mixed
- Add a constraint
- getConstraints() : array<string|int, mixed>
- Get all constraints
- getConstraintsByType() : array<string|int, mixed>
- Get the constraints by type
- getConstraintTypes() : array<string|int, mixed>
- Get all available constraint types
- getDescription() : string|null
- getPackageKey() : string
- getPackageType() : string
- Get package type
- getTitle() : string|null
- getVersion() : string
- isExtensionType() : bool
- isFrameworkType() : bool
- setDescription() : mixed
- setPackageType() : mixed
- Set package type
- setTitle() : void
- setVersion() : mixed
Constants
CONSTRAINT_TYPE_CONFLICTS
    public
        mixed
    CONSTRAINT_TYPE_CONFLICTS
    = 'conflicts'
    
    
    
    
CONSTRAINT_TYPE_DEPENDS
    public
        mixed
    CONSTRAINT_TYPE_DEPENDS
    = 'depends'
    
    
    
    
CONSTRAINT_TYPE_SUGGESTS
    public
        mixed
    CONSTRAINT_TYPE_SUGGESTS
    = 'suggests'
    
    
    
    
Properties
$CONSTRAINT_TYPES
        protected
        static    array<string|int, mixed>
    $CONSTRAINT_TYPES
     = [self::CONSTRAINT_TYPE_DEPENDS, self::CONSTRAINT_TYPE_CONFLICTS, self::CONSTRAINT_TYPE_SUGGESTS]
    
    
    
    
    
$constraints
constraints by constraint type (depends, conflicts, suggests)
        protected
            array<string|int, mixed>
    $constraints
     = []
    
    
    
    
    
$description
Package description
        protected
            string|null
    $description
    
    
    
    
    
    
$packageKey
        protected
            string
    $packageKey
    
    
    
    
    
    
$packageType
Package type
        protected
            string|null
    $packageType
    
    
    
    
    
    
$title
Package title
        protected
            string|null
    $title
    
    
    
    
    
    
$version
The version number
        protected
            string
    $version
    
    
    
    
    
    
Methods
__construct()
Package metadata constructor
    public
                    __construct(string $packageKey) : mixed
    Parameters
- $packageKey : string
- 
                    The package key 
addConstraint()
Add a constraint
    public
                    addConstraint(PackageConstraint $constraint) : mixed
    Parameters
- $constraint : PackageConstraint
- 
                    The constraint to add 
getConstraints()
Get all constraints
    public
                    getConstraints() : array<string|int, mixed>
    Return values
array<string|int, mixed> —Package constraints
getConstraintsByType()
Get the constraints by type
    public
                    getConstraintsByType(string $constraintType) : array<string|int, mixed>
    Parameters
- $constraintType : string
- 
                    Type of the constraints to get: CONSTRAINT_TYPE_* 
Return values
array<string|int, mixed> —Package constraints
getConstraintTypes()
Get all available constraint types
    public
                    getConstraintTypes() : array<string|int, mixed>
    Return values
array<string|int, mixed> —All constraint types
getDescription()
    public
                    getDescription() : string|null
    Return values
string|null —The package description
getPackageKey()
    public
                    getPackageKey() : string
    Return values
string —The package key
getPackageType()
Get package type
    public
                    getPackageType() : string
    Return values
stringgetTitle()
    public
                    getTitle() : string|null
    Return values
string|nullgetVersion()
    public
                    getVersion() : string
    Return values
string —The package version
isExtensionType()
    public
                    isExtensionType() : bool
    Return values
boolisFrameworkType()
    public
                    isFrameworkType() : bool
    Return values
boolsetDescription()
    public
                    setDescription(string|null $description) : mixed
    Parameters
- $description : string|null
- 
                    The package description to set 
setPackageType()
Set package type
    public
                    setPackageType(string|null $packageType) : mixed
    Parameters
- $packageType : string|null
setTitle()
    public
                    setTitle(string|null $title) : void
    Parameters
- $title : string|null
setVersion()
    public
                    setVersion(string $version) : mixed
    Parameters
- $version : string
- 
                    The package version to set