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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The handler_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\HandlerStmtWithHandlerSymIdentReadSymHandlerScanFunctionOptWhereClauseOptLimitClause_f9f50968 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class HandlerStmtWithHandlerSymIdentReadSymHandlerScanFunctionOptWhereClauseOptLimitClause_f9f50968 implements \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtForm, \SqlSemantics\Statement\Model\MySql\Role\EvSqlStmtInnerForm, \SqlSemantics\Statement\Model\MySql\Role\HandlerStmtForm, \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\IdentForm $ident,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\HandlerScanFunctionForm $handlerScanFunction,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptWhereClauseForm $where,
26        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptLimitClauseForm $optLimitClause,
27        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
28    ) {
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($ident), 'The ident must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($handlerScanFunction), 'The handlerScanFunction must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($where), 'The where must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optLimitClause), 'The optLimitClause 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        $writer->append('HANDLER');
42        $writer->comments($this->comments, 1);
43        $this->ident->write($writer);
44        $writer->comments($this->comments, 2);
45        $writer->append('READ');
46        $writer->comments($this->comments, 3);
47        $this->handlerScanFunction->write($writer);
48        $writer->comments($this->comments, 4);
49        $this->where->write($writer);
50        $writer->comments($this->comments, 5);
51        $this->optLimitClause->write($writer);
52    }
53
54    /**
55     * Returns a copy with a new ident, preserving every other field.
56     */
57    public function withIdent(\SqlSemantics\Statement\Model\MySql\Role\IdentForm $ident): self
58    {
59        return new self($ident, $this->handlerScanFunction, $this->where, $this->optLimitClause, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new handlerScanFunction, preserving every other field.
64     */
65    public function withHandlerScanFunction(\SqlSemantics\Statement\Model\MySql\Role\HandlerScanFunctionForm $handlerScanFunction): self
66    {
67        return new self($this->ident, $handlerScanFunction, $this->where, $this->optLimitClause, $this->comments);
68    }
69
70    /**
71     * Returns a copy with a new where, preserving every other field.
72     */
73    public function withWhere(\SqlSemantics\Statement\Model\MySql\Role\OptWhereClauseForm $where): self
74    {
75        return new self($this->ident, $this->handlerScanFunction, $where, $this->optLimitClause, $this->comments);
76    }
77
78    /**
79     * Returns a copy with a new optLimitClause, preserving every other field.
80     */
81    public function withOptLimitClause(\SqlSemantics\Statement\Model\MySql\Role\OptLimitClauseForm $optLimitClause): self
82    {
83        return new self($this->ident, $this->handlerScanFunction, $this->where, $optLimitClause, $this->comments);
84    }
85
86    /**
87     * Returns a copy with a new comments, preserving every other field.
88     */
89    public function withComments(\SqlSemantics\Statement\Comments $comments): self
90    {
91        return new self($this->ident, $this->handlerScanFunction, $this->where, $this->optLimitClause, $comments);
92    }
93}
94