DocumentInterface extends Descriptor
Base class for descriptors containing the most used options.
Table of Contents
Methods
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getDocumentNode() : DocumentNode
- getFile() : string
- getHash() : string
- getName() : string
- Returns the local name for this element.
- getTitle() : string
- setDescription() : void
- Sets a longer description for this element.
- setDocumentNode() : void
- setName() : void
- Sets the local name for this element.
Methods
getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetDocumentNode()
public
getDocumentNode() : DocumentNode
Return values
DocumentNodegetFile()
public
getFile() : string
Return values
stringgetHash()
public
getHash() : string
Return values
stringgetName()
Returns the local name for this element.
public
getName() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringsetDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
setDocumentNode()
public
setDocumentNode(DocumentNode $documentNode) : void
Parameters
- $documentNode : DocumentNode
setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string