phpDocumentor

ProjectDescriptor
in package
implements ProjectInterface, Descriptor

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

Interfaces, Classes and Traits

ProjectInterface
Describes the public interface for the description of a project.
Descriptor
Base class for descriptors containing the most used options.

Table of Contents

$description  : DescriptionDescriptor
$files  : Collection<string|int, FileDescriptor>
$indexes  : Collection<string|int, Collection<string|int, DescriptorAbstract>>
$name  : string
$namespace  : NamespaceDescriptor
$package  : PackageDescriptor
$partials  : Collection<string|int, string>
$settings  : Settings
$versions  : Collection<string|int, VersionDescriptor>
__construct()  : mixed
Initializes this descriptor.
findElement()  : Descriptor|null
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getFiles()  : Collection<string|int, FileDescriptor>
Returns all files with their sub-elements.
getIndexes()  : Collection<string|int, Collection<string|int, DescriptorAbstract>>
Returns all indexes in this project.
getName()  : string
Returns the name of this project.
getNamespace()  : NamespaceDescriptor
Returns the root (global) namespace.
getPackage()  : PackageDescriptor
getPartials()  : Collection<string|int, string>
Returns a list of all partials.
getSettings()  : Settings
Returns the settings used to build the documentation for this project.
getVersions()  : Collection<string|int, VersionDescriptor>
setFiles()  : void
Sets all files on this project.
setIndexes()  : void
Sets all indexes for this project.
setName()  : void
Sets the name for this project.
setNamespace()  : void
Sets the root namespace for this project together with all sub-namespaces.
setPartials()  : void
Sets all partials that can be used in a template.
setSettings()  : void
Sets the settings used to build the documentation for this project.
setPackage()  : void

Properties

Methods

__construct()

Initializes this descriptor.

public __construct(string $name) : mixed
Parameters
$name : string
Return values
mixed

getName()

Returns the name of this project.

public getName() : string
Return values
string

getPartials()

Returns a list of all partials.

public getPartials() : Collection<string|int, string>
Tags
see
setPartials()

for more information on partials.

Return values
Collection<string|int, string>

setIndexes()

Sets all indexes for this project.

public setIndexes(Collection<string|int, Collection<string|int, 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 : Collection<string|int, Collection<string|int, DescriptorAbstract>>
Return values
void

setName()

Sets the name for this project.

public setName(string $name) : void
Parameters
$name : string
Return values
void

setPartials()

Sets all partials that can be used in a template.

public setPartials(Collection<string|int, string> $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 : Collection<string|int, string>
Return values
void

setSettings()

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

public setSettings(Settings $settings) : void
Parameters
$settings : Settings
Return values
void

Search results