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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The key_def 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\KeyDefWithOptConstraintForeignKeySymOptIdentKeyListReferences_79d4ec54 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class KeyDefWithOptConstraintForeignKeySymOptIdentKeyListReferences_79d4ec54 implements \SqlSemantics\Statement\Model\MySql\Role\CreateFieldListForm, \SqlSemantics\Statement\Model\MySql\Role\FieldListForm, \SqlSemantics\Statement\Model\MySql\Role\FieldListItemForm, \SqlSemantics\Statement\Model\MySql\Role\KeyDefForm
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\OptConstraintForm $optConstraint,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptIdentForm $optIdent,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\KeyListForm $keyList,
26        public readonly \SqlSemantics\Statement\Model\MySql\Role\ReferencesForm $references,
27        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
28    ) {
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optConstraint), 'The optConstraint must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optIdent), 'The optIdent must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($keyList), 'The keyList must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($references), 'The references 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->optConstraint->write($writer);
42        $writer->comments($this->comments, 1);
43        $writer->append('FOREIGN');
44        $writer->comments($this->comments, 2);
45        $writer->append('KEY');
46        $writer->comments($this->comments, 3);
47        $this->optIdent->write($writer);
48        $writer->comments($this->comments, 4);
49        $writer->append('(');
50        $writer->comments($this->comments, 5);
51        $this->keyList->write($writer);
52        $writer->comments($this->comments, 6);
53        $writer->append(')');
54        $writer->comments($this->comments, 7);
55        $this->references->write($writer);
56    }
57
58    /**
59     * Returns a copy with a new optConstraint, preserving every other field.
60     */
61    public function withOptConstraint(\SqlSemantics\Statement\Model\MySql\Role\OptConstraintForm $optConstraint): self
62    {
63        return new self($optConstraint, $this->optIdent, $this->keyList, $this->references, $this->comments);
64    }
65
66    /**
67     * Returns a copy with a new optIdent, preserving every other field.
68     */
69    public function withOptIdent(\SqlSemantics\Statement\Model\MySql\Role\OptIdentForm $optIdent): self
70    {
71        return new self($this->optConstraint, $optIdent, $this->keyList, $this->references, $this->comments);
72    }
73
74    /**
75     * Returns a copy with a new keyList, preserving every other field.
76     */
77    public function withKeyList(\SqlSemantics\Statement\Model\MySql\Role\KeyListForm $keyList): self
78    {
79        return new self($this->optConstraint, $this->optIdent, $keyList, $this->references, $this->comments);
80    }
81
82    /**
83     * Returns a copy with a new references, preserving every other field.
84     */
85    public function withReferences(\SqlSemantics\Statement\Model\MySql\Role\ReferencesForm $references): self
86    {
87        return new self($this->optConstraint, $this->optIdent, $this->keyList, $references, $this->comments);
88    }
89
90    /**
91     * Returns a copy with a new comments, preserving every other field.
92     */
93    public function withComments(\SqlSemantics\Statement\Comments $comments): self
94    {
95        return new self($this->optConstraint, $this->optIdent, $this->keyList, $this->references, $comments);
96    }
97}
98