Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Plugin\Scrybe\Converter\RestructuredTextDocument

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.

Summary

Methods
Properties
Constants
__construct()
getConverter()
getFile()
logStats()
$options
No constants found
No protected methods found
$file
$converter
N/A
No private methods found
No private properties found
N/A

Properties

$options

$options : \ezcDocumentRstOptions

Type

\ezcDocumentRstOptions

$file

$file : \phpDocumentor\Fileset\File

Fileset containing the project root and list of files in this run.

Type

\phpDocumentor\Fileset\File

$converter

$converter : \phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

Converter used to retrieve global assets from.

The converter contains global assets, such as the Table of Contents, that can be used in directives and roles.

Type

\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

Methods

__construct()

__construct(\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface  $converter, \phpDocumentor\Fileset\File  $file)

Sets the Scrybe-specific options, registers the roles and directives and loads the file.

Parameters

\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface $converter
\phpDocumentor\Fileset\File $file

getFile()

getFile() : \phpDocumentor\Fileset\File

Returns the file associated with this document.

Returns

\phpDocumentor\Fileset\File

logStats()

logStats(\Exception|null  $fatal, \Monolog\Logger  $logger) : void

Sends the errors of the given Rst document to the logger as a block.

If a fatal error occurred then this can be passed as the $fatal argument and is shown as such.

Parameters

\Exception|null $fatal
\Monolog\Logger $logger