packages/sql-semantics-sqlite/resources/models/Value/FrameOptWithRangeOrRowsBetweenFrameBoundSAndFrameBoundEFrameExcludeOpt_4d98dc77.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\Sqlite\Value;
6
7/**
8 * The frame_opt 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\Sqlite\Value\FrameOptWithRangeOrRowsBetweenFrameBoundSAndFrameBoundEFrameExcludeOpt_4d98dc77 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class FrameOptWithRangeOrRowsBetweenFrameBoundSAndFrameBoundEFrameExcludeOpt_4d98dc77 implements \SqlSemantics\Statement\Model\Sqlite\Role\FrameOptForm, \SqlSemantics\Statement\Model\Sqlite\Role\WindowForm
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\Sqlite\Role\RangeOrRowsForm $rangeOrRows,
24        public readonly \SqlSemantics\Statement\Model\Sqlite\Role\FrameBoundSForm $frameBoundS,
25        public readonly \SqlSemantics\Statement\Model\Sqlite\Role\FrameBoundEForm $frameBoundE,
26        public readonly \SqlSemantics\Statement\Model\Sqlite\Role\FrameExcludeOptForm $frameExcludeOpt,
27        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
28    ) {
29        $this->assert(\SqlSemantics\Statement\Model\Sqlite\Contract\Contracts::contains($rangeOrRows), 'The rangeOrRows must be a generated immutable SQL value.');
30        $this->assert(\SqlSemantics\Statement\Model\Sqlite\Contract\Contracts::contains($frameBoundS), 'The frameBoundS must be a generated immutable SQL value.');
31        $this->assert(\SqlSemantics\Statement\Model\Sqlite\Contract\Contracts::contains($frameBoundE), 'The frameBoundE must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\Sqlite\Contract\Contracts::contains($frameExcludeOpt), 'The frameExcludeOpt 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        $this->rangeOrRows->write($writer);
42        $writer->comments($this->comments, 1);
43        $writer->append('BETWEEN');
44        $writer->comments($this->comments, 2);
45        $this->frameBoundS->write($writer);
46        $writer->comments($this->comments, 3);
47        $writer->append('AND');
48        $writer->comments($this->comments, 4);
49        $this->frameBoundE->write($writer);
50        $writer->comments($this->comments, 5);
51        $this->frameExcludeOpt->write($writer);
52    }
53
54    /**
55     * Returns a copy with a new rangeOrRows, preserving every other field.
56     */
57    public function withRangeOrRows(\SqlSemantics\Statement\Model\Sqlite\Role\RangeOrRowsForm $rangeOrRows): self
58    {
59        return new self($rangeOrRows, $this->frameBoundS, $this->frameBoundE, $this->frameExcludeOpt, $this->comments);
60    }
61
62    /**
63     * Returns a copy with a new frameBoundS, preserving every other field.
64     */
65    public function withFrameBoundS(\SqlSemantics\Statement\Model\Sqlite\Role\FrameBoundSForm $frameBoundS): self
66    {
67        return new self($this->rangeOrRows, $frameBoundS, $this->frameBoundE, $this->frameExcludeOpt, $this->comments);
68    }
69
70    /**
71     * Returns a copy with a new frameBoundE, preserving every other field.
72     */
73    public function withFrameBoundE(\SqlSemantics\Statement\Model\Sqlite\Role\FrameBoundEForm $frameBoundE): self
74    {
75        return new self($this->rangeOrRows, $this->frameBoundS, $frameBoundE, $this->frameExcludeOpt, $this->comments);
76    }
77
78    /**
79     * Returns a copy with a new frameExcludeOpt, preserving every other field.
80     */
81    public function withFrameExcludeOpt(\SqlSemantics\Statement\Model\Sqlite\Role\FrameExcludeOptForm $frameExcludeOpt): self
82    {
83        return new self($this->rangeOrRows, $this->frameBoundS, $this->frameBoundE, $frameExcludeOpt, $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->rangeOrRows, $this->frameBoundS, $this->frameBoundE, $this->frameExcludeOpt, $comments);
92    }
93}
94