LocalRootSpan.php

<?php

declare (strict_types=1);
namespace OpenTelemetry\API\Trace;

use OpenTelemetry\Context\Context;
use OpenTelemetry\Context\ContextInterface;
use OpenTelemetry\Context\ContextKeyInterface;

/**
 * @experimental
 */
class LocalRootSpan {
    
    /**
     * Retrieve the local root span. This is the root-most active span which has
     * a remote or invalid parent.
     * If there is no active local root span, then an invalid span is returned.
     * @experimental
     */
    public static function current() : SpanInterface {
        return self::fromContext(Context::getCurrent());
    }
    
    /**
     * Retrieve the local root span from a Context.
     * @experimental
     */
    public static function fromContext(ContextInterface $context) : SpanInterface {
        return $context->get(self::key()) ?? Span::getInvalid();
    }
    
    /**
     * @internal
     */
    public static function store(ContextInterface $context, SpanInterface $span) : ContextInterface {
        return $context->with(self::key(), $span);
    }
    
    /**
     * @internal
     */
    public static function key() : ContextKeyInterface {
        static $key;
        return $key ??= Context::createKey(self::class);
    }
    
    /**
     * @internal
     */
    public static function isLocalRoot(ContextInterface $parentContext) : bool {
        $spanContext = Span::fromContext($parentContext)->getContext();
        return !$spanContext->isValid() || $spanContext->isRemote();
    }

}