Classes, interfaces and traits

Configuration

Configuration definition for the transformer.

« More »

Exception

Provides the basic exception for the parser package.

« More »

ServiceProvider

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

« More »

Template

Model representing a template.

« More »

Transformation

Class representing a single Transformation.

« More »

Transformer

Core class responsible for transforming the cache file to a set of artifacts.

« More »

Classes, interfaces and traits

ExternalRouter

Connects class, interface and traits to remote documentation sets.

« More »

ForFileProxy

Proxies a generated Routing Rule to generate physical filenames.

By default a RoutingRule will generate a relative path on a webserver. This causes issues between operating systems since Linux uses / and Windows \ as a directory separator.

To make sure that the correct file is generated can this proxy be used to generate a filename instead of a webserver path.

« More »

Queue

Provides a queue of routers to determine the order in which they are executed.

« More »

Renderer

Renders an HTML anchor pointing to the location of the provided element.

« More »

RouterAbstract

Object containing a collection of routes.

« More »

StandardRouter

The default router for phpDocumentor.

« More »

Classes, interfaces and traits

UrlGeneratorInterface

Generates relative URLs with elements for use in the generated HTML documentation.

« More »

Classes, interfaces and traits

ClassDescriptor

« More »

ConstantDescriptor

« More »

FileDescriptor

« More »

FunctionDescriptor

Generates a relative URL with functions for use in the generated HTML documentation.

.

« More »

MethodDescriptor

Generates a relative URL with methods for use in the generated HTML documentation.

« More »

NamespaceDescriptor

« More »

PackageDescriptor

« More »

PropertyDescriptor

Generates a relative URL with properties for use in the generated HTML documentation.

« More »

QualifiedNameToUrlConverter

Service class used to convert Qualified names into URL paths for the Standard Router.

« More »

Classes, interfaces and traits

MatcherInterface

Description of the public interface to match Descriptors with a Routing rule.

« More »

Classes, interfaces and traits

Initializable

« More »

Routable

Public interface for writers who use the routing system to determine relative URLs for Descriptors.

« More »

Translatable

All writers that have items that should be translated should implement this interface

« More »

Collection

A collection of Writer objects.

In this collection we can receive writers, and if they implement the Routable interface assign the router queue that was provided to this class so that those writers can generate urls for various Descriptors.

In addition this class can also verify if all requirements for the various writers in it are met.

« More »

WriterAbstract

Base class for the actual transformation business logic (writers).

« More »

Classes, interfaces and traits

RequirementMissing

This exception should be thrown by a Writer when it is missing one of its requirements.

« More »

Classes, interfaces and traits

ExternalClassDocumentation

Reference that relates classes with a specific prefix to a URL template.

« More »

Transformations

Contains the templates and custom transformations that are applied during transformation.

« More »

Classes, interfaces and traits

Template

Configuration object for a template selection.

« More »

Classes, interfaces and traits

PostTransformationEvent

Event that happens after each individual transformation.

« More »

PostTransformEvent

Event happen right after all transformations have completed.

« More »

PreTransformationEvent

Event happening prior to each individual transformation.

« More »

PreTransformEvent

Event that happens prior to the execution of all transformations.

« More »

PreXslWriterEvent

Event launched during the Xsl Transformation of an individual output file.

If the XSL Writer loops through a resultset then this event will be thrown for each result.

« More »

WriterInitializationEvent

Abstract class representing the base elements of a phpDocumentor event.

« More »

Classes, interfaces and traits

TransformCommand

Transforms the structure file into the specified output format

This task will execute the transformation rules described in the given template (defaults to 'responsive') with the given source (defaults to output/structure.xml) and writes these to the target location (defaults to 'output').

It is possible for the user to receive additional information using the verbose option or stop additional information using the quiet option. Please take note that the quiet option also disables logging to file.

« More »

Classes, interfaces and traits

ListCommand

Lists all templates known to phpDocumentor.

« More »

Classes, interfaces and traits

BehaviourAbstract

Collection object for a set of Behaviours.

« More »

Collection

Collection object for a set of Behaviours.

« More »

Classes, interfaces and traits

Collection

Contains a collection of Templates that may be queried.

« More »

Factory

« More »

Parameter

Model representing a parameter in a template or transformation.

« More »

PathResolver

« More »

Classes, interfaces and traits

MissingDependencyException

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

« More »

UnknownWriter

Exception thrown when a template attempts to use a writer that is unknown to phpDocumentor.

« More »