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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The sum_expr 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\SumExprWithStdSymInSumExprOptWindowingClause_a6257b6a $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class SumExprWithStdSymInSumExprOptWindowingClause_a6257b6a implements \SqlSemantics\Statement\Model\MySql\Role\BitExprForm, \SqlSemantics\Statement\Model\MySql\Role\BoolPriForm, \SqlSemantics\Statement\Model\MySql\Role\ExprForm, \SqlSemantics\Statement\Model\MySql\Role\ExprListForm, \SqlSemantics\Statement\Model\MySql\Role\ExprOrDefaultForm, \SqlSemantics\Statement\Model\MySql\Role\GeneratedColumnFuncForm, \SqlSemantics\Statement\Model\MySql\Role\GroupListForm, \SqlSemantics\Statement\Model\MySql\Role\GroupingExprForm, \SqlSemantics\Statement\Model\MySql\Role\InstallSetRvalueForm, \SqlSemantics\Statement\Model\MySql\Role\OptExprForm, \SqlSemantics\Statement\Model\MySql\Role\OptExprListForm, \SqlSemantics\Statement\Model\MySql\Role\OptSpCparamsForm, \SqlSemantics\Statement\Model\MySql\Role\OptValuesForm, \SqlSemantics\Statement\Model\MySql\Role\OrderIdentForm, \SqlSemantics\Statement\Model\MySql\Role\PartFuncExprForm, \SqlSemantics\Statement\Model\MySql\Role\PartFuncMaxForm, \SqlSemantics\Statement\Model\MySql\Role\PartValueExprItemForm, \SqlSemantics\Statement\Model\MySql\Role\PartValueItemForm, \SqlSemantics\Statement\Model\MySql\Role\PartValueItemListForm, \SqlSemantics\Statement\Model\MySql\Role\PartValueListForm, \SqlSemantics\Statement\Model\MySql\Role\PartValuesInForm, \SqlSemantics\Statement\Model\MySql\Role\PredicateForm, \SqlSemantics\Statement\Model\MySql\Role\SetExprOrDefaultForm, \SqlSemantics\Statement\Model\MySql\Role\SetFunctionSpecificationForm, \SqlSemantics\Statement\Model\MySql\Role\SimpleExprForm, \SqlSemantics\Statement\Model\MySql\Role\SpCparamsForm, \SqlSemantics\Statement\Model\MySql\Role\SumExprForm, \SqlSemantics\Statement\Model\MySql\Role\ValuesForm
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 string $stdSym,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\InSumExprForm $inSumExpr,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptWindowingClauseForm $optWindowingClause,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assertMatchesPattern($stdSym, \SqlSemantics\Statement\Model\MySql\Contract\Contracts::SPELLINGS['STD_SYM'], 'The stdSym must be a complete STD_SYM lexical spelling.');
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($inSumExpr), 'The inSumExpr must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optWindowingClause), 'The optWindowingClause 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($this->stdSym);
40        $writer->comments($this->comments, 1);
41        $writer->append('(');
42        $writer->comments($this->comments, 2);
43        $this->inSumExpr->write($writer);
44        $writer->comments($this->comments, 3);
45        $writer->append(')');
46        $writer->comments($this->comments, 4);
47        $this->optWindowingClause->write($writer);
48    }
49
50    /**
51     * Returns a copy with a new stdSym, preserving every other field.
52     */
53    public function withStdSym(string $stdSym): self
54    {
55        return new self($stdSym, $this->inSumExpr, $this->optWindowingClause, $this->comments);
56    }
57
58    /**
59     * Returns a copy with a new inSumExpr, preserving every other field.
60     */
61    public function withInSumExpr(\SqlSemantics\Statement\Model\MySql\Role\InSumExprForm $inSumExpr): self
62    {
63        return new self($this->stdSym, $inSumExpr, $this->optWindowingClause, $this->comments);
64    }
65
66    /**
67     * Returns a copy with a new optWindowingClause, preserving every other field.
68     */
69    public function withOptWindowingClause(\SqlSemantics\Statement\Model\MySql\Role\OptWindowingClauseForm $optWindowingClause): self
70    {
71        return new self($this->stdSym, $this->inSumExpr, $optWindowingClause, $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->stdSym, $this->inSumExpr, $this->optWindowingClause, $comments);
80    }
81}
82