Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. BaggageInterface.php

interface BaggageInterface

Hierarchy

  • interface \OpenTelemetry\Context\ImplicitContextKeyedInterface
    • interface \OpenTelemetry\API\Baggage\BaggageInterface extends \OpenTelemetry\Context\ImplicitContextKeyedInterface

Expanded class hierarchy of BaggageInterface

All classes that implement BaggageInterface

See also

https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6…

File

vendor/open-telemetry/api/Baggage/BaggageInterface.php, line 14

Namespace

OpenTelemetry\API\Baggage
View source
interface BaggageInterface extends ImplicitContextKeyedInterface {
    
    /**
     * Returns the {@see API\BaggageInterface} from the provided *$context*,
     * falling back on {@see API\BaggageInterface::getEmpty()} if there is no baggage in the provided context.
     */
    public static function fromContext(ContextInterface $context) : API\BaggageInterface;
    
    /**
     * Returns a new empty {@see API\BaggageBuilderInterface}.
     */
    public static function getBuilder() : API\BaggageBuilderInterface;
    
    /**
     * Returns the current {@see Baggage} from the current {@see ContextInterface},
     * falling back on {@see API\BaggageInterface::getEmpty()} if there is no baggage in the current context.
     */
    public static function getCurrent() : API\BaggageInterface;
    
    /**
     * Returns a new {@see API\BaggageInterface} with no entries.
     */
    public static function getEmpty() : API\BaggageInterface;
    
    /**
     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6.1/specification/baggage/api.md#get-value
     */
    public function getEntry(string $key) : ?API\Entry;
    
    /**
     * Returns the value from the {@see API\Entry} with the provided *key*.
     * @see getEntry
     *
     * @return mixed
     */
    public function getValue(string $key);
    
    /**
     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6.1/specification/baggage/api.md#get-all-values
     */
    public function getAll() : iterable;
    public function isEmpty() : bool;
    
    /**
     * Returns a new {@see API\BaggageBuilderInterface} pre-initialized with the contents of `$this`.
     */
    public function toBuilder() : API\BaggageBuilderInterface;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
BaggageInterface::fromContext public static function Returns the {falling back on { 1
BaggageInterface::getAll public function 1
BaggageInterface::getBuilder public static function Returns a new empty { 1
BaggageInterface::getCurrent public static function Returns the current {falling back on { 1
BaggageInterface::getEmpty public static function Returns a new { 1
BaggageInterface::getEntry public function 1
BaggageInterface::getValue public function Returns the value from the { 1
BaggageInterface::isEmpty public function 1
BaggageInterface::toBuilder public function Returns a new { 1
ImplicitContextKeyedInterface::activate public function Adds `$this` to the {the new {
{
This method is equivalent to `Context::getCurrent().with($value).activate();`.
3
ImplicitContextKeyedInterface::storeInContext public function Returns a new { 3

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal