packages/sql-semantics-postgres/resources/models/Value/IndexElemOptionsWithOptCollateOptQualifiedNameOptAscDescOptNullsOrder_e9482006.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\IndexElemOptionsWithOptCollateOptQualifiedNameOptAscDescOptNullsOrder_e9482006 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class IndexElemOptionsWithOptCollateOptQualifiedNameOptAscDescOptNullsOrder_e9482006 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\OptQualifiedNameForm $optQualifiedName,
25        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptAscDescForm $optAscDesc,
26        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptNullsOrderForm $optNullsOrder,
27        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
28    ) {
29        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optCollate), 'The optCollate must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optQualifiedName), 'The optQualifiedName must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optAscDesc), 'The optAscDesc must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optNullsOrder), 'The optNullsOrder must be a generated immutable SQL value.');
33    }
34
35    /**
36     * Writes SQL entirely from this value's fields.
37     */
38    public function write(\SqlSemantics\Statement\Writer $writer): void
39    {
40        $writer->comments($this->comments, 0);
41        $this->optCollate->write($writer);
42        $writer->comments($this->comments, 1);
43        $this->optQualifiedName->write($writer);
44        $writer->comments($this->comments, 2);
45        $this->optAscDesc->write($writer);
46        $writer->comments($this->comments, 3);
47        $this->optNullsOrder->write($writer);
48    }
49
50    /**
51     * Returns a copy with a new optCollate, preserving every other field.
52     */
53    public function withOptCollate(\SqlSemantics\Statement\Model\PostgreSql\Role\OptCollateForm $optCollate): self
54    {
55        return new self($optCollate, $this->optQualifiedName, $this->optAscDesc, $this->optNullsOrder, $this->comments);
56    }
57
58    /**
59     * Returns a copy with a new optQualifiedName, preserving every other field.
60     */
61    public function withOptQualifiedName(\SqlSemantics\Statement\Model\PostgreSql\Role\OptQualifiedNameForm $optQualifiedName): self
62    {
63        return new self($this->optCollate, $optQualifiedName, $this->optAscDesc, $this->optNullsOrder, $this->comments);
64    }
65
66    /**
67     * Returns a copy with a new optAscDesc, preserving every other field.
68     */
69    public function withOptAscDesc(\SqlSemantics\Statement\Model\PostgreSql\Role\OptAscDescForm $optAscDesc): self
70    {
71        return new self($this->optCollate, $this->optQualifiedName, $optAscDesc, $this->optNullsOrder, $this->comments);
72    }
73
74    /**
75     * Returns a copy with a new optNullsOrder, preserving every other field.
76     */
77    public function withOptNullsOrder(\SqlSemantics\Statement\Model\PostgreSql\Role\OptNullsOrderForm $optNullsOrder): self
78    {
79        return new self($this->optCollate, $this->optQualifiedName, $this->optAscDesc, $optNullsOrder, $this->comments);
80    }
81
82    /**
83     * Returns a copy with a new comments, preserving every other field.
84     */
85    public function withComments(\SqlSemantics\Statement\Comments $comments): self
86    {
87        return new self($this->optCollate, $this->optQualifiedName, $this->optAscDesc, $this->optNullsOrder, $comments);
88    }
89}
90