Classes, interfaces and traits

Exception

Exception object for the Core Plugin.

« More »

ServiceProvider

Register all services and subservices necessary to get phpDocumentor up and running.

This provider exposes no services of its own but populates the Writer Collection with the basic writers for phpDocumentor and, for backwards compatibility, registers the service providers for Graphs, Twig and PDF to the container.

« More »

Classes, interfaces and traits

ValidationValueObject

« More »

ValidatorAbstract

Base class for DocBlock Validations.

« More »

Classes, interfaces and traits

AreAllArgumentsValid

« More »

Classes, interfaces and traits

HasPackageWithSubpackage

Validates whether a file, class, interface or trait always has a package if there is a subpackage present.

« More »

HasPackageWithSubpackageValidator

Validates whether a file, class, interface or trait always has a package if there is a subpackage present.

« More »

HasSinglePackage

Validates whether a file, class, interface or trait has not more than ! package tags.

« More »

HasSinglePackageValidator

Validates whether a file, class, interface or trait has not more than 1 package tags.

« More »

HasSingleSubpackage

Validates whether a file, class, interface or trait has not more than 1 subpackage tags.

« More »

HasSingleSubpackageValidator

Validates whether a file, class, interface or trait has not more than 1 subpackage tags.

« More »

Classes, interfaces and traits

AreAllArgumentsValid

Validates whether a function has a default return type in the docblock present.

« More »

AreAllArgumentsValidValidator

« More »

DoesArgumentNameMatchParam

Validates whether a function has a default return type in the docblock present.

« More »

DoesArgumentNameMatchParamValidator

« More »

DoesArgumentTypehintMatchParam

Checks the typehint of the argument versus the @param tag.

If the argument has no typehint we do not check anything. When multiple type are given then the typehint needs to be one of them.

« More »

DoesArgumentTypehintMatchParamValidator

« More »

DoesParamsExists

Validates whether a function has a default return type in the docblock present.

« More »

DoesParamsExistsValidator

« More »

IsArgumentInDocBlock

Validates whether a function has a missing argument in the docblock.

« More »

IsArgumentInDocBlockValidator

Validates if a Method or Function's arguments all have an accompanying param tag in the DocBlock.

« More »

IsParamTypeNotAnIdeDefault

Validates whether a function has a default param type in the docblock present.

« More »

IsParamTypeNotAnIdeDefaultValidator

Validates whether the type for a param tag with a Method or Function is not a known default.

Whenever this validator triggers then it means that someone forgot to replace the pseudo type generated by the IDE with the real type for the given parameter.

« More »

IsReturnTypeNotAnIdeDefault

Validates whether a function has a default return type in the docblock present.

« More »

IsReturnTypeNotAnIdeDefaultValidator

« More »

Classes, interfaces and traits

HasSummary

Detects whether a property has a summary, or an `@var` tag with a description.

« More »

HasSummaryValidator

Validates whether a property has a summary, or an `@var` tag with a description.

« More »

Classes, interfaces and traits

Checkstyle

Checkstyle transformation writer; generates checkstyle report

« More »

FileIo

Writer containing file system operations.

The Query part of the transformation determines the action, currently supported is:

  • copy, copies a file or directory to the destination given in $artifact
« More »

Pathfinder

« More »

Sourcecode

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

« More »

Statistics

Statistics transformation writer; generates statistic report as XML.

Generated XML structure:

 <?xml version="1.0"?>
 <phpdoc-stats version="2.4.0">
   <stat date="2014-06-02T19:26:15+02:00">
     <counters>
       <deprecated>100</deprecated>
       <errors>377</errors>
       <markers>2</markers>
     </counters>
   </stat>
 </phpdoc-stats>
« More »

Xml

Converts the structural information of phpDocumentor into an XML file.

« More »

Xsl

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

« More »

Classes, interfaces and traits

ArgumentConverter

Converter used to create an XML Element representing a method or function argument.

« More »

ConstantConverter

Converter used to create an XML Element representing the constant and its DocBlock.

In order to convert the DocBlock to its XML representation this class requires the respective converter.

« More »

DocBlockConverter

Converter used to create an XML Element representing a DocBlock and its tags.

In order to convert the tags to their XML representation this class requires the respective converter.

« More »

InterfaceConverter

Converter used to create an XML Element representing the interface and its Constants, Methods and DocBlock.

In order to convert the DocBlock to its XML representation this class requires the respective converter.

« More »

MethodConverter

Converter used to create an XML Element representing the method, its arguments and its DocBlock.

In order to convert the arguments and DocBlock to their XML representation this class requires their respective converters.

« More »

PropertyConverter

Converter used to create an XML Element representing the property and its DocBlock.

In order to convert the DocBlock to its XML representation this class requires the respective converter.

« More »

TagConverter

Creates an XML Element 'tag' and appends it to the provided parent element.

With this class we convert a TagDescriptor, or any child thereof, into an XML element that is subsequently appended onto a provided parent element (usually an XML Element that represents a DocBlock).

During the conversion process the generated XML Element is enriched with additional elements and attributes based on which tags are provided (or more specifically which methods that support).

« More »

TraitConverter

Converter used to create an XML Element representing the Trait and its Methods, Properties and DocBlock.

In order to convert the DocBlock to its XML representation this class requires the respective converter.

« More »

Classes, interfaces and traits

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 inline 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, interfaces and traits

Extension

XSLT filters that can be used inside a template.

« More »