packages/sql-semantics-mysql/resources/models/Value/AlterListItemWithRenameKeyOrIndexFieldIdentToSymFieldIdent_4d31222a.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\AlterListItemWithRenameKeyOrIndexFieldIdentToSymFieldIdent_4d31222a $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class AlterListItemWithRenameKeyOrIndexFieldIdentToSymFieldIdent_4d31222a 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\KeyOrIndexForm $keyOrIndex,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\FieldIdentForm $fieldIdent,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\FieldIdentForm $fieldIdent2,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($keyOrIndex), 'The keyOrIndex must be a generated immutable SQL value.');
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($fieldIdent), 'The fieldIdent must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($fieldIdent2), 'The fieldIdent2 must be a generated immutable SQL value.');
31    }
32
33    /**
34     * Writes SQL entirely from this value's fields.
35     */
36    public function write(\SqlSemantics\Statement\Writer $writer): void
37    {
38        $writer->comments($this->comments, 0);
39        $writer->append('RENAME');
40        $writer->comments($this->comments, 1);
41        $this->keyOrIndex->write($writer);
42        $writer->comments($this->comments, 2);
43        $this->fieldIdent->write($writer);
44        $writer->comments($this->comments, 3);
45        $writer->append('TO');
46        $writer->comments($this->comments, 4);
47        $this->fieldIdent2->write($writer);
48    }
49
50    /**
51     * Returns a copy with a new keyOrIndex, preserving every other field.
52     */
53    public function withKeyOrIndex(\SqlSemantics\Statement\Model\MySql\Role\KeyOrIndexForm $keyOrIndex): self
54    {
55        return new self($keyOrIndex, $this->fieldIdent, $this->fieldIdent2, $this->comments);
56    }
57
58    /**
59     * Returns a copy with a new fieldIdent, preserving every other field.
60     */
61    public function withFieldIdent(\SqlSemantics\Statement\Model\MySql\Role\FieldIdentForm $fieldIdent): self
62    {
63        return new self($this->keyOrIndex, $fieldIdent, $this->fieldIdent2, $this->comments);
64    }
65
66    /**
67     * Returns a copy with a new fieldIdent2, preserving every other field.
68     */
69    public function withFieldIdent2(\SqlSemantics\Statement\Model\MySql\Role\FieldIdentForm $fieldIdent2): self
70    {
71        return new self($this->keyOrIndex, $this->fieldIdent, $fieldIdent2, $this->comments);
72    }
73
74    /**
75     * Returns a copy with a new comments, preserving every other field.
76     */
77    public function withComments(\SqlSemantics\Statement\Comments $comments): self
78    {
79        return new self($this->keyOrIndex, $this->fieldIdent, $this->fieldIdent2, $comments);
80    }
81}
82