packages/sql-semantics-mysql/resources/models/Value/KeyPartWithExpressionWithExprOptOrderingDirection_23caebd6.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The key_part_with_expression SQL value; generated by bin/build-models.php.
9 *
10 * @visibility public
11 * @example Accept a structured SQL value
12 *     $write = static fn (\SqlSemantics\Statement\Model\MySql\Value\KeyPartWithExpressionWithExprOptOrderingDirection_23caebd6 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class KeyPartWithExpressionWithExprOptOrderingDirection_23caebd6 implements \SqlSemantics\Statement\Model\MySql\Role\KeyListWithExpressionForm, \SqlSemantics\Statement\Model\MySql\Role\KeyPartWithExpressionForm
16{
17    use \SqlSemantics\Statement\Assertion;
18
19    /**
20     * Supplies the SQL values of this form; comments are kept by the position of the symbol each precedes.
21     */
22    public function __construct(
23        public readonly \SqlSemantics\Statement\Model\MySql\Role\ExprForm $expr,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptOrderingDirectionForm $optOrderingDirection,
25        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
26    ) {
27        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($expr), 'The expr must be a generated immutable SQL value.');
28        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optOrderingDirection), 'The optOrderingDirection must be a generated immutable SQL value.');
29    }
30
31    /**
32     * Writes SQL entirely from this value's fields.
33     */
34    public function write(\SqlSemantics\Statement\Writer $writer): void
35    {
36        $writer->comments($this->comments, 0);
37        $writer->append('(');
38        $writer->comments($this->comments, 1);
39        $this->expr->write($writer);
40        $writer->comments($this->comments, 2);
41        $writer->append(')');
42        $writer->comments($this->comments, 3);
43        $this->optOrderingDirection->write($writer);
44    }
45
46    /**
47     * Returns a copy with a new expr, preserving every other field.
48     */
49    public function withExpr(\SqlSemantics\Statement\Model\MySql\Role\ExprForm $expr): self
50    {
51        return new self($expr, $this->optOrderingDirection, $this->comments);
52    }
53
54    /**
55     * Returns a copy with a new optOrderingDirection, preserving every other field.
56     */
57    public function withOptOrderingDirection(\SqlSemantics\Statement\Model\MySql\Role\OptOrderingDirectionForm $optOrderingDirection): self
58    {
59        return new self($this->expr, $optOrderingDirection, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new comments, preserving every other field.
64     */
65    public function withComments(\SqlSemantics\Statement\Comments $comments): self
66    {
67        return new self($this->expr, $this->optOrderingDirection, $comments);
68    }
69}
70