phpDocumentor

ProjectDescriptorBuilder
in package

Builds a Project Descriptor and underlying tree.

Table of Contents

Constants

DEFAULT_PROJECT_NAME  = 'Untitled project'

Properties

$assemblerFactory  : AssemblerFactory
$filter  : Filter
$project  : ProjectDescriptor
$apiSpecification  : ApiSpecification
$defaultPackageName  : string
$servicesWithCustomSettings  : iterable<string|int, mixed>

Methods

__construct()  : mixed
addVersion()  : void
buildDescriptor()  : TDescriptor|null
Takes the given data and attempts to build a Descriptor from it.
createProjectDescriptor()  : void
getAssembler()  : AssemblerInterface<TDescriptor, TInput>|null
Attempts to find an assembler matching the given data.
getDefaultPackageName()  : string
getProjectDescriptor()  : ProjectDescriptor
Returns the project descriptor that is being built.
populateApiDocumentationSet()  : void
setCustomSettings()  : void
setName()  : void
setPartials()  : void
setVisibility()  : void
usingApiSpecification()  : void
usingDefaultPackageName()  : 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

$servicesWithCustomSettings read-only

private iterable<string|int, mixed> $servicesWithCustomSettings = []

Methods

buildDescriptor()

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

public buildDescriptor(object $data, TDescriptor> $type) : TDescriptor|null
Parameters
$data : object
$type : TDescriptor>
Tags
throws
InvalidArgumentException

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

Return values
TDescriptor|null

setCustomSettings()

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

usingDefaultPackageName()

public usingDefaultPackageName(string $name) : void
Parameters
$name : string

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

        
On this page

Search results