phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\DescriptorProjectDescriptor

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

Summary

Methods
Properties
Constants
getName()
setDescription()
getDescription()
getPackage()
getNamespace()
__construct()
getFiles()
getIndexes()
setSettings()
getSettings()
setPartials()
getPartials()
getVersions()
No public properties found
No constants found
No protected methods found
$name
$description
$package
$namespace
N/A
getApiDocumentationSet()
$settings
$partials
$versions
N/A

Properties

$name

$name : string

Type

string

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$package

$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\PackageInterface|string — The package with which this element is associated

$namespace

$namespace : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string — The namespace for this element

$settings

$settings : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

Type

\phpDocumentor\Descriptor\ProjectDescriptor\Settings

$partials

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

Type

\phpDocumentor\Descriptor\Collection —

$versions

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

Type

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

Methods

getName()

getName() : string

Returns the name for this element.

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

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

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

__construct()

__construct(string  $name) : mixed

Initializes this descriptor.

Parameters

string $name

Returns

mixed —

getFiles()

getFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Returns all files with their sub-elements.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Returns all indexes in this project.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

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 —

getVersions()

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

Returns

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

getApiDocumentationSet()

getApiDocumentationSet() : \phpDocumentor\Descriptor\ApiSetDescriptor

Retrieves the first API Documentation set from the first version.

Returns

\phpDocumentor\Descriptor\ApiSetDescriptor —