vendor/sentry/sentry/src/State/HubAdapter.php line 127

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\State;
  7. use Sentry\Breadcrumb;
  8. use Sentry\CheckInStatus;
  9. use Sentry\ClientInterface;
  10. use Sentry\Event;
  11. use Sentry\EventHint;
  12. use Sentry\EventId;
  13. use Sentry\Integration\IntegrationInterface;
  14. use Sentry\MonitorConfig;
  15. use Sentry\SentrySdk;
  16. use Sentry\Severity;
  17. use Sentry\Tracing\Span;
  18. use Sentry\Tracing\Transaction;
  19. use Sentry\Tracing\TransactionContext;
  21. /**
  22.  * An implementation of {@see HubInterface} that uses {@see SentrySdk} internally
  23.  * to manage the current hub.
  24.  */
  25. final class HubAdapter implements HubInterface
  26. {
  27.     /**
  28.      * @var self|null The single instance which forwards all calls to {@see SentrySdk}
  29.      */
  30.     private static $instance;
  32.     /**
  33.      * Constructor.
  34.      */
  35.     private function __construct()
  36.     {
  37.     }
  39.     /**
  40.      * Gets the instance of this class. This is a singleton, so once initialized
  41.      * you will always get the same instance.
  42.      */
  43.     public static function getInstance(): self
  44.     {
  45.         if (null === self::$instance) {
  46.             self::$instance = new self();
  47.         }
  49.         return self::$instance;
  50.     }
  52.     /**
  53.      * {@inheritdoc}
  54.      */
  55.     public function getClient(): ?ClientInterface
  56.     {
  57.         return SentrySdk::getCurrentHub()->getClient();
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      */
  63.     public function getLastEventId(): ?EventId
  64.     {
  65.         return SentrySdk::getCurrentHub()->getLastEventId();
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function pushScope(): Scope
  72.     {
  73.         return SentrySdk::getCurrentHub()->pushScope();
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function popScope(): bool
  80.     {
  81.         return SentrySdk::getCurrentHub()->popScope();
  82.     }
  84.     /**
  85.      * {@inheritdoc}
  86.      */
  87.     public function withScope(callable $callback)
  88.     {
  89.         return SentrySdk::getCurrentHub()->withScope($callback);
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function configureScope(callable $callback): void
  96.     {
  97.         SentrySdk::getCurrentHub()->configureScope($callback);
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function bindClient(ClientInterface $client): void
  104.     {
  105.         SentrySdk::getCurrentHub()->bindClient($client);
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function captureMessage(string $message, ?Severity $level = null, ?EventHint $hint = null): ?EventId
  112.     {
  113.         return SentrySdk::getCurrentHub()->captureMessage($message, $level, $hint);
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function captureException(\Throwable $exception, ?EventHint $hint = null): ?EventId
  120.     {
  121.         return SentrySdk::getCurrentHub()->captureException($exception, $hint);
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function captureEvent(Event $event, ?EventHint $hint = null): ?EventId
  128.     {
  129.         return SentrySdk::getCurrentHub()->captureEvent($event, $hint);
  130.     }
  132.     /**
  133.      * {@inheritdoc}
  134.      */
  135.     public function captureLastError(?EventHint $hint = null): ?EventId
  136.     {
  137.         return SentrySdk::getCurrentHub()->captureLastError($hint);
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      *
  143.      * @param int|float|null $duration
  144.      */
  145.     public function captureCheckIn(string $slug, CheckInStatus $status, $duration = null, ?MonitorConfig $monitorConfig = null, ?string $checkInId = null): ?string
  146.     {
  147.         return SentrySdk::getCurrentHub()->captureCheckIn($slug, $status, $duration, $monitorConfig, $checkInId);
  148.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function addBreadcrumb(Breadcrumb $breadcrumb): bool
  154.     {
  155.         return SentrySdk::getCurrentHub()->addBreadcrumb($breadcrumb);
  156.     }
  158.     /**
  159.      * {@inheritdoc}
  160.      */
  161.     public function getIntegration(string $className): ?IntegrationInterface
  162.     {
  163.         return SentrySdk::getCurrentHub()->getIntegration($className);
  164.     }
  166.     /**
  167.      * {@inheritdoc}
  168.      *
  169.      * @param array<string, mixed> $customSamplingContext Additional context that will be passed to the {@see SamplingContext}
  170.      */
  171.     public function startTransaction(TransactionContext $context, array $customSamplingContext = []): Transaction
  172.     {
  173.         return SentrySdk::getCurrentHub()->startTransaction($context, $customSamplingContext);
  174.     }
  176.     /**
  177.      * {@inheritdoc}
  178.      */
  179.     public function getTransaction(): ?Transaction
  180.     {
  181.         return SentrySdk::getCurrentHub()->getTransaction();
  182.     }
  184.     /**
  185.      * {@inheritdoc}
  186.      */
  187.     public function getSpan(): ?Span
  188.     {
  189.         return SentrySdk::getCurrentHub()->getSpan();
  190.     }
  192.     /**
  193.      * {@inheritdoc}
  194.      */
  195.     public function setSpan(?Span $span): HubInterface
  196.     {
  197.         return SentrySdk::getCurrentHub()->setSpan($span);
  198.     }
  200.     /**
  201.      * @see https://www.php.net/manual/en/language.oop5.cloning.php#object.clone
  202.      */
  203.     public function __clone()
  204.     {
  205.         throw new \BadMethodCallException('Cloning is forbidden.');
  206.     }
  208.     /**
  209.      * @see https://www.php.net/manual/en/language.oop5.magic.php#object.wakeup
  210.      */
  211.     public function __wakeup()
  212.     {
  213.         throw new \BadMethodCallException('Unserializing instances of this class is forbidden.');
  214.     }
  215. }