feat(query): add pinned query

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: Spamercz

doc/02-query-objects.md

@@ -546,6 +546,19 @@ new \Spameri\ElasticQuery\Query\DistanceFeature(
 );
 ```
 
+##### Pinned Query
+Promote specific document IDs above an organic query's results.
+- Class: `\Spameri\ElasticQuery\Query\Pinned`
+- [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html)
+- [Implementation](https://github.com/Spameri/ElasticQuery/blob/master/src/Query/Pinned.php)
+
+```php
+new \Spameri\ElasticQuery\Query\Pinned(
+	organic: new \Spameri\ElasticQuery\Query\ElasticMatch('content', 'elasticsearch'),
+	ids: ['1', '4', '100'],
+);
+```
+
 ##### Script Query
 Filter documents with a Painless boolean script.
 - Class: `\Spameri\ElasticQuery\Query\Script`

src/Query/Pinned.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Spameri\ElasticQuery\Query;
+
+/**
+ * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html
+ */
+class Pinned implements \Spameri\ElasticQuery\Query\LeafQueryInterface
+{
+
+	/**
+	 * @param array<int, string> $ids   IDs to pin (use either $ids or $docs).
+	 * @param array<int, array<string, string>> $docs Document references: [['_index' => ..., '_id' => ...]].
+	 */
+	public function __construct(
+		private \Spameri\ElasticQuery\Query\LeafQueryInterface $organic,
+		private array $ids = [],
+		private array $docs = [],
+	)
+	{
+		if ($ids === [] && $docs === []) {
+			throw new \Spameri\ElasticQuery\Exception\InvalidArgumentException(
+				'Pinned query requires either ids or docs to pin.',
+			);
+		}
+	}
+
+
+	public function key(): string
+	{
+		return 'pinned_' . $this->organic->key();
+	}
+
+
+	/**
+	 * @return array<string, array<string, mixed>>
+	 */
+	public function toArray(): array
+	{
+		$body = [
+			'organic' => $this->organic->toArray(),
+		];
+
+		if ($this->ids !== []) {
+			$body['ids'] = $this->ids;
+		}
+
+		if ($this->docs !== []) {
+			$body['docs'] = $this->docs;
+		}
+
+		return [
+			'pinned' => $body,
+		];
+	}
+
+}

tests/SpameriTests/ElasticQuery/Query/Pinned.phpt

@@ -0,0 +1,77 @@
+<?php declare(strict_types = 1);
+
+namespace SpameriTests\ElasticQuery\Query;
+
+require_once __DIR__ . '/../../bootstrap.php';
+
+
+class Pinned extends \Tester\TestCase
+{
+
+	private const INDEX = 'spameri_test_query_pinned';
+
+
+	public function setUp(): void
+	{
+		$ch = \curl_init();
+		\curl_setopt($ch, \CURLOPT_URL, \ELASTICSEARCH_HOST . '/' . self::INDEX);
+		\curl_setopt($ch, \CURLOPT_RETURNTRANSFER, 1);
+		\curl_setopt($ch, \CURLOPT_CUSTOMREQUEST, 'PUT');
+		\curl_setopt($ch, \CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
+
+		\curl_exec($ch);
+	}
+
+
+	public function testToArray(): void
+	{
+		$pinned = new \Spameri\ElasticQuery\Query\Pinned(
+			organic: new \Spameri\ElasticQuery\Query\ElasticMatch('content', 'elasticsearch'),
+			ids: ['1', '4', '100'],
+		);
+
+		$array = $pinned->toArray();
+
+		\Tester\Assert::same(['1', '4', '100'], $array['pinned']['ids']);
+		\Tester\Assert::true(isset($array['pinned']['organic']['match']));
+	}
+
+
+	public function testRequiresIdsOrDocs(): void
+	{
+		\Tester\Assert::exception(
+			static function (): void {
+				new \Spameri\ElasticQuery\Query\Pinned(
+					new \Spameri\ElasticQuery\Query\MatchAll(),
+				);
+			},
+			\Spameri\ElasticQuery\Exception\InvalidArgumentException::class,
+		);
+	}
+
+
+	public function testKey(): void
+	{
+		$pinned = new \Spameri\ElasticQuery\Query\Pinned(
+			organic: new \Spameri\ElasticQuery\Query\MatchAll(),
+			ids: ['1'],
+		);
+
+		\Tester\Assert::same('pinned_match_all', $pinned->key());
+	}
+
+
+	public function tearDown(): void
+	{
+		$ch = \curl_init();
+		\curl_setopt($ch, \CURLOPT_URL, \ELASTICSEARCH_HOST . '/' . self::INDEX);
+		\curl_setopt($ch, \CURLOPT_RETURNTRANSFER, 1);
+		\curl_setopt($ch, \CURLOPT_CUSTOMREQUEST, 'DELETE');
+		\curl_setopt($ch, \CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
+
+		\curl_exec($ch);
+	}
+
+}
+
+(new Pinned())->run();