\phpDocumentor\DescriptorProjectDescriptor

Represents the entire project with its files, namespaces and indexes.

Summary

Methods
Properties
Constants
__construct()
setName()
getName()
getDescription()
setFiles()
getFiles()
setIndexes()
getIndexes()
setNamespace()
getNamespace()
setSettings()
getSettings()
setPartials()
getPartials()
findElement()
getPackage()
getVersions()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
setPackage()
$name
$namespace
$package
$files
$indexes
$settings
$partials
$versions
$description
N/A

Properties

$name

$name : string

Type

string

$namespace

$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor

Type

NamespaceDescriptor

$package

$package : \phpDocumentor\Descriptor\PackageDescriptor

Type

PackageDescriptor

$files

$files : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor>

Type

FileDescriptor>

$indexes

$indexes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>

Type

DescriptorAbstract>>

$settings

$settings : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

Type

Settings

$partials

$partials : \phpDocumentor\Descriptor\Collection<string>

Type

Collection

$versions

$versions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Type

VersionDescriptor>

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

DescriptionDescriptor

Methods

__construct()

__construct(string  $name) : mixed

Initializes this descriptor.

Parameters

string $name

Returns

mixed —

setName()

setName(string  $name) : void

Sets the name for this project.

Parameters

string $name

getName()

getName() : string

Returns the name of this project.

Returns

string —

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

setFiles()

setFiles(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor>  $files) : void

Sets all files on this project.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor> $files

getFiles()

getFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor>

Returns all files with their sub-elements.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FileDescriptor> —

setIndexes()

setIndexes(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>  $indexes) : void

Sets all indexes for this project.

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

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>> $indexes

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>

Returns all indexes in this project.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>> —

setNamespace()

setNamespace(\phpDocumentor\Descriptor\NamespaceDescriptor  $namespace) : void

Sets the root namespace for this project together with all sub-namespaces.

Parameters

\phpDocumentor\Descriptor\NamespaceDescriptor $namespace

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor

Returns the root (global) namespace.

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor —

setSettings()

setSettings(\phpDocumentor\Descriptor\ProjectDescriptor\Settings  $settings) : void

Sets the settings used to build the documentation for this project.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor\Settings $settings

getSettings()

getSettings() : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

Returns the settings used to build the documentation for this project.

Returns

\phpDocumentor\Descriptor\ProjectDescriptor\Settings —

setPartials()

setPartials(\phpDocumentor\Descriptor\Collection<string>  $partials) : void

Sets all partials that can be used in a template.

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

\phpDocumentor\Descriptor\Collection $partials

getPartials()

getPartials() : \phpDocumentor\Descriptor\Collection<string>

Returns a list of all partials.

Returns

\phpDocumentor\Descriptor\Collection

findElement()

findElement(\phpDocumentor\Reflection\Fqsen  $fqsen) : ?\phpDocumentor\Descriptor\Descriptor

Parameters

\phpDocumentor\Reflection\Fqsen $fqsen

Returns

?\phpDocumentor\Descriptor\Descriptor —

getPackage()

getPackage() : \phpDocumentor\Descriptor\PackageDescriptor

Returns

\phpDocumentor\Descriptor\PackageDescriptor —

getVersions()

getVersions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

setPackage()

setPackage(\phpDocumentor\Descriptor\PackageDescriptor  $package) : void

Parameters

\phpDocumentor\Descriptor\PackageDescriptor $package