Default
Interfaces, Classes & Traits
-
CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
- Normalizable
- Upgradable
-
AssemblerInterface
- Interface for Assembler classes that transform data to specific Descriptor types.
-
Descriptor
- Base class for descriptors containing the most used options.
-
Filterable
- Interface to determine which elements can be filtered and to provide a way to set errors on the descriptor.
- FilterInterface
-
ArgumentInterface
- Describes the public interface for a descriptor of an Argument.
-
ChildInterface
- Describes the public interface for any descriptor that is the child is another.
-
ClassInterface
- Common interface representing the description of a class.
-
ConstantInterface
- Descriptor representing a constant on a class, trait, property or file.
-
ContainerInterface
- Interface representing the common interface for all elements that can contain sub-elements.
-
ElementInterface
- Represents the public interface to which all descriptors should be held.
-
FileInterface
- Describes the public interface for a description of a File.
-
FunctionInterface
- Descriptor representing a global function in a file.
-
InterfaceInterface
- Represents the public interface for an interface descriptor.
-
MethodInterface
- Describes the public interface of the description for a method.
-
NamespaceInterface
- Describes the public interface for the description of a namespace.
-
PackageInterface
- Describes the public interface for a package descriptor.
-
ProjectInterface
- Describes the public interface for the description of a project.
-
PropertyInterface
- Descriptor representing a property on a class or trait.
-
TraitInterface
- Public interface definition for object representing traits.
- TypeInterface
- VisibilityInterface
-
WithCustomSettings
- Declares that the service implementing this interface yields its own settings.
- FileCollector
-
FileSystemFactory
- Interface for FileSystem factories.
-
SpecificationFactoryInterface
- Interface for Specifications used to filter the FileSystem.
- Generator
- Initializable
-
ExtensionInterface
- An interface shared by all Twig interfaces intended for phpDocumentor.
- Application
- Application class for phpDocumentor.
- AutoloaderLocator
- Compiler
- Contains a series of compiler steps in a specific order; ready to be executed during transformation.
- DescriptorRepository
- Linker
- The linker contains all rules to replace FQSENs in the ProjectDescriptor with aliases to objects.
- Debug
- This class is responsible for sending statistical information to the log.
- ElementsIndexBuilder
- This class constructs the index 'elements' and populates it with all Structural Elements.
- ExampleTagsEnricher
- This index builder collects all examples from tags and inserts them into the example index.
- MarkerFromTagsExtractor
- This index builder collects all markers from tags and inserts them into the marker index.
- NamespaceTreeBuilder
- Rebuilds the namespace tree from the elements found in files.
- PackageTreeBuilder
- Rebuilds the package tree from the elements found in files.
- ResolveInlineLinkAndSeeTags
- This step in the compilation process iterates through all elements and scans their descriptions for an inline `@see` or `@link` tag and resolves them to a markdown link.
- ResolveInlineMarkers
- CommandlineOptionsMiddleware
- Configuration
- ConfigurationFactory
- Version2
- Version3
- InvalidConfigPathException
- UnSupportedConfigVersionException
- UpgradeFailedException
- PathNormalizingMiddleware
- ProvideTemplateOverridePathMiddleware
- SymfonyConfigFactory
- Application
- ListSettingsCommand
- RunCommand
- Parse and transform the given directory (-d|-f) to the given location (-t).
- AssemblerAbstract
- Base class for all assemblers.
- AssemblerFactory
- Attempts to retrieve an Assembler for the provided criteria.
- AssemblerMatcher
- Matcher
- ArgumentAssembler
- Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.
- AssemblerAbstract
- Base class for all assemblers.
- ClassAssembler
- Assembles an ClassDescriptor using an ClassReflector.
- ConstantAssembler
- Assembles a ConstantDescriptor from a ConstantReflector.
- FileAssembler
- Assembles an FileDescriptor using an FileReflector and ParamDescriptors.
- FunctionAssembler
- Assembles a FunctionDescriptor from a FunctionReflector.
- InterfaceAssembler
- Assembles an InterfaceDescriptor using an InterfaceReflector.
- MethodAssembler
- Assembles a MethodDescriptor from a MethodReflector.
- NamespaceAssembler
- Base class for all assemblers.
- PropertyAssembler
- Assembles a PropertyDescriptor from a PropertyReflector.
- AuthorAssembler
- Constructs a new descriptor from the Reflector for an `@author` tag.
- DeprecatedAssembler
- Constructs a new descriptor from the Reflector for an `@deprecated` tag.
- 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.
- GenericTagAssembler
- Base class for all assemblers.
- InvalidTagAssembler
- Base class for all assemblers.
- LinkAssembler
- Constructs a new descriptor from the Reflector for an `@link` tag.
- MethodAssembler
- Constructs a new descriptor from the Reflector for an `@method` tag.
- ParamAssembler
- Constructs a new descriptor from the Reflector for an `@param` tag.
- PropertyAssembler
- Constructs a new descriptor from the Reflector for an `@property` tag.
- ReturnAssembler
- Constructs a new descriptor from the Reflector for an `@return` tag.
- SeeAssembler
- Constructs a new Descriptor from a Reflector object for the `@see` tag.
- SinceAssembler
- Constructs a new descriptor from the Reflector for an `@since` tag.
- ThrowsAssembler
- Constructs a new descriptor from the Reflector for an `@throws` tag.
- UsesAssembler
- Base class for all assemblers.
- VarAssembler
- Constructs a new descriptor from the Reflector for an `@var` tag.
- VersionAssembler
- Constructs a new descriptor from the Reflector for an `@version` tag.
- TraitAssembler
- Assembles an TraitDescriptor using an TraitReflector.
- ProjectDescriptorMapper
- Maps a projectDescriptor to and from a cache instance.
- ClassDescriptor
- Descriptor representing a Class.
- Collection
- Represents an easily accessible collection of elements.
- ConstantDescriptor
- Descriptor representing a constant
- DescriptorAbstract
- Base class for descriptors containing the most used options.
- DocumentationSetDescriptor
- Finder
- Class used to find an example file's location based on a given ExampleDescriptor.
- MissingDependencyException
- This exception is thrown when a required dependency is not included.
- FileDescriptor
- Represents a file in the project.
- ClassFactory
- Retrieves a series of filters to manipulate a specific Descriptor with during building.
- Filter
- Filter used to manipulate a descriptor after being build.
- StripIgnore
- Strips any Descriptor if the ignore tag is present with that element.
- StripInternal
- Filters a Descriptor when the @internal inline tag, or normal tag, is used.
- StripOnVisibility
- Strips any Descriptor if their visibility is allowed according to the ProjectDescriptorBuilder.
- FunctionDescriptor
- Descriptor representing a function.
- GuideSetDescriptor
- InterfaceDescriptor
- Descriptor representing an Interface.
- MethodDescriptor
- Descriptor representing a Method in a Class, Interface or Trait.
- NamespaceDescriptor
- Represents a namespace and its children for a project.
- PackageDescriptor
- Represents the package for a class, trait, interface or file.
- ProjectAnalyzer
- Analyzes a Project Descriptor and collects key information.
- Settings
- Contains the Settings for the current Project.
- ProjectDescriptor
- Represents the entire project with its files, namespaces and indexes.
- ProjectDescriptorBuilder
- Builds a Project Descriptor and underlying tree.
- PropertyDescriptor
- Descriptor representing a property.
- TypedAbstract
- Base descriptor for tags that have a type associated with them.
- TypedVariableAbstract
- Abstract class for Descriptors with a type and variable name.
- DeprecatedDescriptor
- Descriptor representing the deprecated tag with a descriptor.
- ExampleDescriptor
- Descriptor representing the example tag with a descriptor.
- LinkDescriptor
- Descriptor representing the link tag with a descriptor.
- MethodDescriptor
- Base class for any tag descriptor and used when a tag has no specific descriptor.
- ParamDescriptor
- Descriptor representing the param tag with a function or method.
- PropertyDescriptor
- Descriptor representing the property tag on a class or trait.
- ReturnDescriptor
- Descriptor representing the return tag on a function or method.
- SeeDescriptor
- Base class for any tag descriptor and used when a tag has no specific descriptor.
- SinceDescriptor
- Descriptor representing the since tag with another descriptor.
- ThrowsDescriptor
- Descriptor representing the throws tag on a class or trait.
- UsesDescriptor
- Descriptor representing the uses tag on any element.
- VarDescriptor
- Descriptor representing the var tag on a property.
- VersionDescriptor
- Descriptor representing the version tag on a class, interface, trait or file.
- TagDescriptor
- Base class for any tag descriptor and used when a tag has no specific descriptor.
- TraitDescriptor
- Descriptor representing a Trait.
- Error
- Struct to record a validation error.
- VersionDescriptor
- Dsn
- Data Source Name (DSN), a reference to a path on a local or remote system with the ability to add parameters.
- Dispatcher
- Event Dispatching class.
- EventAbstract
- Abstract class representing the base elements of a phpDocumentor event.
- BuildContext
- AbstractAdmonitionDirective
- AdmonitionDirective
- BestPracticeDirective
- CautionDirective
- CodeBlockDirective
- ConfigurationBlockDirective
- DeprecatedDirective
- GlossaryDirective
- HintDirective
- ImportantDirective
- IndexDirective
- NoteDirective
- RoleDirective
- SeeAlsoDirective
- SidebarDirective
- TipDirective
- TopicDirective
- VersionAddedDirective
- WarningDirective
- DocsKernel
- HtmlForPdfGenerator
- JsonGenerator
- HtmlFormat
- KernelFactory
- AssetsCopyListener
- CopyImagesListener
- ClassReference
- DeciderReference
- LeaderReference
- MergerReference
- MethodReference
- NamespaceReference
- PhpClassReference
- PhpFunctionReference
- PhpMethodReference
- TermReference
- CodeNodeRenderer
- DocumentNodeRenderer
- SpanNodeRenderer
- AssetsExtension
- Kernel
- FilesystemAdapter
- Locator
- Locates the cache folder and ensures that the Symfony Cache is routed to that folder.
- PreFileEvent
- Event thrown before the parsing of an individual file.
- PreParsingEvent
- Event thrown before the parsing all files.
- FilesNotFoundException
- Exception that is thrown when the parser expects files but is unable to find them.
- FileFactory
- FlySystemCollector
- FlySystemFactory
- FlySystemFile
- FlySystemMirror
- CacheMiddleware
- EmittingMiddleware
- ErrorHandlingMiddleware
- ReEncodingMiddleware
- StopwatchMiddleware
- Parser
- Class responsible for parsing the given file or files to the intermediate structure file.
- ReEncodedFile
- SpecificationFactory
- Factory class to build Specification used by FlyFinder when reading files to process.
- Path
- Value Object for paths.
- PipelineFactory
- GarbageCollectCache
- LoadProjectDescriptorFromCache
- PurgeCachesWhenForced
- StoreProjectDescriptorToCache
- Configure
- InitializeBuilderFromConfig
- CollectFiles
- ParseFiles
- Payload
- TransformToParserPayload
- Payload
- Transform
- Transforms the structure file into the specified output format
- TransformToPayload
- PostTransformationEvent
- Event that happens after each individual transformation.
- PostTransformEvent
- Event happen right after all transformations have completed.
- PreTransformationEvent
- Event happening prior to each individual transformation.
- PreTransformEvent
- Event that happens prior to the execution of all transformations.
- WriterInitializationEvent
- Abstract class representing the base elements of a phpDocumentor event.
- Exception
- Provides the basic exception for the parser package.
- ClassBasedFqsenUrlGenerator
- Generates a relative URL with properties for use in the generated HTML documentation.
- Router
- Collection
- Contains a collection of Templates that may be queried.
- Factory
- Parameter
- Model representing a parameter in a template or transformation.
- TemplateNotFound
- Template
- Model representing a template.
- Transformation
- Class representing a single Transformation.
- Transformer
- Core class responsible for transforming the cache file to a set of artifacts.
- Collection
- A collection of Writer objects.
- RequirementMissing
- This exception should be thrown by a Writer when it is missing one of its requirements.
- FileIo
- Writer containing file system operations.
- GraphVizClassDiagram
- PlantumlClassDiagram
- Graph
- Writer responsible for generating various graphs.
- Pathfinder
- PathGenerator
- RenderGuide
- Base class for the actual transformation business logic (writers).
- Sourcecode
- Sourcecode transformation writer; generates syntax highlighted source files in a destination's subfolder.
- EnvironmentFactory
- Extension
- Basic extension adding phpDocumentor specific functionality for Twig templates.
- FlySystemLoader
- LinkRenderer
- Renders an HTML anchor pointing to the location of the provided element.
- Twig
- A specialized writer which uses the Twig templating engine to convert templates to HTML output.
- WriterAbstract
- Base class for the actual transformation business logic (writers).
- UriFactory
- IoTrait