ProjectInterface
Describes the public interface for the description of a project.
Table of Contents
Methods
- getFiles() : Collection<string|int, FileInterface>
- getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
- getName() : string
- getNamespace() : NamespaceInterface|string
- getPackage() : PackageInterface|null
- Returns the package name for this element.
- getSettings() : ProjectSettings
- getVersions() : Collection<string|int, VersionInterface>
- setName() : void
Methods
getFiles()
public
getFiles() : Collection<string|int, FileInterface>
Please use the getFiles method on the DocumentationSet
Return values
Collection<string|int, FileInterface>getIndexes()
public
getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
Please use the getIndexes method on the DocumentationSet
Return values
Collection<string|int, Collection<string|int, ElementInterface>>getName()
public
getName() : string
Return values
stringgetNamespace()
public
getNamespace() : NamespaceInterface|string
Return values
NamespaceInterface|stringgetPackage()
Returns the package name for this element.
public
getPackage() : PackageInterface|null
Return values
PackageInterface|nullgetSettings()
public
getSettings() : ProjectSettings
Return values
ProjectSettingsgetVersions()
public
getVersions() : Collection<string|int, VersionInterface>
Return values
Collection<string|int, VersionInterface>setName()
public
setName(string $name) : void
Parameters
- $name : string