ProjectDescriptor

Implements \phpDocumentor\Descriptor\Interfaces\ProjectInterface

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

package

Default

Methods

Initializes this descriptor.

__construct( $name) 

Arguments

$name

Returns all files with their sub-elements.

getFiles() : \phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\FileDescriptor>

Returns all indexes in this project.

getIndexes() : \phpDocumentor\Descriptor\Collection

Returns the name of this project.

getName() : string

Response

string

Returns the root (global) namespace.

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor

Returns a list of all partials.

getPartials() : \phpDocumentor\Descriptor\Collection

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

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

Checks whether the Project supports the given visibility.

isVisibilityAllowed(integer $visibility) : boolean
see \phpDocumentor\Descriptor\Settings

for a list of the available VISIBILITY_* constants.

Arguments

$visibility

integer

One of the VISIBILITY_* constants of the Settings class.

Response

boolean

Sets all files on this project.

setFiles(\phpDocumentor\Descriptor\Collection $files) : void

Sets all indexes for this project.

setIndexes(\phpDocumentor\Descriptor\Collection $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.

Arguments

Sets the name for this project.

setName(string $name) : void

Arguments

$name

string

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

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

Sets all partials that can be used in a template.

setPartials(\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.

Arguments

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

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

Properties

name

name : string
var

Type(s)

string

namespace

namespace : \phpDocumentor\Descriptor\NamespaceDescriptor

files

files : \phpDocumentor\Descriptor\Collection

indexes

indexes : \phpDocumentor\Descriptor\Collection

settings

settings : \phpDocumentor\Descriptor\ProjectDescriptor\Settings

partials

partials : \phpDocumentor\Descriptor\Collection