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
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 \).

  • param string $namespace The namespace where this DocBlock resides in.
  • param string[] $namespaceAliases List of namespace aliases => Fully Qualified Namespace.
  • psalm-param array<string, string> $namespaceAliases
public getNamespace() : string

Returns the Qualified Namespace Name (thus without \ in front) where the associated element is in.

public getNamespaceAliases() : array

Returns a list of Qualified Namespace Names (thus without \ in front) that are imported, the keys represent the alias for the imported Namespace.

  • return string[]
  • psalm-return array<string, string>
private $namespace = NULL
  • var string The current namespace.
private $namespaceAliases = NULL
  • var string[] List of namespace aliases => Fully Qualified Namespace.
  • psalm-var array<string, string>
© 2024 Bruce Wells
Search Namespaces \ Classes