ProjectDescriptor
in package
implements
ProjectInterface, Descriptor
Represents the entire project with its files, namespaces and indexes.
Interfaces, Classes and Traits
- ProjectInterface
- Describes the public interface for the description of a project.
- Descriptor
- Base class for descriptors containing the most used options.
Table of Contents
- $description : DescriptionDescriptor
- $files : Collection<string|int, FileDescriptor>
- $indexes : Collection<string|int, Collection<string|int, DescriptorAbstract>>
- $name : string
- $namespace : NamespaceDescriptor
- $package : PackageDescriptor
- $partials : Collection<string|int, string>
- $settings : Settings
- $versions : Collection<string|int, VersionDescriptor>
- __construct() : mixed
- Initializes this descriptor.
- findElement() : Descriptor|null
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getFiles() : Collection<string|int, FileDescriptor>
- Returns all files with their sub-elements.
- getIndexes() : Collection<string|int, Collection<string|int, DescriptorAbstract>>
- Returns all indexes in this project.
- getName() : string
- Returns the name of this project.
- getNamespace() : NamespaceDescriptor
- Returns the root (global) namespace.
- getPackage() : PackageDescriptor
- 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>
- setFiles() : void
- Sets all files on this project.
- setIndexes() : void
- Sets all indexes for this project.
- setName() : void
- Sets the name for this project.
- setNamespace() : void
- Sets the root namespace for this project together with all sub-namespaces.
- 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.
- setPackage() : void
Properties
$description
private
DescriptionDescriptor
$description
$files
private
Collection<string|int, FileDescriptor>
$files
$indexes
private
Collection<string|int, Collection<string|int, DescriptorAbstract>>
$indexes
$name
private
string
$name
= ''
$namespace
private
NamespaceDescriptor
$namespace
$package
private
PackageDescriptor
$package
$partials
private
Collection<string|int, string>
$partials
$settings
private
Settings
$settings
$versions
private
Collection<string|int, VersionDescriptor>
$versions
Methods
__construct()
Initializes this descriptor.
public
__construct(string $name) : mixed
Parameters
- $name : string
Return values
mixed —findElement()
public
findElement(Fqsen $fqsen) : Descriptor|null
Parameters
- $fqsen : Fqsen
Return values
Descriptor|null —getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
Return values
DescriptionDescriptor —getFiles()
Returns all files with their sub-elements.
public
getFiles() : Collection<string|int, FileDescriptor>
Return values
Collection<string|int, FileDescriptor> —getIndexes()
Returns all indexes in this project.
public
getIndexes() : Collection<string|int, Collection<string|int, DescriptorAbstract>>
Tags
Return values
Collection<string|int, Collection<string|int, DescriptorAbstract>> —getName()
Returns the name of this project.
public
getName() : string
Return values
string —getNamespace()
Returns the root (global) namespace.
public
getNamespace() : NamespaceDescriptor
Return values
NamespaceDescriptor —getPackage()
public
getPackage() : PackageDescriptor
Return values
PackageDescriptor —getPartials()
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
Settings —getVersions()
public
getVersions() : Collection<string|int, VersionDescriptor>
Return values
Collection<string|int, VersionDescriptor> —setFiles()
Sets all files on this project.
public
setFiles(Collection<string|int, FileDescriptor> $files) : void
Parameters
- $files : Collection<string|int, FileDescriptor>
Return values
void —setIndexes()
Sets all indexes for this project.
public
setIndexes(Collection<string|int, Collection<string|int, DescriptorAbstract>> $indexes) : void
An index is a compilation of references to elements, usually constructed in a compiler step, that aids template generation by providing a conveniently assembled list. An example of such an index is the 'marker' index where a list of TODOs and FIXMEs are located in a central location for reporting.
Parameters
- $indexes : Collection<string|int, Collection<string|int, DescriptorAbstract>>
Return values
void —setName()
Sets the name for this project.
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setNamespace()
Sets the root namespace for this project together with all sub-namespaces.
public
setNamespace(NamespaceDescriptor $namespace) : void
Parameters
- $namespace : NamespaceDescriptor
Return values
void —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>
Return values
void —setSettings()
Sets the settings used to build the documentation for this project.
public
setSettings(Settings $settings) : void
Parameters
- $settings : Settings
Return values
void —setPackage()
private
setPackage(PackageDescriptor $package) : void
Parameters
- $package : PackageDescriptor