\phpDocumentor\DescriptorProjectDescriptor

__construct()

__construct(  $name) 

Initializes this descriptor.

Parameters

setName()

setName(string  $name) : void

Sets the name for this project.

Parameters

getName()

getName() : string

Returns the name of this project.

Returns

setFiles()

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

Sets all files on this project.

Parameters

getFiles()

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

Returns all files with their sub-elements.

Returns

setIndexes()

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

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection

Returns all indexes in this project.

Returns

setNamespace()

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

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

Parameters

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor

Returns the root (global) namespace.

Returns

setSettings()

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

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

Parameters

getSettings()

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

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

Returns

setPartials()

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

getPartials()

getPartials() : \phpDocumentor\Descriptor\Collection

Returns a list of all partials.

Returns

isVisibilityAllowed()

isVisibilityAllowed(integer  $visibility) : boolean

Checks whether the Project supports the given visibility.

Parameters

Returns