Provides information about the Context in which the DocBlock occurs that receives this context.
A DocBlock does not know of its own accord in which namespace it occurs and which namespace aliases are applicable for the block of code in which it is in. This information is however necessary to resolve Class names in tags since you can provide a short form or make use of namespace aliases.
The phpDocumentor Reflection component knows how to create this class but if you use the DocBlock parser from your own application it is possible to generate a Context class using the ContextFactory; this will analyze the file in which an associated class resides for its namespace and imports.
- see \ContextFactory::createFromClassReflector()
- see \ContextFactory::createForNamespace()
- psalm-immutable
| Methods |
| public __construct(string $namespace, array $namespaceAliases = []) Initializes the new context and normalizes all passed namespaces to be in Qualified Namespace Name (QNN)
format (without a preceding
|
| public getNamespace() : string Returns the Qualified Namespace Name (thus without |
| public getNamespaceAliases() : array Returns a list of Qualified Namespace Names (thus without
|
| Properties |
private $namespace = NULL
|
private $namespaceAliases = NULL
|