ProjectDescriptorBuilder

in package

Builds a Project Descriptor and underlying tree.

ProjectDescriptorBuilder.php

Constants

Properties

protected$assemblerFactory  : \phpDocumentor\Descriptor\Builder\AssemblerFactory                

protected$filter  : \phpDocumentor\Descriptor\Filter\Filter                

protected$project  : \phpDocumentor\Descriptor\ProjectDescriptor                

private$defaultPackage  : string                

private$servicesWithCustomSettings  : iterable

Methods

public__construct(AssemblerFactory $assemblerFactory, Filter $filterManager[, iterable $servicesWithCustomSettings = [] ]) : mixed

Parameters

$assemblerFactory : AssemblerFactory
$filterManager : Filter
$servicesWithCustomSettings : iterable = []

Returns

mixed — 

publiccreateProjectDescriptor() : void

Returns the project descriptor that is being built.

publicgetProjectDescriptor() : ProjectDescriptor

Returns

ProjectDescriptor —

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

publicbuildDescriptor(Element|File|Tag|Argument $data) : DescriptorAbstract|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>|null

Parameters

$data : Element|File|Tag|Argument

Throws

\InvalidArgumentException

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

Returns

DescriptorAbstract|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>|null —

Attempts to find an assembler matching the given data.

publicgetAssembler(mixed $data) : AssemblerInterface|null

Parameters

$data : mixed

Returns

AssemblerInterface|null —

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

publicfilter(Filterable $descriptor) : Filterable|null

Parameters

$descriptor : Filterable

Returns

Filterable|null — 

publicbuild(Project $project) : void

Parameters

$project : Project 

publicgetDefaultPackage() : string

Returns

string — 

publicsetVisibility(array $apiConfig) : void

Parameters

$apiConfig : array 

publicsetName(string $title) : void

Parameters

$title : string 

publicsetPartials(Collection $partials) : void

Parameters

$partials : Collection 

publicsetMarkers(array $markers) : void

Parameters

$markers : array 

publicsetCustomSettings(array $customSettings) : void

Parameters

$customSettings : array 

publicsetIncludeSource(bool $includeSources) : void

Parameters

$includeSources : bool 

publicaddVersion(VersionDescriptor $version) : void

Parameters

$version : VersionDescriptor

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

protectedfilterDescriptor(Descriptor $descriptor) : Descriptor|null

Parameters

$descriptor : Descriptor

Returns

Descriptor|null —