phpDocumentor

ProjectDescriptorBuilder
in package

Builds a Project Descriptor and underlying tree.

Table of Contents

DEFAULT_PROJECT_NAME  = 'Untitled project'
$assemblerFactory  : AssemblerFactory
$filter  : Filter
$project  : ProjectDescriptor
$defaultPackage  : string
$ignoredTags  : array<string|int, string>
$servicesWithCustomSettings  : iteratable<string|int, WithCustomSettings>
__construct()  : mixed
addVersion()  : void
build()  : void
buildDescriptor()  : TDescriptor|null
Takes the given data and attempts to build a Descriptor from it.
createProjectDescriptor()  : void
filter()  : TDescriptor|null
Analyzes a Descriptor and alters its state based on its state or even removes the descriptor.
getAssembler()  : AssemblerInterface<TDescriptor, TInput>|null
Attempts to find an assembler matching the given data.
getDefaultPackage()  : string
getIgnoredTags()  : array<string|int, string>
getProjectDescriptor()  : ProjectDescriptor
Returns the project descriptor that is being built.
setCustomSettings()  : void
setIgnoredTags()  : void
setIncludeSource()  : void
setMarkers()  : void
setName()  : void
setPartials()  : void
setVisibility()  : void
filterDescriptor()  : TDescriptor|null
Filters a descriptor, validates it, stores the validation results and returns the transmuted object or null if it is supposed to be removed.

Constants

Properties

Methods

buildDescriptor()

Takes the given data and attempts to build a Descriptor from it.

public buildDescriptor(object $data, class-string<\phpDocumentor\Descriptor\TDescriptor> $type) : TDescriptor|null
Parameters
$data : object
$type : class-string<\phpDocumentor\Descriptor\TDescriptor>
Tags
throws
InvalidArgumentException

If no Assembler could be found that matches the given data.

Return values
TDescriptor|null

filter()

Analyzes a Descriptor and alters its state based on its state or even removes the descriptor.

public filter(TDescriptor $descriptor) : TDescriptor|null
Parameters
$descriptor : TDescriptor
Return values
TDescriptor|null

getAssembler()

Attempts to find an assembler matching the given data.

public getAssembler(TInput $data, class-string<\phpDocumentor\Descriptor\TDescriptor> $type) : AssemblerInterface<TDescriptor, TInput>|null
Parameters
$data : TInput
$type : class-string<\phpDocumentor\Descriptor\TDescriptor>
Return values
AssemblerInterface<TDescriptor, TInput>|null

getIgnoredTags()

public getIgnoredTags() : array<string|int, string>
Return values
array<string|int, string>

setCustomSettings()

public setCustomSettings(array<string, string> $customSettings) : void
Parameters
$customSettings : array<string, string>
Return values
void

setIgnoredTags()

public setIgnoredTags(array<string|int, string> $ignoredTags) : void
Parameters
$ignoredTags : array<string|int, string>
Return values
void

setIncludeSource()

public setIncludeSource(bool $includeSources) : void
Parameters
$includeSources : bool
Return values
void

setMarkers()

public setMarkers(array<string|int, string> $markers) : void
Parameters
$markers : array<string|int, string>
Return values
void

setVisibility()

public setVisibility(array<string|int, string> $visibilities) : void
Parameters
$visibilities : array<string|int, string>
Return values
void

filterDescriptor()

Filters a descriptor, validates it, stores the validation results and returns the transmuted object or null if it is supposed to be removed.

protected filterDescriptor(TDescriptor $descriptor) : TDescriptor|null
Parameters
$descriptor : TDescriptor
Return values
TDescriptor|null

Search results