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\DescriptorPackageDescriptor

Represents the package for a class, trait, interface or file.

Summary

Methods
Properties
Constants
__construct()
setParent()
getParent()
setClasses()
getClasses()
setConstants()
getConstants()
setFunctions()
getFunctions()
setInterfaces()
getInterfaces()
setChildren()
getChildren()
setTraits()
getTraits()
setFullyQualifiedStructuralElementName()
getFullyQualifiedStructuralElementName()
setName()
getName()
setNamespace()
getNamespace()
setSummary()
getSummary()
setDescription()
getDescription()
setLocation()
getPath()
getFile()
setFile()
getLine()
setLine()
setTags()
getTags()
setPackage()
getPackage()
getAuthor()
getVersion()
getCopyright()
isDeprecated()
setErrors()
getErrors()
__call()
__toString()
getInheritedElement()
No public properties found
No constants found
No protected methods found
$parent
$children
$functions
$constants
$classes
$interfaces
$traits
$fqsen
$name
$namespace
$package
$summary
$description
$fileDescriptor
$line
$tags
$errors
$inheritedElement
N/A
No private methods found
No private properties found
N/A

Properties

$fqsen

$fqsen : string

Type

string — Fully Qualified Structural Element Name; the FQCN including method, property of constant name

$name

$name : string

Type

string — The local name for this element

$package

$package : string

Type

string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : string

Type

string — A more extensive description of this element.

$line

$line : integer

Type

integer — The line number on which this element occurs.

Methods

__construct()

__construct()

Initializes this descriptor.

setClasses()

setClasses(\phpDocumentor\Descriptor\Collection  $classes) : void

Sets a list of all classes in this project.

Parameters

\phpDocumentor\Descriptor\Collection $classes

setConstants()

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

Sets a list of all constants in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection $constants

setFunctions()

setFunctions(\phpDocumentor\Descriptor\Collection  $functions) : void

Sets a list of all functions in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection $functions

setInterfaces()

setInterfaces(\phpDocumentor\Descriptor\Collection  $interfaces) : void

Sets a list of all interfaces in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection $interfaces

setChildren()

setChildren(\phpDocumentor\Descriptor\Collection  $children) : void

Sets a list of all child namespaces in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection $children

getChildren()

getChildren() : \phpDocumentor\Descriptor\Collection

Returns a list of all namespaces contained in this namespace and its children.

Returns

\phpDocumentor\Descriptor\Collection

setTraits()

setTraits(\phpDocumentor\Descriptor\Collection  $traits) : void

Sets a list of all traits contained in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection $traits

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

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string|null

Returns the namespace for this element or null if none is attached.

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor|string|null

setSummary()

setSummary(string  $summary) : void

Sets the summary describing this element in short.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary which describes this element.

This method will automatically attempt to inherit the parent's summary if this one has none.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a description for this element.

Parameters

string $description

getDescription()

getDescription() : string

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

string

setLocation()

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

Sets the file and linenumber where this element is at.

Parameters

\phpDocumentor\Descriptor\FileDescriptor $file
integer $line

getPath()

getPath() : string

Returns the path to the file containing this element relative to the project's root.

Returns

string

getFile()

getFile() : \phpDocumentor\Descriptor\FileDescriptor|null

Returns the file in which this element resides or null in case the element is not bound to a file.

.

Returns

\phpDocumentor\Descriptor\FileDescriptor|null

getLine()

getLine() : integer

Returns the line number where the definition for this element can be found.

Returns

integer

setLine()

setLine(integer  $lineNumber) : void

Sets the line number for this element's location in the source file.

Parameters

integer $lineNumber

isDeprecated()

isDeprecated() : boolean

Checks whether this element is deprecated.

Returns

boolean

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection  $errors) : void

Sets a list of all errors associated with this element.

Parameters

\phpDocumentor\Descriptor\Collection $errors

__call()

__call(string  $name, array<mixed,mixed>  $arguments) : \phpDocumentor\Descriptor\Collection|null

Dynamically constructs a set of getters to retrieve tag (collections) with.

Important: __call() is not a fast method of access; it is preferred to directly use the getTags() collection. This interface is provided to allow for uniform and easy access to certain tags.

Parameters

string $name
array<mixed,mixed> $arguments

Returns

\phpDocumentor\Descriptor\Collection|null

__toString()

__toString() : string

Represents this object by its unique identifier, the Fully Qualified Structural Element Name.

Returns

string