ProjectDescriptor
in package
implements
ProjectInterface, Descriptor
uses
HasName, HasDescription
Represents the entire project with its files, namespaces and indexes.
Table of Contents
Interfaces
- ProjectInterface
- Describes the public interface for the description of a project.
- Descriptor
- Base class for descriptors containing the most used options.
Properties
- $description : DescriptionDescriptor|null
- $name : string
- $partials : Collection<string|int, string>
- $settings : Settings
- $versions : Collection<string|int, VersionDescriptor>
Methods
- __construct() : mixed
- Initializes this descriptor.
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getFiles() : Collection<string|int, FileInterface>
- Returns all files with their sub-elements.
- getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
- Returns all indexes in this project.
- getName() : string
- Returns the name for this element.
- getNamespace() : NamespaceInterface|string
- Returns the namespace for this element (defaults to global "\")
- getPackage() : PackageInterface|null
- Returns the package for this element (defaults to global "\")
- getPartials() : Collection<string|int, string>
- Returns a list of all partials.
- getSettings() : Settings
- Returns the settings used to build the documentation for this project.
- getVersions() : Collection<string|int, VersionDescriptor>
- setDescription() : void
- Sets a description or none to inherit from a parent.
- setPartials() : void
- Sets all partials that can be used in a template.
- setSettings() : void
- Sets the settings used to build the documentation for this project.
- getApiDocumentationSet() : ApiSetDescriptor
- Retrieves the first API Documentation set from the first version.
Properties
$description
protected
DescriptionDescriptor|null
$description
= null
$name
protected
string
$name
= ''
$partials
private
Collection<string|int, string>
$partials
$settings
private
Settings
$settings
$versions read-only
private
Collection<string|int, VersionDescriptor>
$versions
Methods
__construct()
Initializes this descriptor.
public
__construct(string $name) : mixed
Parameters
- $name : string
getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetFiles()
Returns all files with their sub-elements.
public
getFiles() : Collection<string|int, FileInterface>
Tags
Return values
Collection<string|int, FileInterface>getIndexes()
Returns all indexes in this project.
public
getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
Tags
Return values
Collection<string|int, Collection<string|int, ElementInterface>>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetNamespace()
Returns the namespace for this element (defaults to global "\")
public
getNamespace() : NamespaceInterface|string
Tags
Return values
NamespaceInterface|stringgetPackage()
Returns the package for this element (defaults to global "\")
public
getPackage() : PackageInterface|null
Tags
Return values
PackageInterface|nullgetPartials()
Returns a list of all partials.
public
getPartials() : Collection<string|int, string>
Tags
Return values
Collection<string|int, string>getSettings()
Returns the settings used to build the documentation for this project.
public
getSettings() : Settings
Return values
SettingsgetVersions()
public
getVersions() : Collection<string|int, VersionDescriptor>
Return values
Collection<string|int, VersionDescriptor>setDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
setPartials()
Sets all partials that can be used in a template.
public
setPartials(Collection<string|int, string> $partials) : void
Partials are blocks of text that can be inserted anywhere in a template using a special indicator. An example is the introduction partial that can add a custom piece of text to the homepage.
Parameters
- $partials : Collection<string|int, string>
setSettings()
Sets the settings used to build the documentation for this project.
public
setSettings(Settings $settings) : void
Parameters
- $settings : Settings
getApiDocumentationSet()
Retrieves the first API Documentation set from the first version.
private
getApiDocumentationSet() : ApiSetDescriptor