Classes, interfaces and traits

ArgumentDescriptor

Descriptor representing a single Argument of a method or function.

« More »

ClassDescriptor

Descriptor representing a Class.

« More »

Collection

Represents an easily accessible collection of elements.

The goal for this class is to allow Descriptors to be easily retrieved and set so that interaction in templates becomes easier.

« More »

ConstantDescriptor

Descriptor representing a constant

« More »

DescriptorAbstract

Base class for descriptors containing the most used options.

« More »

FileDescriptor

Represents a file in the project.

« More »

FunctionDescriptor

Descriptor representing a function.

« More »

InterfaceDescriptor

Descriptor representing an Interface.

« More »

MethodDescriptor

Descriptor representing a Method in a Class, Interface or Trait.

« More »

NamespaceDescriptor

Represents a namespace and its children for a project.

« More »

PackageDescriptor

Represents the package for a class, trait, interface or file.

« More »

ProjectAnalyzer

Analyzes a Project Descriptor and collects key information.

This class can be used by external tools to analyze the Project Descriptor and collect key information from it such as the total number of elements per type of Descriptor, the number of top level namespaces or the number of parent classes that could not be interpreted by the Compiler passes.

« More »

ProjectDescriptor

Represents the entire project with its files, namespaces and indexes.

« More »

ProjectDescriptorBuilder

Builds a Project Descriptor and underlying tree.

« More »

PropertyDescriptor

Descriptor representing a property.

« More »

ServiceProvider

This provider is responsible for registering the Descriptor component with the given Application.

« More »

TagDescriptor

Base class for any tag descriptor and used when a tag has no specific descriptor.

« More »

TraitDescriptor

Descriptor representing a Trait.

« More »

Classes, interfaces and traits

BooleanDescriptor

A type representing a boolean.

« More »

CollectionDescriptor

Descriptor representing a collection or compound type of collection object.

This descriptor represents any type that is capable of containing other typed values. Examples of such types can be an array, DoctrineCollection or ArrayObject.

« More »

FloatDescriptor

« More »

IntegerDescriptor

« More »

StringDescriptor

« More »

UnknownTypeDescriptor

This class represents any Type that could not be identified.

Sometimes DocBlocks refer to types, such as classes, that are outside the generated project's scope; in these cases we want to identify them as such with an unknown type descriptor.

« More »

Classes, interfaces and traits

AuthorDescriptor

Descriptor representing the author tag with a descriptor.

« More »

DeprecatedDescriptor

Descriptor representing the deprecated tag with a descriptor.

« More »

ExampleDescriptor

Descriptor representing the example tag with a descriptor.

« More »

LinkDescriptor

Descriptor representing the link tag with a descriptor.

« More »

MethodDescriptor

Base class for any tag descriptor and used when a tag has no specific descriptor.

« More »

ParamDescriptor

Descriptor representing the param tag with a function or method.

« More »

PropertyDescriptor

Descriptor representing the property tag on a class or trait.

« More »

ReturnDescriptor

Descriptor representing the return tag on a function or method.

« More »

SeeDescriptor

Base class for any tag descriptor and used when a tag has no specific descriptor.

« More »

SinceDescriptor

Descriptor representing the since tag with another descriptor.

« More »

ThrowsDescriptor

Descriptor representing the throws tag on a class or trait.

« More »

UsesDescriptor

Descriptor representing the uses tag on any element.

« More »

VarDescriptor

Descriptor representing the var tag on a property.

« More »

VersionDescriptor

Descriptor representing the version tag on a class, interface, trait or file.

« More »

Classes, interfaces and traits

TypedAbstract

Base descriptor for tags that have a type associated with them.

« More »

TypedVariableAbstract

Abstract class for Descriptors with a type and variable name.

« More »

Classes, interfaces and traits

AssemblerInterface

Interface for Assembler classes that transform data to specific Descriptor types.

« More »

AssemblerAbstract

Base class for all assemblers.

« More »

AssemblerFactory

Attempts to retrieve an Assembler for the provided criteria.

« More »

Classes, interfaces and traits

ArgumentAssembler

Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.

« More »

AssemblerAbstract

Base class for all assemblers.

« More »

ClassAssembler

Assembles an ClassDescriptor using an ClassReflector.

« More »

ConstantAssembler

Assembles a ConstantDescriptor from a ConstantReflector.

« More »

FileAssembler

Assembles an FileDescriptor using an FileReflector and ParamDescriptors.

« More »

FunctionAssembler

Assembles a FunctionDescriptor from a FunctionReflector.

« More »

InterfaceAssembler

Assembles an InterfaceDescriptor using an InterfaceReflector.

« More »

MethodAssembler

Assembles a MethodDescriptor from a MethodReflector.

« More »

PropertyAssembler

Assembles a PropertyDescriptor from a PropertyReflector.

« More »

TraitAssembler

Assembles an TraitDescriptor using an TraitReflector.

« More »

Classes, interfaces and traits

AuthorAssembler

Constructs a new descriptor from the Reflector for an `@author` tag.

This object will read the reflected information for the @author tag and create a \phpDocumentor\Descriptor\Tag\AuthorDescriptor object that can be used in the rest of the application and templates.

« More »

DeprecatedAssembler

Constructs a new descriptor from the Reflector for an `@deprecated` tag.

This object will read the reflected information for the @deprecated tag and create a \phpDocumentor\Descriptor\Tag\DeprecatedDescriptor object that can be used in the rest of the application and templates.

« More »

ExampleAssembler

This class collects data from the example tag definition of the Reflection library, tries to find the correlating example file on disk and creates a complete Descriptor from that.

« More »

GenericTagAssembler

Base class for all assemblers.

« More »

LinkAssembler

Constructs a new descriptor from the Reflector for an `@link` tag.

This object will read the reflected information for the @link tag and create a \phpDocumentor\Descriptor\Tag\LinkDescriptor object that can be used in the rest of the application and templates.

« More »

MethodAssembler

Constructs a new descriptor from the Reflector for an `@method` tag.

This object will read the reflected information for the @method tag and create a \phpDocumentor\Descriptor\Tag\MethodDescriptor object that can be used in the rest of the application and templates.

« More »

ParamAssembler

Constructs a new descriptor from the Reflector for an `@param` tag.

This object will read the reflected information for the @param tag and create a \phpDocumentor\Descriptor\Tag\ParamDescriptor object that can be used in the rest of the application and templates.

« More »

PropertyAssembler

Constructs a new descriptor from the Reflector for an `@property` tag.

This object will read the reflected information for the @property tag and create a \phpDocumentor\Descriptor\Tag\PropertyDescriptor object that can be used in the rest of the application and templates.

« More »

ReturnAssembler

Constructs a new descriptor from the Reflector for an `@return` tag.

This object will read the reflected information for the @return tag and create a \phpDocumentor\Descriptor\Tag\ReturnDescriptor object that can be used in the rest of the application and templates.

« More »

SeeAssembler

Constructs a new Descriptor from a Reflector object for the `@see` tag.

This class will gather the properties that were parsed by the Reflection mechanism for, specifically, an @see tag and use that to create a SeeDescriptor that describes all properties that an @see tag may have.

« More »

SinceAssembler

Constructs a new descriptor from the Reflector for an `@since` tag.

This object will read the reflected information for the @since tag and create a \phpDocumentor\Descriptor\Tag\SinceDescriptor object that can be used in the rest of the application and templates.

« More »

ThrowsAssembler

Constructs a new descriptor from the Reflector for an `@throws` tag.

This object will read the reflected information for the @throws tag and create a \phpDocumentor\Descriptor\Tag\ThrowsDescriptor object that can be used in the rest of the application and templates.

« More »

TypeCollectionAssembler

Creates a Collection of type-related value objects for the given Type Collection from the Reflector.

« More »

UsesAssembler

Base class for all assemblers.

« More »

VarAssembler

Constructs a new descriptor from the Reflector for an `@var` tag.

This object will read the reflected information for the @var tag and create a \phpDocumentor\Descriptor\Tag\VarDescriptor object that can be used in the rest of the application and templates.

« More »

VersionAssembler

Constructs a new descriptor from the Reflector for an `@version` tag.

This object will read the reflected information for the @version tag and create a \phpDocumentor\Descriptor\Tag\VersionDescriptor object that can be used in the rest of the application and templates.

« More »

Classes, interfaces and traits

Error

Struct to record a validation error.

« More »

Classes, interfaces and traits

ArgumentInterface

Describes the public interface for a descriptor of an Argument.

« More »

ChildInterface

Describes the public interface for any descriptor that is the child is another.

« More »

ClassInterface

Common interface representing the description of a class.

« More »

ConstantInterface

Descriptor representing a constant on a class, trait, property or file.

« More »

ContainerInterface

Interface representing the common interface for all elements that can contain sub-elements.

« More »

ElementInterface

Represents the public interface to which all descriptors should be held.

« More »

FileInterface

Describes the public interface for a description of a File.

« More »

FunctionInterface

Descriptor representing a global function in a file.

« More »

InterfaceInterface

Represents the public interface for an interface descriptor.

« More »

MethodInterface

Describes the public interface of the description for a method.

« More »

NamespaceInterface

Describes the public interface for the description of a namespace.

« More »

PackageInterface

Describes the public interface for a package descriptor.

« More »

ProjectInterface

Describes the public interface for the description of a project.

« More »

PropertyInterface

Descriptor representing a property on a class or trait.

« More »

TraitInterface

Public interface definition for object representing traits.

« More »

TypeInterface

« More »

VisibilityInterface

« More »

Classes, interfaces and traits

Filterable

Interface to determine which elements can be filtered and to provide a way to set errors on the descriptor.

« More »

ClassFactory

Retrieves a series of filters to manipulate a specific Descriptor with during building.

« More »

Filter

Filter used to manipulate a descriptor after being build.

This class is used during the building of descriptors. It passes the descriptor to each individual sub-filter, which may change data in the descriptor or even remove it from the building process by returning null.

« More »

StripIgnore

Strips any Descriptor if the ignore tag is present with that element.

« More »

StripInternal

Filters a Descriptor when the @internal inline tag, or normal tag, is used.

When a Descriptor's description contains the inline tag @internal then the description of that tag should be included only when the visibility allows INTERNAL information. Otherwise it needs to be removed.

Similarly, whenever the normal @internal tag is used should this filter return null if the visibility does not allow INTERNAL information. This will remove this descriptor from the project.

« More »

StripOnVisibility

Strips any Descriptor if their visibility is allowed according to the ProjectDescriptorBuilder.

« More »

Classes, interfaces and traits

Settings

Contains the Settings for the current Project.

« More »

Classes, interfaces and traits

Finder

Class used to find an example file's location based on a given ExampleDescriptor.

« More »

Classes, interfaces and traits

MissingDependencyException

This exception is thrown when a required dependency is not included.

« More »

Classes, interfaces and traits

ProjectDescriptorMapper

Maps a projectDescriptor to and from a cache instance.

« More »