Classes, interfaces and traits

Parameter

Model representing a plugin parameter

« More »

Plugin

« More »

ServiceProvider

« More »

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 »

Classes, interfaces and traits

ExtensionInterface

An interface shared by all Twig interfaces intended for phpDocumentor.

« More »

Extension

Basic extension adding phpDocumentor specific functionality for Twig templates.

Global variables:

  • ast_node, the current $data element

Functions:

  • path(string) , converts the given relative path to be based of the projects root instead of the current directory

Filters:

  • markdown, converts the associated text from Markdown formatting to HTML.
  • trans, translates the given string
  • route, attempts to generate a URL for a given Descriptor
  • sort_desc, sorts the given objects by their Name property/getter in a descending fashion
  • sort_asc, sorts the given objects by their Name property/getter in a ascending fashion
« More »

ServiceProvider

Provides a series of services that are necessary for Twig to work with phpDocumentor.

This provider uses the translator component to fuel the twig writer and ands the to the twig writer to the writer collection. This enables transformations to mention 'twig' as their writer attribute.

« More »

Classes, interfaces and traits

Twig

A specialized writer which uses the Twig templating engine to convert templates to HTML output.

This writer support the Query attribute of a Transformation to generate multiple templates in one transformation.

The Query attribute supports a simplified version of Twig queries and will use each individual result as the 'node' global variable in the Twig template.

Example:

Suppose a Query indexes.classes is given then this writer will be invoked as many times as there are classes in the project and the 'node' global variable in twig will be filled with each individual class entry.

When using the Query attribute in the transformation it is important to use a variable in the Artifact attribute as well (otherwise the same file would be overwritten several times).

A simple example transformation line could be:

```
<transformation
    writer="twig"
    source="templates/twig/index.twig"
    artifact="index.html"/>
```

This example transformation would use this writer to transform the
index.twig template file in the twig template folder into index.html at
the destination location.
Since no Query is provided the 'node' global variable will contain
the Project Descriptor of the Object Graph.

A complex example transformation line could be:

```
<transformation
    query="indexes.classes"
    writer="twig"
    source="templates/twig/class.twig"
    artifact="{{name}}.html"/>
```

This example transformation would use this writer to transform the
class.twig template file in the twig template folder into a file with
the 'name' property for an individual class inside the Object Graph.
Since a Query *is* provided will the 'node' global variable contain a
specific instance of a class applicable to the current iteration.
« More »

Classes, interfaces and traits

ServiceProvider

Creates and binds the components for the generation of manuals.

Scrybe is a plugin that allows authors to write documentation in a markup format of their choosing and generate human-readable documentation from it.

« More »

Classes, interfaces and traits

ConverterInterface

This interface provides a basic contract between the Converters and all classes that want to use them.

« More »

ToHtmlInterface

« More »

ToLatexInterface

Interface that dictates the custom options that all converters that convert to Latex should have.

« More »

ToPdfInterface

Interface that dictates the custom options that all converters that convert to Latex should have.

« More »

BaseConverter

« More »

Factory

This factory attempts to create a converter given an input and output format and return that.

use phpDocumentor\Plugin\Scrybe\Converter\ConverterFactory; use phpDocumentor\Plugin\Scrybe\Converter\Format\Format;

$converter_factory = new ConverterFactory();
$converter = $converter_factory->get(
    Format::MARKDOWN, Format::HTML
);

« More »

Classes, interfaces and traits

Document

This is a customized RestructuredText document to register Scrybe-specific directives, roles and options.

The following directives are introduced using this class:

  • toctree, a directive used to insert table of contents into documents.
  • image, an overridden version of image that collects the assets.
  • figure, an overridden version of the figure that collects the assets.

The following roles are introduced in this class:

  • doc, a reference to an external piece of documentation.
« More »

ToHtml

Class used to convert one or more RestructuredText documents to their HTML representation.

This class uses a two-phase process to interpret and parse the RestructuredText documents, namely Discovery and Creation.

« More »

Classes, interfaces and traits

CodeBlock

Directive used to process `.

. toctree::` and insert entries from the table of contents.

This directive tries to match the file with an entry in the table of contents during the creation phase. If a document is found it will generate a mini-table of contents at that location with the depth given using the :maxdepth: parameter.

This directive is inspired by Sphinx' toctree directive.

« More »

Figure

Directive used to process `.

. figure::` and collect images as assets to be copied.

The filenames of the images are taken from the directive and added onto the assets collection during the discovery phase. These assets may then be copied to the destination location by the invoker.

« More »

Image

Directive used to process `.

. image::` and collect images as assets to be copied.

The filenames of the images are taken from the directive and added onto the assets collection during the discovery phase. These assets may then be copied to the destination location by the invoker.

« More »

Toctree

Directive used to process `.

. toctree::` and insert entries from the table of contents.

This directive tries to match the file with an entry in the table of contents during the creation phase. If a document is found it will generate a mini-table of contents at that location with the depth given using the :maxdepth: parameter.

Another option is :hidden: that will hide the toc from view while still making connections.

This directive is inspired by Sphinx' toctree directive.

« More »

Classes, interfaces and traits

Doc

The :doc: role creates a link to an external document.

For this link you can either use relative locations or an absolute notation. The absolute notation uses the documentation root as starting directory.

« More »

Classes, interfaces and traits

Creator

A specialized RestructuredText Parser/Visitor to provide assistance methods for the creation phase.

.

« More »

Discover

A specialized RestructuredText Parser/Visitor to aid in the discovery phase.

This class collects all headings and their titles and populates the TableOfContents collection.

« More »

Classes, interfaces and traits

Collection

A Collection containing all different text-bases file formats that are supported by Scrybe, their mmime-types and available extensions.

« More »

Format

Defines a conversion format in Scrybe.

« More »

Classes, interfaces and traits

FormatNotFoundException

« More »

Classes, interfaces and traits

Definition

Defines the basic properties for a single conversion process.

« More »

Factory

Factory class that is able to return a contract between an input and output format (Definition).

« More »

Classes, interfaces and traits

Assets

This collection manages which assets were found during the discovery phase.

Each asset is represented by an entry containing the path to that asset relative to the project root.

« More »

Glossary

The glossary is a collection containing a collection of terms and uses that were discovered during the discovery phase.

The key of this collection is the term that was discovered and the value is an array of locations where the term was used.

The array of locations consists of a filename as key and an array with the linenumbers where the term occurred.

Example:

array(1) { ["term"]=> array(1) { ["filename"]=> array(3) { [0]=> int(10) [1]=> int(14) [2]=> int(20) } } }

« More »

TableOfContents

This collection manages which headings were discovered during the discovery phase and stores them as entries.

« More »

Classes, interfaces and traits

BaseEntry

The Table of Contents entry provides essential information on the current entry, it's place in the structure and where it points to.

« More »

File

The Table of Contents File describes a file and the headings it contains.

A File may also contain other files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Heading

The Table of Contents File describes a headings and the Files and subentries it may contain.

A Heading may also contain files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Module

The Table of Contents module represents an independent section of the documentation.

« More »

Classes, interfaces and traits

ConverterNotFoundException

Exception indicating that a requested Converter could not be found.

« More »

Classes, interfaces and traits

TemplateInterface

« More »

Factory

A factory used to retrieve a template engine given a simplified name.

With this factory it is possible to abstract away the actual class names and provide a faux name that is suitable for configuration purposes. An additional benefit is that any plugin is able to register their own template engines if desired.

« More »

Twig

Template class to use Twig to generate templates.

« More »

Classes, interfaces and traits

BaseConvertCommand

Abstract Command class containing the scaffolding for the subsequent converting commands.

Includes additional methods to forward the output to the logging events of phpDocumentor.

« More »

ToHtmlCommand

Command used to tell the application to convert from a format to HTML.

Includes additional methods to forward the output to the logging events of phpDocumentor.

« More »

ToLatexCommand

Command used to tell the application to convert from a format to Latex.

Includes additional methods to forward the output to the logging events of phpDocumentor.

« More »

ToPdfCommand

Command used to tell the application to convert from a format to PDF.

Includes additional methods to forward the output to the logging events of phpDocumentor.

« More »

Classes, interfaces and traits

LegacyNamespaceFilter

Converts elements with underscores into a namespaced version.

This filter will examine the Name of an element and extract namespaces based on underscores in the name. Every underscore is treated as a namespace separator.

« More »

ServiceProvider

Converts all underscored class names into namespaces.

This plugin will enable a non-namespaced application to be interpreted as being namespaced for documentation purposes by separating the Classes by underscore and converting the prefix to a series of namespaces.

For example:

`My_Special_ClassName` will be transformed into the class `ClassName` with namespace `My\Special`.
« More »

Classes, interfaces and traits

LegacyNamespaceFilterTest

Tests the phpDocumentor\Plugin\LegacyNamespaceConverter\LegacyNamespaceFilter class.

« More »

Classes, interfaces and traits

ServiceProvider

« More »

Classes, interfaces and traits

Graph

Writer responsible for generating various graphs.

The Graph writer is capable of generating a Graph (as provided using the 'source' parameter) at the location provided using the artifact parameter.

Currently supported:

  • 'class', a Class Diagram Generated using GraphViz
« More »