Constants
DEFAULT_PROJECT_NAME Line 38
string DEFAULT_PROJECT_NAME = 'Untitled project'
Properties
$assemblerFactory Line 41
protected$assemblerFactory : \phpDocumentor\Descriptor\Builder\AssemblerFactory
$filter Line 44
protected$filter : \phpDocumentor\Descriptor\Filter\Filter
$project Line 47
protected$project : \phpDocumentor\Descriptor\ProjectDescriptor
$defaultPackage Line 50
private$defaultPackage : string
$servicesWithCustomSettings Line 53
private$servicesWithCustomSettings : iterable
Methods
__construct() Line 58
public__construct(AssemblerFactory $assemblerFactory, Filter $filterManager[, iterable $servicesWithCustomSettings = [] ]) : mixed
Parameters
Returns
mixed —
createProjectDescriptor() Line 68
publiccreateProjectDescriptor() : void
getProjectDescriptor() Line 76
Returns the project descriptor that is being built.
publicgetProjectDescriptor() : ProjectDescriptor
buildDescriptor() Line 90
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
Throws
- \InvalidArgumentException
If no Assembler could be found that matches the given data.
Returns
DescriptorAbstract|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>|null —
getAssembler() Line 115
Attempts to find an assembler matching the given data.
publicgetAssembler(mixed $data) : AssemblerInterface|null
filter() Line 123
Analyzes a Descriptor and alters its state based on its state or even removes the descriptor.
publicfilter(Filterable $descriptor) : Filterable|null
build() Line 147
publicbuild(Project $project) : void
Parameters
getDefaultPackage() Line 178
publicgetDefaultPackage() : string
Returns
string —
setVisibility() Line 186
publicsetVisibility(array $apiConfig) : void
Parameters
setName() Line 221
publicsetName(string $title) : void
Parameters
setPartials() Line 229
publicsetPartials(Collection $partials) : void
setMarkers() Line 237
publicsetMarkers(array $markers) : void
Parameters
setCustomSettings() Line 245
publicsetCustomSettings(array $customSettings) : void
Parameters
setIncludeSource() Line 250
publicsetIncludeSource(bool $includeSources) : void
Parameters
addVersion() Line 259
publicaddVersion(VersionDescriptor $version) : void
filterDescriptor() Line 132
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