vendor/api-platform/core/src/Elasticsearch/Metadata/Document/DocumentMetadata.php line 32

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform 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 ApiPlatform\Elasticsearch\Metadata\Document;
  16. /**
  17. * Document metadata.
  18. *
  19. * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html
  20. *
  21. * @experimental
  22. *
  23. * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  24. */
  25. final class DocumentMetadata
  26. {
  27. public const DEFAULT_TYPE = '_doc';
  29. private $index;
  30. private $type;
  32. public function __construct(string $index = null, string $type = self::DEFAULT_TYPE)
  33. {
  34. $this->index = $index;
  35. $this->type = $type;
  36. }
  38. /**
  39. * Gets a new instance with the given index.
  40. */
  41. public function withIndex(string $index): self
  42. {
  43. $metadata = clone $this;
  44. $metadata->index = $index;
  46. return $metadata;
  47. }
  49. /**
  50. * Gets the document index.
  51. */
  52. public function getIndex(): ?string
  53. {
  54. return $this->index;
  55. }
  57. /**
  58. * Gets a new instance with the given type.
  59. */
  60. public function withType(string $type): self
  61. {
  62. $metadata = clone $this;
  63. $metadata->type = $type;
  65. return $metadata;
  66. }
  68. /**
  69. * Gets the document type.
  70. */
  71. public function getType(): string
  72. {
  73. return $this->type;
  74. }
  75. }
  77. class_alias(DocumentMetadata::class, \ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\DocumentMetadata::class);