packages/sql-semantics-postgres/resources/models/Value/IndexElemOptionsWithOptCollateAnyNameReloptionsOptAscDescOptNullsOrder_39ed7238.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\PostgreSql\Value;
6
7/**
8 * The index_elem_options 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\PostgreSql\Value\IndexElemOptionsWithOptCollateAnyNameReloptionsOptAscDescOptNullsOrder_39ed7238 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class IndexElemOptionsWithOptCollateAnyNameReloptionsOptAscDescOptNullsOrder_39ed7238 implements \SqlSemantics\Statement\Model\PostgreSql\Role\IndexElemOptionsForm
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\PostgreSql\Role\OptCollateForm $optCollate,
24        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\AnyNameForm $anyName,
25        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\ReloptionsForm $reloptions,
26        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptAscDescForm $optAscDesc,
27        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptNullsOrderForm $optNullsOrder,
28        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
29    ) {
30        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optCollate), 'The optCollate must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($anyName), 'The anyName must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($reloptions), 'The reloptions must be a generated immutable SQL value.');
33        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optAscDesc), 'The optAscDesc must be a generated immutable SQL value.');
34        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optNullsOrder), 'The optNullsOrder must be a generated immutable SQL value.');
35    }
36
37    /**
38     * Writes SQL entirely from this value's fields.
39     */
40    public function write(\SqlSemantics\Statement\Writer $writer): void
41    {
42        $writer->comments($this->comments, 0);
43        $this->optCollate->write($writer);
44        $writer->comments($this->comments, 1);
45        $this->anyName->write($writer);
46        $writer->comments($this->comments, 2);
47        $this->reloptions->write($writer);
48        $writer->comments($this->comments, 3);
49        $this->optAscDesc->write($writer);
50        $writer->comments($this->comments, 4);
51        $this->optNullsOrder->write($writer);
52    }
53
54    /**
55     * Returns a copy with a new optCollate, preserving every other field.
56     */
57    public function withOptCollate(\SqlSemantics\Statement\Model\PostgreSql\Role\OptCollateForm $optCollate): self
58    {
59        return new self($optCollate, $this->anyName, $this->reloptions, $this->optAscDesc, $this->optNullsOrder, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new anyName, preserving every other field.
64     */
65    public function withAnyName(\SqlSemantics\Statement\Model\PostgreSql\Role\AnyNameForm $anyName): self
66    {
67        return new self($this->optCollate, $anyName, $this->reloptions, $this->optAscDesc, $this->optNullsOrder, $this->comments);
68    }
69
70    /**
71     * Returns a copy with a new reloptions, preserving every other field.
72     */
73    public function withReloptions(\SqlSemantics\Statement\Model\PostgreSql\Role\ReloptionsForm $reloptions): self
74    {
75        return new self($this->optCollate, $this->anyName, $reloptions, $this->optAscDesc, $this->optNullsOrder, $this->comments);
76    }
77
78    /**
79     * Returns a copy with a new optAscDesc, preserving every other field.
80     */
81    public function withOptAscDesc(\SqlSemantics\Statement\Model\PostgreSql\Role\OptAscDescForm $optAscDesc): self
82    {
83        return new self($this->optCollate, $this->anyName, $this->reloptions, $optAscDesc, $this->optNullsOrder, $this->comments);
84    }
85
86    /**
87     * Returns a copy with a new optNullsOrder, preserving every other field.
88     */
89    public function withOptNullsOrder(\SqlSemantics\Statement\Model\PostgreSql\Role\OptNullsOrderForm $optNullsOrder): self
90    {
91        return new self($this->optCollate, $this->anyName, $this->reloptions, $this->optAscDesc, $optNullsOrder, $this->comments);
92    }
93
94    /**
95     * Returns a copy with a new comments, preserving every other field.
96     */
97    public function withComments(\SqlSemantics\Statement\Comments $comments): self
98    {
99        return new self($this->optCollate, $this->anyName, $this->reloptions, $this->optAscDesc, $this->optNullsOrder, $comments);
100    }
101}
102