phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\DescriptorProjectDescriptorBuilder

Builds a Project Descriptor and underlying tree.

Summary

Methods
Properties
Constants
__construct()
createProjectDescriptor()
getProjectDescriptor()
buildDescriptor()
getAssembler()
usingApiSpecification()
populateApiDocumentationSet()
usingDefaultPackageName()
getDefaultPackageName()
setVisibility()
setName()
setPartials()
setCustomSettings()
addVersion()
No public properties found
DEFAULT_PROJECT_NAME
filterDescriptor()
$assemblerFactory
$filter
$project
N/A
No private methods found
$servicesWithCustomSettings
$apiSpecification
$defaultPackageName
N/A

Constants

DEFAULT_PROJECT_NAME

DEFAULT_PROJECT_NAME = 'Untitled project' : string

Properties

$assemblerFactory

$assemblerFactory : \phpDocumentor\Descriptor\Builder\AssemblerFactory

Type

\phpDocumentor\Descriptor\Builder\AssemblerFactory —

$filter

$filter : \phpDocumentor\Descriptor\Filter\Filter

Type

\phpDocumentor\Descriptor\Filter\Filter —

$project

$project : \phpDocumentor\Descriptor\ProjectDescriptor

Type

\phpDocumentor\Descriptor\ProjectDescriptor —

$servicesWithCustomSettings

$servicesWithCustomSettings : iterable<\phpDocumentor\Descriptor\ProjectDescriptor\WithCustomSettings>

Type

iterable<\phpDocumentor\Descriptor\ProjectDescriptor\WithCustomSettings> —

$apiSpecification

$apiSpecification : \phpDocumentor\Configuration\ApiSpecification

Type

\phpDocumentor\Configuration\ApiSpecification

$defaultPackageName

$defaultPackageName : string

Type

string

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Builder\AssemblerFactory  $assemblerFactory, \phpDocumentor\Descriptor\Filter\Filter  $filterManager, iterable<\phpDocumentor\Descriptor\ProjectDescriptor\WithCustomSettings>  $servicesWithCustomSettings = []) : mixed

Parameters

\phpDocumentor\Descriptor\Builder\AssemblerFactory $assemblerFactory
\phpDocumentor\Descriptor\Filter\Filter $filterManager
iterable<\phpDocumentor\Descriptor\ProjectDescriptor\WithCustomSettings> $servicesWithCustomSettings

Returns

mixed —

createProjectDescriptor()

createProjectDescriptor() : void

getProjectDescriptor()

getProjectDescriptor() : \phpDocumentor\Descriptor\ProjectDescriptor

Returns the project descriptor that is being built.

Returns

\phpDocumentor\Descriptor\ProjectDescriptor —

buildDescriptor()

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

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

Parameters

object $data
class-string<\phpDocumentor\Descriptor\TDescriptor> $type

Throws

\InvalidArgumentException

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

Returns

\phpDocumentor\Descriptor\TDescriptor|null —

getAssembler()

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

Attempts to find an assembler matching the given data.

Parameters

\phpDocumentor\Descriptor\TInput $data
class-string<\phpDocumentor\Descriptor\TDescriptor> $type

Returns

\phpDocumentor\Descriptor\Builder\AssemblerInterface<\phpDocumentor\Descriptor\TDescriptor,\phpDocumentor\Descriptor\TInput>|null —

usingApiSpecification()

usingApiSpecification(\phpDocumentor\Configuration\ApiSpecification  $apiSpecification) : void

Parameters

\phpDocumentor\Configuration\ApiSpecification $apiSpecification

populateApiDocumentationSet()

populateApiDocumentationSet(\phpDocumentor\Descriptor\ApiSetDescriptor  $apiSet, \phpDocumentor\Reflection\Php\Project  $project) : void

Parameters

\phpDocumentor\Descriptor\ApiSetDescriptor $apiSet
\phpDocumentor\Reflection\Php\Project $project

usingDefaultPackageName()

usingDefaultPackageName(string  $name) : void

Parameters

string $name

getDefaultPackageName()

getDefaultPackageName() : string

Returns

string —

setVisibility()

setVisibility(int  $visibility) : void

Parameters

int $visibility

setName()

setName(string  $title) : void

Parameters

string $title

setPartials()

setPartials(\phpDocumentor\Descriptor\Collection<string>  $partials) : void

Parameters

\phpDocumentor\Descriptor\Collection $partials

setCustomSettings()

setCustomSettings(array<string,string>  $customSettings) : void

Parameters

array $customSettings

addVersion()

addVersion(\phpDocumentor\Descriptor\VersionDescriptor  $version) : void

Parameters

\phpDocumentor\Descriptor\VersionDescriptor $version

filterDescriptor()

filterDescriptor(\phpDocumentor\Descriptor\TDescriptor  $descriptor) : \phpDocumentor\Descriptor\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.

Parameters

\phpDocumentor\Descriptor\TDescriptor $descriptor

Returns

\phpDocumentor\Descriptor\TDescriptor|null —