phpDocumentor

DocumentDescriptor
in package
implements Descriptor uses HasName, HasDescription

FinalYes

Table of Contents

Interfaces

Descriptor
Base class for descriptors containing the most used options.

Properties

$description  : DescriptionDescriptor|null
$name  : string
$documentNode  : DocumentNode
$file  : string
$hash  : string
$title  : string

Methods

__construct()  : mixed
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getDocumentNode()  : DocumentNode
getFile()  : string
getHash()  : string
getName()  : string
Returns the name for this element.
getTitle()  : string
setDescription()  : void
Sets a description or none to inherit from a parent.
setDocumentNode()  : void

Properties

Methods

__construct()

public __construct(DocumentNode $documentNode, string $hash, string $file, string $title) : mixed
Parameters
$documentNode : DocumentNode
$hash : string
$file : string
$title : string

getDocumentNode()

public getDocumentNode() : DocumentNode
Return values
DocumentNode

getName()

Returns the name for this element.

public getName() : string
Return values
string

setDocumentNode()

public setDocumentNode(DocumentNode $documentNode) : void
Parameters
$documentNode : DocumentNode

        
On this page

Search results