Constants

DEFAULT_PROJECT_NAME

DEFAULT_PROJECT_NAME

Properties

$validator

$validator : \Symfony\Component\Validator\Validator

Type

\Symfony\Component\Validator\Validator

Methods

createProjectDescriptor()

createProjectDescriptor() 

isVisibilityAllowed()

isVisibilityAllowed(string|integer  $visibility) : boolean

Verifies whether the given visibility is allowed to be included in the Descriptors.

This method is used anytime a Descriptor is added to a collection (for example, when adding a Method to a Class) to determine whether the visibility of that element is matches what the user has specified when it ran phpDocumentor.

Parameters

string|integer $visibility

One of the visibility constants of the ProjectDescriptor class or the words 'public', 'protected', 'private' or 'internal'.

Returns

boolean

buildFileUsingSourceData()

buildFileUsingSourceData(  $data) 

Parameters

$data

buildDescriptor()

buildDescriptor(mixed  $data) : \phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\Collection|null

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

Parameters

mixed $data

Throws

\InvalidArgumentException

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

Returns

\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\Collection|null

mapCodeToSeverity()

mapCodeToSeverity(integer  $code) : string

Map error code to severity.

Parameters

integer $code

Returns

string

filterAndValidateEachDescriptor()

filterAndValidateEachDescriptor(array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract>  $descriptor) : \phpDocumentor\Descriptor\Collection

Filters each descriptor, validates them, stores the validation results and returns a collection of transmuted objects.

Parameters

array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> $descriptor

Returns

\phpDocumentor\Descriptor\Collection