ProjectDescriptor

in package
Implements ProjectInterface, Descriptor

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.
ProjectDescriptor.php

Properties

private$name  : string                

private$namespace  : \phpDocumentor\Descriptor\NamespaceDescriptor                

private$package  : \phpDocumentor\Descriptor\Interfaces\PackageInterface                

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

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

private$settings  : \phpDocumentor\Descriptor\ProjectDescriptor\Settings                

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

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

Methods

Initializes this descriptor.

public__construct(string $name) : mixed

Parameters

$name : string

Returns

mixed —

Sets the name for this project.

publicsetName(string $name) : void

Parameters

$name : string

Returns the name of this project.

publicgetName() : string

Returns

string —

Returns the description for this element.

publicgetDescription() : string

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

Returns

string —

Sets all files on this project.

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

Parameters

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

Returns all files with their sub-elements.

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

Returns

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

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

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

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>> —
see
setIndexes()

for more information on what indexes are.

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

publicsetNamespace(NamespaceDescriptor $namespace) : void

Parameters

$namespace : NamespaceDescriptor

Returns the root (global) namespace.

publicgetNamespace() : NamespaceDescriptor

Returns

NamespaceDescriptor —

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

publicsetSettings(Settings $settings) : void

Parameters

$settings : Settings

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

publicgetSettings() : Settings

Returns

Settings —

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

$partials : \phpDocumentor\Descriptor\Collection

Returns a list of all partials.

publicgetPartials() : \phpDocumentor\Descriptor\Collection

Returns

\phpDocumentor\Descriptor\Collection —
see
setPartials()

for more information on partials.

Checks whether the Project supports the given visibility.

publicisVisibilityAllowed(int $visibility) : bool

Parameters

$visibility : int

One of the VISIBILITY_* constants of the Settings class.

Returns

bool —
see
Settings

for a list of the available VISIBILITY_* constants.

publicfindElement(Fqsen $fqsen) : Descriptor|null

Parameters

$fqsen : Fqsen

Returns

Descriptor|null —

Returns

PackageInterface — 

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

Returns

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

privatesetPackage(PackageInterface $package) : void

Parameters

$package : PackageInterface