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\PluginPlugin

Summary

Methods
Properties
Constants
__construct()
getClassName()
getParameters()
No public properties found
No constants found
No protected methods found
$className
$parameters
N/A
No private methods found
No private properties found
N/A

Properties

$className

$className : string

Type

string — class name of the plugin.

$parameters

$parameters : array<mixed,\phpDocumentor\Plugin\Parameter>

Type

array<mixed,\phpDocumentor\Plugin\Parameter> — parameters that are configured by the user

Methods

__construct()

__construct(string  $className)

Initialize the plugin configuration definition with the given class name.

Parameters

string $className

getClassName()

getClassName() : string

Returns the class name for this plugin.

Returns

string

getParameters()

getParameters() : array<mixed,\phpDocumentor\Plugin\Parameter>

Returns the parameters associated with this plugin.

Returns

array<mixed,\phpDocumentor\Plugin\Parameter>