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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The alter_list_item 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\AlterListItemWithAddOptColumnIdentFieldDefOptReferencesOptPlace_b599af0d $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class AlterListItemWithAddOptColumnIdentFieldDefOptReferencesOptPlace_b599af0d implements \SqlSemantics\Statement\Model\MySql\Role\AlterCommandListForm, \SqlSemantics\Statement\Model\MySql\Role\AlterCommandsForm, \SqlSemantics\Statement\Model\MySql\Role\AlterListForm, \SqlSemantics\Statement\Model\MySql\Role\AlterListItemForm, \SqlSemantics\Statement\Model\MySql\Role\OptAlterCommandListForm, \SqlSemantics\Statement\Model\MySql\Role\OptAlterTableActionsForm
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\OptColumnForm $optColumn,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\IdentForm $ident,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\FieldDefForm $fieldDef,
26        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptReferencesForm $optReferences,
27        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptPlaceForm $optPlace,
28        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
29    ) {
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optColumn), 'The optColumn must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($ident), 'The ident must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($fieldDef), 'The fieldDef must be a generated immutable SQL value.');
33        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optReferences), 'The optReferences must be a generated immutable SQL value.');
34        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optPlace), 'The optPlace 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        $writer->append('ADD');
44        $writer->comments($this->comments, 1);
45        $this->optColumn->write($writer);
46        $writer->comments($this->comments, 2);
47        $this->ident->write($writer);
48        $writer->comments($this->comments, 3);
49        $this->fieldDef->write($writer);
50        $writer->comments($this->comments, 4);
51        $this->optReferences->write($writer);
52        $writer->comments($this->comments, 5);
53        $this->optPlace->write($writer);
54    }
55
56    /**
57     * Returns a copy with a new optColumn, preserving every other field.
58     */
59    public function withOptColumn(\SqlSemantics\Statement\Model\MySql\Role\OptColumnForm $optColumn): self
60    {
61        return new self($optColumn, $this->ident, $this->fieldDef, $this->optReferences, $this->optPlace, $this->comments);
62    }
63
64    /**
65     * Returns a copy with a new ident, preserving every other field.
66     */
67    public function withIdent(\SqlSemantics\Statement\Model\MySql\Role\IdentForm $ident): self
68    {
69        return new self($this->optColumn, $ident, $this->fieldDef, $this->optReferences, $this->optPlace, $this->comments);
70    }
71
72    /**
73     * Returns a copy with a new fieldDef, preserving every other field.
74     */
75    public function withFieldDef(\SqlSemantics\Statement\Model\MySql\Role\FieldDefForm $fieldDef): self
76    {
77        return new self($this->optColumn, $this->ident, $fieldDef, $this->optReferences, $this->optPlace, $this->comments);
78    }
79
80    /**
81     * Returns a copy with a new optReferences, preserving every other field.
82     */
83    public function withOptReferences(\SqlSemantics\Statement\Model\MySql\Role\OptReferencesForm $optReferences): self
84    {
85        return new self($this->optColumn, $this->ident, $this->fieldDef, $optReferences, $this->optPlace, $this->comments);
86    }
87
88    /**
89     * Returns a copy with a new optPlace, preserving every other field.
90     */
91    public function withOptPlace(\SqlSemantics\Statement\Model\MySql\Role\OptPlaceForm $optPlace): self
92    {
93        return new self($this->optColumn, $this->ident, $this->fieldDef, $this->optReferences, $optPlace, $this->comments);
94    }
95
96    /**
97     * Returns a copy with a new comments, preserving every other field.
98     */
99    public function withComments(\SqlSemantics\Statement\Comments $comments): self
100    {
101        return new self($this->optColumn, $this->ident, $this->fieldDef, $this->optReferences, $this->optPlace, $comments);
102    }
103}
104