DEFAULT_PROJECT_NAME
DEFAULT_PROJECT_NAME = 'Untitled project' : string
Builds a Project Descriptor and underlying tree.
$assemblerFactory : \phpDocumentor\Descriptor\Builder\AssemblerFactory
$filter : \phpDocumentor\Descriptor\Filter\Filter
$project : \phpDocumentor\Descriptor\ProjectDescriptor
$translator : \phpDocumentor\Translator\Translator
__construct(\phpDocumentor\Descriptor\Builder\AssemblerFactory $assemblerFactory, \phpDocumentor\Descriptor\Filter\Filter $filterManager, \Symfony\Component\Validator\Validator $validator)
| \phpDocumentor\Descriptor\Builder\AssemblerFactory | $assemblerFactory | |
| \phpDocumentor\Descriptor\Filter\Filter | $filterManager | |
| \Symfony\Component\Validator\Validator | $validator |
setProjectDescriptor(\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor)
| \phpDocumentor\Descriptor\ProjectDescriptor | $projectDescriptor |
getProjectDescriptor() : \phpDocumentor\Descriptor\ProjectDescriptor
Returns the project descriptor that is being built.
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.
| string|integer | $visibility | One of the visibility constants of the ProjectDescriptor class or the words 'public', 'protected', 'private' or 'internal'. |
buildDescriptor(mixed $data) : \phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\Collection|null
Takes the given data and attempts to build a Descriptor from it.
| mixed | $data |
if no Assembler could be found that matches the given data.
getAssembler(mixed $data) : \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract
Attempts to find an assembler matching the given data.
| mixed | $data |
filter(\phpDocumentor\Descriptor\Filter\Filterable $descriptor) : \phpDocumentor\Descriptor\Filter\Filterable
Analyzes a Descriptor and alters its state based on its state or even removes the descriptor.
| \phpDocumentor\Descriptor\Filter\Filterable | $descriptor |
validate(\phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : \phpDocumentor\Descriptor\Collection
Validates the contents of the Descriptor and outputs warnings and error if something is amiss.
| \phpDocumentor\Descriptor\DescriptorAbstract | $descriptor |
setTranslator(\phpDocumentor\Translator\Translator $translator) : void
| \phpDocumentor\Translator\Translator | $translator |
filterAndValidateDescriptor(\phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : \phpDocumentor\Descriptor\DescriptorAbstract|null
Filters a descriptor, validates it, stores the validation results and returns the transmuted object or null if it is supposed to be removed.
| \phpDocumentor\Descriptor\DescriptorAbstract | $descriptor |
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.
| array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> | $descriptor |