ProjectDescriptor
Represents the entire project with its files, namespaces and indexes.
Interfaces, Classes & Used Traits
- ProjectInterface
- Describes the public interface for the description of a project.
- Descriptor
- Base class for descriptors containing the most used options.
Properties
$name Line 26
private$name : string
$namespace Line 29
private$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor
$package Line 32
private$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface
$files Line 35
private$files : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor>
$indexes Line 38
private$indexes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>
$settings Line 41
private$settings : \phpDocumentor\Descriptor\ProjectDescriptor\Settings
$partials Line 44
private$partials : \phpDocumentor\Descriptor\Collection<string>
$versions Line 47
private$versions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
Methods
Parameters
Returns
mixed —Parameters
Returns
string —This method will automatically attempt to inherit the parent's description if this one has none.
Returns
string —
setFiles() Line 103
Sets all files on this project.
publicsetFiles(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor> $files) : void
Parameters
getFiles() Line 113
Returns all files with their sub-elements.
publicgetFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor> —
setIndexes() Line 127
Sets all indexes for this project.
publicsetIndexes(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\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
getIndexes() Line 139
Returns all indexes in this project.
publicgetIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>> —
setNamespace() Line 147
Sets the root namespace for this project together with all sub-namespaces.
publicsetNamespace(NamespaceDescriptor $namespace) : void
getNamespace() Line 155
Returns the root (global) namespace.
publicgetNamespace() : NamespaceDescriptor
setSettings() Line 163
Sets the settings used to build the documentation for this project.
publicsetSettings(Settings $settings) : void
getSettings() Line 171
Returns the settings used to build the documentation for this project.
publicgetSettings() : Settings
setPartials() Line 184
Sets all partials that can be used in a template.
publicsetPartials(\phpDocumentor\Descriptor\Collection$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
getPartials() Line 196
Returns a list of all partials.
publicgetPartials() : \phpDocumentor\Descriptor\Collection
Returns
\phpDocumentor\Descriptor\Collection
isVisibilityAllowed() Line 208
Checks whether the Project supports the given visibility.
publicisVisibilityAllowed(int $visibility) : bool
Parameters
One of the VISIBILITY_* constants of the Settings class.