PackageInterface
extends
ElementInterface, ContainerInterface, NamespaceInterface
in
Describes the public interface for a package descriptor.
Table of Contents
- getChildren() : Collection<string|int, NamespaceDescriptor>
- getClasses() : Collection<string|int, ClassDescriptor>
- getConstants() : Collection<string|int, ConstantDescriptor>
- getDescription() : DescriptionDescriptor|null
- Returns a longer description for this element.
- getFullyQualifiedStructuralElementName() : Fqsen|null
- Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
- getFunctions() : Collection<string|int, FunctionDescriptor>
- getInterfaces() : Collection<string|int, InterfaceDescriptor>
- getLine() : int
- Returns the line number where this element may be found.
- getName() : string
- Returns the local name for this element.
- getParent() : DescriptorAbstract|Fqsen|string|null
- Returns the parent for this descriptor.
- getPath() : string
- Returns the file location for this element relative to the project root.
- getSummary() : string
- Returns the summary describing this element.
- getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
- Returns all tags associated with this element.
- getTraits() : Collection<string|int, TraitDescriptor>
- setDescription() : void
- Sets a longer description for this element.
- setFullyQualifiedStructuralElementName() : void
- Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
- setLocation() : void
- Sets the file and location for this element.
- setName() : void
- Sets the local name for this element.
- setParent() : void
- Sets the parent for this Descriptor.
- setSummary() : void
- Sets a summary describing this element.
Methods
getChildren()
public
getChildren() : Collection<string|int, NamespaceDescriptor>
Return values
Collection<string|int, NamespaceDescriptor> —getClasses()
public
getClasses() : Collection<string|int, ClassDescriptor>
Return values
Collection<string|int, ClassDescriptor> —getConstants()
public
getConstants() : Collection<string|int, ConstantDescriptor>
Return values
Collection<string|int, ConstantDescriptor> —getDescription()
Returns a longer description for this element.
public
getDescription() : DescriptionDescriptor|null
Return values
DescriptionDescriptor|null —getFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null —getFunctions()
public
getFunctions() : Collection<string|int, FunctionDescriptor>
Return values
Collection<string|int, FunctionDescriptor> —getInterfaces()
public
getInterfaces() : Collection<string|int, InterfaceDescriptor>
Return values
Collection<string|int, InterfaceDescriptor> —getLine()
Returns the line number where this element may be found.
public
getLine() : int
Tags
Return values
int —getName()
Returns the local name for this element.
public
getName() : string
Return values
string —getParent()
Returns the parent for this descriptor.
public
getParent() : DescriptorAbstract|Fqsen|string|null
Return values
DescriptorAbstract|Fqsen|string|null —getPath()
Returns the file location for this element relative to the project root.
public
getPath() : string
Return values
string —getSummary()
Returns the summary describing this element.
public
getSummary() : string
Return values
string —getTags()
Returns all tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Return values
Collection<string|int, Collection<string|int, TagDescriptor>> —getTraits()
public
getTraits() : Collection<string|int, TraitDescriptor>
Return values
Collection<string|int, TraitDescriptor> —setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
Return values
void —setFullyQualifiedStructuralElementName()
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
public
setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
- $name : Fqsen
Return values
void —setLocation()
Sets the file and location for this element.
public
setLocation(FileDescriptor $file, int $line) : void
Parameters
- $file : FileDescriptor
- $line : int
Return values
void —setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setParent()
Sets the parent for this Descriptor.
public
setParent(DescriptorAbstract|Fqsen|string|null $parent) : void
Parameters
- $parent : DescriptorAbstract|Fqsen|string|null
Return values
void —setSummary()
Sets a summary describing this element.
public
setSummary(string $summary) : void
Parameters
- $summary : string