vendor/sentry/sentry/src/Context/Context.php line 18

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\Context;
  7. /**
  8.  * This class stores generic information that will be attached to an event
  9.  * being sent.
  10.  *
  11.  * @author Stefano Arlandini <sarlandini@alice.it>
  12.  *
  13.  * @psalm-template T
  14.  *
  15.  * @template-implements \ArrayAccess<string, T>
  16.  * @template-implements \IteratorAggregate<string, T>
  17.  */
  18. class Context implements \ArrayAccess, \JsonSerializable, \IteratorAggregate
  19. {
  20.     /**
  21.      * This constant defines the alias used for the user context.
  22.      *
  23.      * @deprecated To be removed in 3.0 because unused
  24.      */
  25.     public const CONTEXT_USER = 'user';
  27.     /**
  28.      * This constant defines the alias used for the runtime context.
  29.      *
  30.      * @deprecated To be removed in 3.0 because unused
  31.      */
  32.     public const CONTEXT_RUNTIME = 'runtime';
  34.     /**
  35.      * This constant defines the alias used for the tags context.
  36.      *
  37.      * @deprecated To be removed in 3.0 because unused
  38.      */
  39.     public const CONTEXT_TAGS = 'tags';
  41.     /**
  42.      * This constant defines the alias used for the extra context.
  43.      *
  44.      * @deprecated To be removed in 3.0 because unused
  45.      */
  46.     public const CONTEXT_EXTRA = 'extra';
  48.     /**
  49.      * This constant defines the alias used for the server OS context.
  50.      *
  51.      * @deprecated To be removed in 3.0 because unused
  52.      */
  53.     public const CONTEXT_SERVER_OS = 'server_os';
  55.     /**
  56.      * @var array The data stored in this object
  57.      *
  58.      * @psalm-var array<string, T>
  59.      */
  60.     protected $data = [];
  62.     /**
  63.      * Constructor.
  64.      *
  65.      * @param array $data The initial data to store
  66.      *
  67.      * @psalm-param array<string, T> $data
  68.      */
  69.     public function __construct(array $data = [])
  70.     {
  71.         $this->data = $data;
  72.     }
  74.     /**
  75.      * Merges the given data with the existing one, recursively or not, according
  76.      * to the value of the `$recursive` parameter.
  77.      *
  78.      * @param array $data      The data to merge
  79.      * @param bool  $recursive Whether to merge the data recursively or not
  80.      *
  81.      * @psalm-param array<string, T> $data
  82.      */
  83.     public function merge(array $data, bool $recursive = false): void
  84.     {
  85.         $this->data = $recursive ? array_merge_recursive($this->data, $data) : array_merge($this->data, $data);
  86.     }
  88.     /**
  89.      * Sets each element of the array to the value of the corresponding key in
  90.      * the given input data.
  91.      *
  92.      * @param array $data The data to set
  93.      *
  94.      * @psalm-param array<string, T> $data
  95.      */
  96.     public function setData(array $data): void
  97.     {
  98.         foreach ($data as $index => $value) {
  99.             $this->data[$index] = $value;
  100.         }
  101.     }
  103.     /**
  104.      * Replaces all the data contained in this object with the given one.
  105.      *
  106.      * @param array $data The data to set
  107.      *
  108.      * @psalm-param array<string, T> $data
  109.      */
  110.     public function replaceData(array $data): void
  111.     {
  112.         $this->data = $data;
  113.     }
  115.     /**
  116.      * Clears the entire data contained in this object.
  117.      */
  118.     public function clear(): void
  119.     {
  120.         $this->data = [];
  121.     }
  123.     /**
  124.      * Checks whether the object is not storing any data.
  125.      */
  126.     public function isEmpty(): bool
  127.     {
  128.         return empty($this->data);
  129.     }
  131.     /**
  132.      * Returns an array representation of the data stored by the object.
  133.      *
  134.      * @psalm-return array<string, T>
  135.      */
  136.     public function toArray(): array
  137.     {
  138.         return $this->data;
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function offsetExists($offset): bool
  145.     {
  146.         return isset($this->data[$offset]) || \array_key_exists($offset, $this->data);
  147.     }
  149.     /**
  150.      * {@inheritdoc}
  151.      */
  152.     public function offsetGet($offset)
  153.     {
  154.         return $this->data[$offset];
  155.     }
  157.     /**
  158.      * {@inheritdoc}
  159.      */
  160.     public function offsetSet($offset, $value): void
  161.     {
  162.         $this->data[$offset] = $value;
  163.     }
  165.     /**
  166.      * {@inheritdoc}
  167.      */
  168.     public function offsetUnset($offset): void
  169.     {
  170.         unset($this->data[$offset]);
  171.     }
  173.     /**
  174.      * {@inheritdoc}
  175.      *
  176.      * @psalm-return array<string, T>
  177.      */
  178.     public function jsonSerialize(): array
  179.     {
  180.         return $this->toArray();
  181.     }
  183.     /**
  184.      * {@inheritdoc}
  185.      */
  186.     public function getIterator(): \Traversable
  187.     {
  188.         return new \ArrayIterator($this->data);
  189.     }
  190. }