Constants

DEFAULT_PROJECT_NAME

DEFAULT_PROJECT_NAME = 'Untitled project' : string

Properties

$assemblerFactory

$assemblerFactory : \phpDocumentor\Descriptor\Builder\AssemblerFactory

Type

AssemblerFactory

$filter

$filter : \phpDocumentor\Descriptor\Filter\Filter

Type

Filter

$project

$project : \phpDocumentor\Descriptor\ProjectDescriptor

Type

ProjectDescriptor

$servicesWithCustomSettings

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

Type

WithCustomSettings>

$apiSpecification

$apiSpecification : \phpDocumentor\Configuration\ApiSpecification

Type

ApiSpecification

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 —

filter()

filter(\phpDocumentor\Descriptor\TDescriptor  $descriptor) : \phpDocumentor\Descriptor\TDescriptor|null

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

Parameters

\phpDocumentor\Descriptor\TDescriptor $descriptor

Returns

\phpDocumentor\Descriptor\TDescriptor|null —

setApiSpecification()

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

Parameters

\phpDocumentor\Configuration\ApiSpecification $apiSpecification

createApiDocumentationSet()

createApiDocumentationSet(\phpDocumentor\Reflection\Php\Project  $project) : void

Parameters

\phpDocumentor\Reflection\Php\Project $project

getDefaultPackage()

getDefaultPackage() : string

Returns

string —

setVisibility()

setVisibility(int  $visibility) : void

Parameters

int $visibility

shouldIncludeSource()

shouldIncludeSource() : bool

Returns

bool —

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 —