feat: AST-based query runner

Co-Authored-By: Roman Steiner <roman@toastlab.ch>

Author: distantnative

src/Query/AST/ArgumentListNode.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Represents a list of (method) arguments
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class ArgumentListNode extends Node
+{
+	public function __construct(
+		public array $arguments = []
+	) {
+	}
+
+	public function resolve(Visitor $visitor): array|string
+	{
+		// Resolve each argument
+		$arguments = array_map(
+			fn ($argument) => $argument->resolve($visitor),
+			$this->arguments
+		);
+
+		// Keep as array or convert to string
+		// depending on the visitor type
+		return $visitor->argumentList($arguments);
+	}
+}

src/Query/AST/ArrayListNode.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class ArrayListNode extends Node
+{
+	public function __construct(
+		public array $elements,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): array|string
+	{
+		// Resolve each array element
+		$elements = array_map(
+			fn ($element) => $element->resolve($visitor),
+			$this->elements
+		);
+
+		// Keep as array or convert to string
+		// depending on the visitor type
+		return $visitor->arrayList($elements);
+	}
+}

src/Query/AST/ClosureNode.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class ClosureNode extends Node
+{
+	/**
+	 * @param string[] $arguments The arguments names
+	 */
+	public function __construct(
+		public array $arguments,
+		public Node $body,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->closure($this);
+	}
+}

src/Query/AST/CoalesceNode.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class CoalesceNode extends Node
+{
+	public function __construct(
+		public Node $left,
+		public Node $right,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->coalescence(
+			left:  $this->left->resolve($visitor),
+			right: $this->right->resolve($visitor)
+		);
+	}
+}

src/Query/AST/GlobalFunctionNode.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class GlobalFunctionNode extends Node
+{
+	public function __construct(
+		public string $name,
+		public ArgumentListNode $arguments,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->function(
+			name:      $this->name,
+			arguments: $this->arguments->resolve($visitor)
+		);
+	}
+}

src/Query/AST/LiteralNode.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Represents literal values (e.g. string, int, bool)
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class LiteralNode extends Node
+{
+	public function __construct(
+		public mixed $value,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->literal($this->value);
+	}
+}

src/Query/AST/MemberAccessNode.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Represents the access (e.g. method call) on a node
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class MemberAccessNode extends Node
+{
+	public function __construct(
+		public Node $object,
+		public Node $member,
+		public ArgumentListNode|null $arguments = null,
+		public bool $nullSafe = false,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->memberAccess(
+			object:    $this->object->resolve($visitor),
+			member:    $this->member->resolve($visitor),
+			arguments: $this->arguments?->resolve($visitor),
+			nullSafe:  $this->nullSafe
+		);
+	}
+}

src/Query/AST/Node.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Basic query node representation
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ *
+ * @codeCoverageIgnore
+ */
+abstract class Node
+{
+	abstract public function resolve(Visitor $visitor);
+}

src/Query/AST/TernaryNode.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Represents a ternary condition
+ * with a value for when the condition is true
+ * and another value for when the condition is false
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class TernaryNode extends Node
+{
+	public function __construct(
+		public Node $condition,
+		public Node $false,
+		public Node|null $true = null
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->ternary(
+			condition: $this->condition->resolve($visitor),
+			true:      $this->true?->resolve($visitor),
+			false:     $this->false->resolve($visitor)
+		);
+	}
+}

src/Query/AST/VariableNode.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Kirby\Query\AST;
+
+use Kirby\Query\Visitors\Visitor;
+
+/**
+ * Represents a variable (e.g. an object)
+ *
+ * @package   Kirby Query
+ * @author    Roman Steiner <roman@toastlab.ch>,
+ *            Nico Hoffmann <nico@getkirby.com>
+ * @link      https://getkirby.com
+ * @license   https://opensource.org/licenses/MIT
+ * @since     5.1.0
+ */
+class VariableNode extends Node
+{
+	public function __construct(
+		public string $name,
+	) {
+	}
+
+	public function resolve(Visitor $visitor): mixed
+	{
+		return $visitor->variable($this->name);
+	}
+}