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\Descriptor\InterfacesInterfaceInterface

Represents the public interface for an interface descriptor.

Summary

Methods
Constants
setFullyQualifiedStructuralElementName()
getFullyQualifiedStructuralElementName()
setName()
getName()
setSummary()
getSummary()
setDescription()
getDescription()
setLocation()
getPath()
getLine()
getTags()
getParent()
setParent()
setConstants()
getConstants()
setMethods()
getMethods()
getInheritedMethods()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(string  $name) : void

Sets the Fully Qualified Structural Element Name (FQSEN) for this element.

Parameters

string $name

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : string

Returns the Fully Qualified Structural Element Name (FQSEN) for this element.

Returns

string

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

string $name

getName()

getName() : string

Returns the local name for this element.

Returns

string

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a longer description for this element.

Parameters

string $description

getDescription()

getDescription() : string

Returns a longer description for this element.

Returns

string

setLocation()

setLocation(\phpDocumentor\Descriptor\FileDescriptor  $file, integer  $line) : void

Sets the file and location for this element.

Parameters

\phpDocumentor\Descriptor\FileDescriptor $file
integer $line

getPath()

getPath() : string

Returns the file location for this element relative to the project root.

Returns

string

getLine()

getLine() : integer

Returns the line number where this element may be found.

Returns

integer

setConstants()

setConstants(\phpDocumentor\Descriptor\Collection  $constants) : void

Sets the constants associated with this interface.

Parameters

\phpDocumentor\Descriptor\Collection $constants

setMethods()

setMethods(\phpDocumentor\Descriptor\Collection  $methods) : void

Sets the methods belonging to this interface.

Parameters

\phpDocumentor\Descriptor\Collection $methods

getInheritedMethods()

getInheritedMethods() : \phpDocumentor\Descriptor\Collection

Returns a list of all methods that were inherited from parent interfaces.

Returns

\phpDocumentor\Descriptor\Collection