Plugin

Serializer\XmlRoot

("plugin")

package

Default

Methods

Initialize the plugin configuration definition with the given class name.

__construct(string $className) 

Arguments

$className

string

Returns the class name for this plugin.

getClassName() : string

Response

string

Returns the parameters associated with this plugin.

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

Response

array<mixed,\phpDocumentor\Plugin\Parameter>

Properties

class name of the plugin.

className : string
var

class name of the plugin.

todo

this serialized name is misleading, the (old) docs should be reviewed for accuracy

Serializer\Type

("string")

Serializer\XmlAttribute
Serializer\SerializedName

("path")

Type(s)

string

parameters that are configured by the user

parameters : array<mixed,\phpDocumentor\Plugin\Parameter>
Serializer\XmlList

(entry = "parameter")

Serializer\Type

("array<phpDocumentor\Plugin\Parameter>")

var

parameters that are configured by the user

Type(s)

array<mixed,\phpDocumentor\Plugin\Parameter>