phpDocumentor

Default

Interfaces, Classes and Traits

Format
ParserInterface
Factory
Parser
FormatListRenderer
FullDocumentNodeRenderer
NodeRenderer
NodeRendererFactory
SpanRenderer
Format
NodeFactory
CompilerPassInterface
Represents a single pass / business rule to be executed by the Compiler.
Normalizable
Upgradable
MiddlewareInterface
AssemblerInterface
AssemblerReducer
A step in creating descriptors from reflection elements
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.
Configuration
Documents
Environment
Files
LoadCacheHandler
PersistCacheHandler
RenderHandler
InvalidLink
LoadCacheCommand
Parser
AbstractBlock
ListBlock
Paragraph
ThematicBreak
Entry
Metas
AnchorNode
BlockNode
CallableNode
CodeNode
DefinitionListNode
DocumentNode
DummyNode
FigureNode
ImageNode
ListNode
MainNode
MetaNode
Node
NodeTypes
ParagraphNode
QuoteNode
RawNode
SectionBeginNode
SectionEndNode
SeparatorNode
SpanNode
TableColumn
TableRow
TableNode
TitleNode
TocNode
WrapperNode
PersistCacheCommand
ClassReference
A reference is something that can be resolved in the document, for instance:
DeciderReference
A reference is something that can be resolved in the document, for instance:
Doc
A reference is something that can be resolved in the document, for instance:
LeaderReference
A reference is something that can be resolved in the document, for instance:
MergerReference
A reference is something that can be resolved in the document, for instance:
MethodReference
A reference is something that can be resolved in the document, for instance:
NamespaceReference
A reference is something that can be resolved in the document, for instance:
PhpClassReference
A reference is something that can be resolved in the document, for instance:
PhpFunctionReference
A reference is something that can be resolved in the document, for instance:
PhpMethodReference
A reference is something that can be resolved in the document, for instance:
Reference
A reference is something that can be resolved in the document, for instance:
ResolvedReference
Resolver
TermReference
A reference is something that can be resolved in the document, for instance:
RenderCommand
Renderer
CallableNodeRenderer
CallableNodeRendererFactory
DefaultNodeRenderer
DocumentNodeRenderer
AnchorNodeRenderer
CodeNodeRenderer
DefinitionListNodeRenderer
DocumentNodeRenderer
FigureNodeRenderer
ImageNodeRenderer
ListRenderer
MetaNodeRenderer
ParagraphNodeRenderer
QuoteNodeRenderer
SectionBeginNodeRenderer
SectionEndNodeRenderer
SeparatorNodeRenderer
SpanNodeRenderer
TableNodeRenderer
TitleNodeRenderer
TocNodeRenderer
AnchorNodeRenderer
CodeNodeRenderer
DocumentNodeRenderer
ImageNodeRenderer
LaTexMainNodeRenderer
ListRenderer
MetaNodeRenderer
ParagraphNodeRenderer
QuoteNodeRenderer
SeparatorNodeRenderer
SpanNodeRenderer
TableNodeRenderer
TitleNodeRenderer
TocNodeRenderer
ListNodeRenderer
RenderedNode
SpanNodeRenderer
Copier
ParseQueueProcessor
Scanner
CodeBlock
Renders a code block, example:
Directive
A directive is like a function you can call or apply to a block Il looks like:
Dummy
A directive is like a function you can call or apply to a block Il looks like:
Raw
Renders a raw block, example:
Replace
The Replace directive will set the variables for the spans
SubDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Toctree
A directive is like a function you can call or apply to a block Il looks like:
BuildEvent
OnLinkParsedEvent
PostBuildRenderEvent
PostNodeCreateEvent
PostNodeRenderEvent
PostParseDocumentEvent
PreBuildParseEvent
PreBuildRenderEvent
PreBuildScanEvent
PreNodeRenderEvent
PreParseDocumentEvent
InvalidTableStructure
FileIncluder
ParseDirectoryHandler
ParseFileHandler
AbstractAdmonitionDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
AdmonitionDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
BestPracticeDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
CautionDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
ClassDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
CodeBlockDirective
A directive is like a function you can call or apply to a block Il looks like:
ConfigurationBlockDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
DeprecatedDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Div
Divs a sub document in a div with a given class
Figure
Renders an image, example :
GlossaryDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
HintDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Image
Renders an image, example :
ImportantDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
IndexDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Meta
Add a meta information:
NoteDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
RoleDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
SeeAlsoDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
SidebarDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Stylesheet
Adds a stylesheet to a document, example:
TipDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Title
Add a meta title to the document
TopicDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Url
Sets the document URL
VersionAddedDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
WarningDirective
A directive that parses the sub block and call the processSub that can be overloaded, like :
Wrap
Wraps a sub document in a div with a given class
HTMLFormat
Image
Renders an image, example :
LaTeXMain
Marks the document as LaTeX main
Meta
Add a meta information:
Stylesheet
Adds a stylesheet to a document, example:
Title
Add a meta title to the document
Url
Sets the document URL
Wrap
Wraps a sub document in a div with a given class
LaTeXFormat
AssetsCopyListener
CopyImagesListener
CachedMetasLoader
DefaultNodeFactory
NodeInstantiator
ParseDirectoryCommand
ParseFileCommand
Buffer
DefinitionList
DefinitionListTerm
Directive
DirectiveOption
DocumentParser
LineChecker
LineDataParser
Lines
Link
ListLine
State
TableParser
TableSeparatorLineConfig
Parser
SpanProcessor
SpanToken
GlobSearcher
ToctreeBuilder
TemplateRenderer
AssetsExtension
TocExtension
UrlGenerator
Application
Application class for phpDocumentor.
AutoloaderLocator
Compiler
Contains a series of compiler steps in a specific order; ready to be executed during transformation.
DescriptorRepository
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.
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.
ResolveInlineMarkers
CommandlineOptionsMiddleware
Configuration
ConfigurationFactory
The ConfigurationFactory converts the configuration xml from a Uri into an array.
Version2
Version3
InvalidConfigPathException
UnSupportedConfigVersionException
UpgradeFailedException
PathNormalizingMiddleware
ProvideTemplateOverridePathMiddleware
Determines the path where the general template overrides are.
SymfonyConfigFactory
Application
ListSettingsCommand
RunCommand
Parse and transform the given directory (-d|-f) to the given location (-t).
ApiSetDescriptor
AssemblerAbstract
Base class for all assemblers.
AssemblerFactory
Attempts to retrieve an Assembler for the provided criteria.
AssemblerMatcher
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.
DescriptionAssemblerReducer
Base class for all assemblers.
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.
BaseTagAssembler
Base class for all assemblers.
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.
Collection
Represents an easily accessible collection of elements.
DescriptorAbstract
Base class for descriptors containing the most used options.
DescriptionDescriptor
DocumentationSetDescriptor
MissingDependencyException
This exception is thrown when a required dependency is not included.
Filter
Filter used to manipulate a descriptor after being build.
StripIgnore
Strips any Descriptor if the ignore tag is present with that element.
StripIgnoredTags
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.
GuideSetDescriptor
ProjectAnalyzer
Analyzes a Project Descriptor and collects key information.
Settings
Contains the Settings for the current Project.
ProjectDescriptorBuilder
Builds a Project Descriptor and underlying tree.
TypedAbstract
Base descriptor for tags that have a type associated with them.
TypedVariableAbstract
Abstract class for Descriptors with a type and variable name.
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.
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
LoadGuidesFromCache
LoadProjectDescriptorFromCache
PurgeCachesWhenForced
StoreGuidesToCache
StoreProjectDescriptorToCache
Configure
InitializeBuilderFromConfig
CollectFiles
ParseFiles
ParseGuides
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.
CommonMarkFactory
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

Search results