Documentation

ComponentFile
in package

Represents a .horde.yml file as found in a project root dir.

Partly ported from horde/components

  • Component/Helper/Composer
  • Component/Wrapper/HordeYml
  • Component/Wrapper/ComposerJson

The .horde.yml file format is documented here:

Tags
link
https://wiki.horde.org/Doc/Dev/HordeYmlFormat

Table of Contents

$authors  : Authors
$autoload  : Autoload
$dependencies  : DependencyList
Read PEAR-style dependencies
$description  : string
$detailedDescription  : string
$homepage  : string
$mailinglist  : string
$name  : string
$type  : string
$vendor  : string
$version  : Version
__construct()  : mixed
getAuthors()  : Authors
getAutoload()  : Autoload
getDependencies()  : DependencyList
getDescription()  : string
getDetailedDescription()  : string
getHomepage()  : string
getMailingList()  : string
getName()  : string
getType()  : string
getVendor()  : string
getVersion()  : Version

Properties

Methods

__construct()

public __construct(string $name, DependencyList|null $dependencies, Version|null $version, Authors|null $authors, Autoload|null $autoload[, string $type = 'library' ][, string $vendor = 'horde' ][, string $detailedDescription = '' ][, string $description = '' ][, string $homepage = '' ][, string $mailinglist = '' ]) : mixed
Parameters
$name : string
$dependencies : DependencyList|null
$version : Version|null
$authors : Authors|null
$autoload : Autoload|null
$type : string = 'library'
$vendor : string = 'horde'
$detailedDescription : string = ''
$description : string = ''
$homepage : string = ''
$mailinglist : string = ''
Return values
mixed

getDescription()

public getDescription() : string
Return values
string

getDetailedDescription()

public getDetailedDescription() : string
Return values
string

getHomepage()

public getHomepage() : string
Return values
string

getMailingList()

public getMailingList() : string
Return values
string

getName()

public getName() : string
Return values
string

getType()

public getType() : string
Return values
string

getVendor()

public getVendor() : string
Return values
string

Search results