Functions

Tries to find the autoloader relative to ththis file and return its path.

findAutoloader() : string

Exceptions

\RuntimeException if the autoloader could not be found.

Returns

stringthe path of the autoloader.

Classes and interfaces

Application

Application class for phpDocumentor.

« More »

Bootstrap

This class provides a bootstrap for all application who wish to interface with phpDocumentor.

« More »

Installer

Facilitates the installation of phpDocumentor.

« More »

PharCompiler

The Compiler class compiles the phpDocumentor utility.

« More »

Classes and interfaces

Command

Base command for phpDocumentor commands.

« More »

ConfigurableCommand

Base class for commands that may make use of the configuration.

« More »

Classes and interfaces

GenerateCommand

Generates a skeleton plugin.

« More »

Classes and interfaces

ParseCommand

Parses the given source code and creates a structure file.

« More »

RunCommand

Parse and transform the given directory (-d|-f) to the given location (-t).

« More »

TransformCommand

Transforms the structure file into the specified output format

« More »

Classes and interfaces

GenerateCommand

Generates a skeleton template.

« More »

ListCommand

Generates a skeleton template.

« More »

PackageCommand

Generates a packages the template into a PEAR package.

« More »
This namespace does not contain any documentable elements

Classes and interfaces

ProgressHelper

The Progress class providers helpers to display progress output.

« More »

Classes and interfaces

ArgvInput

Argv input for the Console component of Symfony adapted to phpDocumentor.

« More »

Classes and interfaces

DebugEvent

Event representing some debugging information for phpDocumentor.

« More »

Dispatcher

Event Dispatching class.

« More »

EventAbstract

Abstract class representing the base elements of a phpDocumentor event.

« More »

LogEvent

Logging event for phpDocumentor where information is output to the log or stdout.

« More »

Classes and interfaces

Exception

Provides the basic exception for the parser package.

« More »

Parser

Class responsible for parsing the given file or files to the intermediate structure file.

« More »

ParserAbstract

Layer superclass for \phpDocumentor\Parser Component.

« More »

Classes and interfaces

LogEvent

Event for capturing events during the parsing of a file.

« More »

PreFileEvent

Event thrown before the parsing of an individual file.

« More »

Classes and interfaces

ExporterAbstract

Class responsible for writing the results of the Reflection of a single source file to disk.

« More »

Classes and interfaces

ArgumentExporter

Exports an argument element into the given DOMElement.

« More »

ClassExporter

Exports a class element's attributes and properties to a child of the given parent.

« More »

ConstantExporter

Exports a constant element's attributes and properties to a child of the given parent.

« More »

DocBlockExporter

Exports the details of an elements' DocBlock to XML.

« More »

DocBlockTagExporter

Exports the information from a DocBlock's Tag.

« More »

FileExporter

Exports the collected reflection information of a file to the given DOMElement.

« More »

FunctionExporter

Exports the given reflected file to a DOMElement.

« More »

IncludeExporter

Exports the details of an Include element to XML.

« More »

InterfaceExporter

Exports the details of an interface to XML.

« More »

MethodExporter

Exports a method definition to the given DOMElement.

« More »

PropertyExporter

Exports a property definition to the given DOMElement.

« More »

VariableExporter

Exports the details of a variable to XML.

« More »

Xml

Class responsible for writing the results of the Reflection to a single Intermediate Structure file in XML.

« More »

Classes and interfaces

Exception

Base exception for plugins.

« More »

ListenerAbstract

Base class for plugin event listeners.

« More »

Manager

This class loads the plugins from the configuration and initializes them.

« More »

Plugin

This class represents a single plugin with all it's options and properties.

« More »

PluginAbstract

Layer superclass for the Plugin Component; contains all event dispatching code.

« More »

Classes and interfaces

Exception

Exception object for the Core Plugin.

« More »

Listener

Listener for the Core Plugin.

« More »

Log

Struct to hold severity levels when logging.

« More »
This namespace does not contain any documentable elements
This namespace does not contain any documentable elements
This namespace does not contain any documentable elements

Classes and interfaces

Covers

Definition for the @covers tag; expands the class mentioned in the refers attribute.

« More »

Definition

Generic Definition which adds the basic tag information to the structure file.

« More »

Doctrine

Definition for all Doctrine tags to explode them into subcomponents so they can be better processed in the transformation.

« More »

Legacy

Definition for tags that despite having their own descriptions in the reflection (different from the content as a whole), need to be exported as if they didn't, in order to maintain backwards compatibility.

« More »

Method

Definition for the @param tag; adds a attribute called `variable`.

« More »

Param

Definition for the @param tag; adds a attribute called `variable`.

« More »

See

Definition for the @see tag; expands the class mentioned in the refers attribute.

« More »

Uses

Definition for the @uses tag; expands the class mentioned in the refers attribute.

« More »

Classes and interfaces

ClassValidator

This class is responsible for validating the class docbloc

« More »

DeprecatedValidator

This class is responsible for validating which tags are deprecated as defined in /src/phpDocumentor/Plugin/Core/plugin.xml

« More »

FileValidator

This class is responsible for validating the file docbloc

« More »

FunctionValidator

This class is responsible for validating a function's docblock.

« More »

MethodValidator

This class is responsible for validating the method doc block

« More »

PropertyValidator

This class is responsible for validating a properties docblock.

« More »

RequiredValidator

This class is responsible for validating which tags are required as defined in /src/phpDocumentor/Plugin/Core/plugin.xml

« More »

ValidatorAbstract

Base class for DocBlock Validations.

« More »
This namespace does not contain any documentable elements

Classes and interfaces

AddLinkInformation

Behaviour that adds generated path information on the File elements.

« More »

GeneratePaths

Behaviour that adds generated path information on the File elements.

« More »

Inherit

Behaviour that runs through all elements and inherit base information when necessary.

« More »
This namespace does not contain any documentable elements

Classes and interfaces

ClassNode

Responsible for adding inheritance behaviour to an individual class.

« More »

ConstantNode

Responsible for adding inheritance behaviour to an individual constant.

« More »

DocBlockNode

Wrapper class around a DOMElement containing a DocBlock definition.

« More »

MethodNode

Responsible for adding inheritance behaviour to an individual method.

« More »

NodeAbstract

Base class for adding inheritance to an element.

« More »

PropertyNode

Responsible for adding inheritance behaviour to an individual property.

« More »

Classes and interfaces

AuthorTag

Behaviour that links to email addresses in the @author tag.

« More »

CoversTag

Behaviour that adds support for the @covers tag

« More »

IgnoreTag

Behaviour that adds support for @ignore tag.

« More »

InternalTag

Behaviour that adds support for @internal tag.

« More »

LicenseTag

Behaviour that enables links to URLs in the @license tag.

« More »

MethodTag

Behaviour that adds support for the @method tag

« More »

ParamTag

Behaviour that adds support for the @param tags.

« More »

PropertyTag

Behaviour that adds support for the property tag

« More »

ReturnTag

Behaviour that adds support for the return tag

« More »

UsesTag

Behaviour that adds support for the uses tag

« More »

VarTag

Behaviour that adds support for the @method tag

« More »

Classes and interfaces

Checkstyle

Checkstyle transformation writer; generates checkstyle report

« More »

FileIo

Writer containing file system operations.

« More »

Graph

Class diagram generator.

« More »

Pdf

A PDF writer which uses wkhtmltopdf to convert a single HTML file to PDF.

« More »

Sourcecode

Sourcecode transformation writer; generates syntax highlighted source files in a destination's subfolder.

« More »

Xsl

XSL transformation writer; generates static HTML out of the structure and XSL templates.

« More »

Classes and interfaces

Exception

Provides the basic exception for the parser package.

« More »

Template

Model representing a loaded template.

« More »

Transformation

Class representing a single Transformation.

« More »

Transformer

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

« More »

TransformerAbstract

Layer superclass for \phpDocumentor\Transformer Component.

« More »

Classes and interfaces

BehaviourAbstract

Collection object for a set of Behaviours.

« More »

Collection

Collection object for a set of Behaviours.

« More »

Classes and interfaces

PostTransformEvent

Event happen right after all transformations have completed.

« More »

PostTransformationEvent

Event that happens after each individual transformation.

« More »

PreTransformEvent

Event that happens prior to the execution of all transformations.

« More »

PreTransformationEvent

Event happening prior to each individual transformation.

« More »

PreXslWriterEvent

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

« More »

Classes and interfaces

Collection

Collection object for a set of Writers.

« More »

WriterAbstract

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

« More »