vendor/symfony/mercure/src/Update.php line 26

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Mercure Component project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace Symfony\Component\Mercure;
  16. /**
  17.  * Represents an update to send to the hub.
  18.  *
  19.  * @see https://github.com/dunglas/mercure/blob/main/spec/mercure.md#hub
  20.  * @see https://github.com/dunglas/mercure/blob/main/update.go
  21.  *
  22.  * @author Kévin Dunglas <dunglas@gmail.com>
  23.  *
  24.  * @experimental
  25.  */
  26. final class Update
  27. {
  28.     private $topics;
  29.     private $data;
  30.     private $private;
  31.     private $id;
  32.     private $type;
  33.     private $retry;
  35.     /**
  36.      * @param string|string[] $topics
  37.      */
  38.     public function __construct($topics, string $data = '', bool $private = false, ?string $id = null, ?string $type = null, ?int $retry = null)
  39.     {
  40.         if (!\is_array($topics) && !\is_string($topics)) {
  41.             throw new \InvalidArgumentException('$topics must be an array of strings or a string.');
  42.         }
  44.         $this->topics = (array) $topics;
  45.         $this->data = $data;
  46.         $this->private = $private;
  47.         $this->id = $id;
  48.         $this->type = $type;
  49.         $this->retry = $retry;
  50.     }
  52.     public function getTopics(): array
  53.     {
  54.         return $this->topics;
  55.     }
  57.     public function getData(): string
  58.     {
  59.         return $this->data;
  60.     }
  62.     public function isPrivate(): bool
  63.     {
  64.         return $this->private;
  65.     }
  67.     public function getId(): ?string
  68.     {
  69.         return $this->id;
  70.     }
  72.     public function getType(): ?string
  73.     {
  74.         return $this->type;
  75.     }
  77.     public function getRetry(): ?int
  78.     {
  79.         return $this->retry;
  80.     }
  81. }