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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The describe 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\DescribeWithDescribeCommandOptExtendedDescribeExplanableCommand_9fa92e8e $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class DescribeWithDescribeCommandOptExtendedDescribeExplanableCommand_9fa92e8e implements \SqlSemantics\Statement\Model\MySql\Role\DescribeForm, \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtForm, \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtInnerForm, \SqlSemantics\Statement\Model\MySql\Role\SpProcStmtForm, \SqlSemantics\Statement\Model\MySql\Role\SpProcStmtStatementForm, \SqlSemantics\Statement\Model\MySql\Role\StatementForm, \SqlSemantics\Statement\Model\MySql\Role\StoredRoutineBodyForm, \SqlSemantics\Statement\Model\MySql\Role\VerbClauseForm
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\DescribeCommandForm $describeCommand,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptExtendedDescribeForm $optExtendedDescribe,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\ExplanableCommandForm $explanableCommand,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($describeCommand), 'The describeCommand must be a generated immutable SQL value.');
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optExtendedDescribe), 'The optExtendedDescribe must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($explanableCommand), 'The explanableCommand 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        $this->describeCommand->write($writer);
40        $writer->comments($this->comments, 1);
41        $this->optExtendedDescribe->write($writer);
42        $writer->comments($this->comments, 2);
43        $this->explanableCommand->write($writer);
44    }
45
46    /**
47     * Returns a copy with a new describeCommand, preserving every other field.
48     */
49    public function withDescribeCommand(\SqlSemantics\Statement\Model\MySql\Role\DescribeCommandForm $describeCommand): self
50    {
51        return new self($describeCommand, $this->optExtendedDescribe, $this->explanableCommand, $this->comments);
52    }
53
54    /**
55     * Returns a copy with a new optExtendedDescribe, preserving every other field.
56     */
57    public function withOptExtendedDescribe(\SqlSemantics\Statement\Model\MySql\Role\OptExtendedDescribeForm $optExtendedDescribe): self
58    {
59        return new self($this->describeCommand, $optExtendedDescribe, $this->explanableCommand, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new explanableCommand, preserving every other field.
64     */
65    public function withExplanableCommand(\SqlSemantics\Statement\Model\MySql\Role\ExplanableCommandForm $explanableCommand): self
66    {
67        return new self($this->describeCommand, $this->optExtendedDescribe, $explanableCommand, $this->comments);
68    }
69
70    /**
71     * Returns a copy with a new comments, preserving every other field.
72     */
73    public function withComments(\SqlSemantics\Statement\Comments $comments): self
74    {
75        return new self($this->describeCommand, $this->optExtendedDescribe, $this->explanableCommand, $comments);
76    }
77}
78