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

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\MySql\Value;
6
7/**
8 * The window_func_call 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\WindowFuncCallWithFirstValueSymExprOptNullTreatmentWindowingClause_416b6d35 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class WindowFuncCallWithFirstValueSymExprOptNullTreatmentWindowingClause_416b6d35 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\SimpleExprForm, \SqlSemantics\Statement\Model\MySql\Role\SpCparamsForm, \SqlSemantics\Statement\Model\MySql\Role\ValuesForm, \SqlSemantics\Statement\Model\MySql\Role\WindowFuncCallForm
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\ExprForm $expr,
24        public readonly \SqlSemantics\Statement\Model\MySql\Role\OptNullTreatmentForm $optNullTreatment,
25        public readonly \SqlSemantics\Statement\Model\MySql\Role\WindowingClauseForm $windowingClause,
26        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
27    ) {
28        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($expr), 'The expr must be a generated immutable SQL value.');
29        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($optNullTreatment), 'The optNullTreatment must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\MySql\Contract\Contracts::contains($windowingClause), 'The windowingClause 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('FIRST_VALUE');
40        $writer->comments($this->comments, 1);
41        $writer->append('(');
42        $writer->comments($this->comments, 2);
43        $this->expr->write($writer);
44        $writer->comments($this->comments, 3);
45        $writer->append(')');
46        $writer->comments($this->comments, 4);
47        $this->optNullTreatment->write($writer);
48        $writer->comments($this->comments, 5);
49        $this->windowingClause->write($writer);
50    }
51
52    /**
53     * Returns a copy with a new expr, preserving every other field.
54     */
55    public function withExpr(\SqlSemantics\Statement\Model\MySql\Role\ExprForm $expr): self
56    {
57        return new self($expr, $this->optNullTreatment, $this->windowingClause, $this->comments);
58    }
59
60    /**
61     * Returns a copy with a new optNullTreatment, preserving every other field.
62     */
63    public function withOptNullTreatment(\SqlSemantics\Statement\Model\MySql\Role\OptNullTreatmentForm $optNullTreatment): self
64    {
65        return new self($this->expr, $optNullTreatment, $this->windowingClause, $this->comments);
66    }
67
68    /**
69     * Returns a copy with a new windowingClause, preserving every other field.
70     */
71    public function withWindowingClause(\SqlSemantics\Statement\Model\MySql\Role\WindowingClauseForm $windowingClause): self
72    {
73        return new self($this->expr, $this->optNullTreatment, $windowingClause, $this->comments);
74    }
75
76    /**
77     * Returns a copy with a new comments, preserving every other field.
78     */
79    public function withComments(\SqlSemantics\Statement\Comments $comments): self
80    {
81        return new self($this->expr, $this->optNullTreatment, $this->windowingClause, $comments);
82    }
83}
84