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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The explain_stmt 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\ExplainStmtWithDescribeCommandOptExplainOptionsExplainableStmt_c1c9381c $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class ExplainStmtWithDescribeCommandOptExplainOptionsExplainableStmt_c1c9381c implements \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtForm, \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtInnerForm, \SqlSemantics\Statement\Model\MySql\Role\ExplainStmtForm, \SqlSemantics\Statement\Model\MySql\Role\SimpleStatementForm, \SqlSemantics\Statement\Model\MySql\Role\SimpleStatementOrBeginForm, \SqlSemantics\Statement\Model\MySql\Role\SpProcStmtForm, \SqlSemantics\Statement\Model\MySql\Role\SpProcStmtStatementForm, \SqlSemantics\Statement\Model\MySql\Role\StoredRoutineBodyForm, \SqlSemantics\Statement\Command
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\OptExplainOptionsForm $optExplainOptions,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\ExplainableStmtForm $explainableStmt,
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($optExplainOptions), 'The optExplainOptions must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($explainableStmt), 'The explainableStmt 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->optExplainOptions->write($writer);
42        $writer->comments($this->comments, 2);
43        $this->explainableStmt->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->optExplainOptions, $this->explainableStmt, $this->comments);
52    }
53
54    /**
55     * Returns a copy with a new optExplainOptions, preserving every other field.
56     */
57    public function withOptExplainOptions(\SqlSemantics\Statement\Model\MySql\Role\OptExplainOptionsForm $optExplainOptions): self
58    {
59        return new self($this->describeCommand, $optExplainOptions, $this->explainableStmt, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new explainableStmt, preserving every other field.
64     */
65    public function withExplainableStmt(\SqlSemantics\Statement\Model\MySql\Role\ExplainableStmtForm $explainableStmt): self
66    {
67        return new self($this->describeCommand, $this->optExplainOptions, $explainableStmt, $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->optExplainOptions, $this->explainableStmt, $comments);
76    }
77}
78