phpDocumentor

ProjectDescriptor
in package
implements ProjectInterface, Descriptor Uses HasName, HasDescription, HasPackage, HasNamespace

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

Table of Contents

Interfaces

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

Properties

$description  : DescriptionDescriptor|null
$name  : string
$namespace  : NamespaceInterface|string
$package  : PackageInterface|string
$files  : Collection<string|int, FileInterface>
$indexes  : Collection<string|int, Collection<string|int, ElementInterface>>
$partials  : Collection<string|int, string>
$settings  : Settings
$versions  : Collection<string|int, VersionDescriptor>

Methods

__construct()  : mixed
Initializes this descriptor.
findElement()  : ElementInterface|null
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getFiles()  : Collection<string|int, FileInterface>
Returns all files with their sub-elements.
getIndexes()  : Collection<string|int, Collection<string|int, ElementInterface>>
Returns all indexes in this project.
getName()  : string
Returns the name for this element.
getNamespace()  : NamespaceInterface|string
Returns the namespace for this element (defaults to global "\")
getPackage()  : PackageInterface|null
Returns the package name for this element.
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>
setDescription()  : void
Sets a description or none to inherit from a parent.
setFiles()  : void
Sets all files on this project.
setIndexes()  : void
Sets all indexes for this project.
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.

Properties

Methods

__construct()

Initializes this descriptor.

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

getName()

Returns the name for this element.

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, ElementInterface>> $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, ElementInterface>>

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>

setSettings()

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

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

        
On this page

Search results