packages/sql-semantics-postgres/resources/models/Value/CreateFunctionStmtWithCreateOptOrReplaceFunctionFuncNameFuncArgsWithDefaultsReturnsTableTableFunc_eb1a8b50.php

1<?php
2
3declare(strict_types=1);
4
5namespace SqlSemantics\Statement\Model\PostgreSql\Value;
6
7/**
8 * The CreateFunctionStmt 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\PostgreSql\Value\CreateFunctionStmtWithCreateOptOrReplaceFunctionFuncNameFuncArgsWithDefaultsReturnsTableTableFunc_eb1a8b50 $value): string => \SqlSemantics\Statement\Writer::render($value);
13 *     $write instanceof \Closure // => true
14 */
15final class CreateFunctionStmtWithCreateOptOrReplaceFunctionFuncNameFuncArgsWithDefaultsReturnsTableTableFunc_eb1a8b50 implements \SqlSemantics\Statement\Model\PostgreSql\Role\CreateFunctionStmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\ParseToplevelForm, \SqlSemantics\Statement\Model\PostgreSql\Role\RoutineBodyStmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\StmtForm, \SqlSemantics\Statement\Model\PostgreSql\Role\StmtmultiForm, \SqlSemantics\Statement\Model\PostgreSql\Role\ToplevelStmtForm, \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\PostgreSql\Role\OptOrReplaceForm $optOrReplace,
24        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\FuncNameForm $funcName,
25        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\FuncArgsWithDefaultsForm $funcArgsWithDefaults,
26        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\TableFuncColumnListForm $tableFuncColumnList,
27        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptCreatefuncOptListForm $optCreatefuncOptList,
28        public readonly \SqlSemantics\Statement\Model\PostgreSql\Role\OptRoutineBodyForm $optRoutineBody,
29        public readonly \SqlSemantics\Statement\Comments $comments = new \SqlSemantics\Statement\Comments(),
30    ) {
31        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optOrReplace), 'The optOrReplace must be a generated immutable SQL value.');
32        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($funcName), 'The funcName must be a generated immutable SQL value.');
33        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($funcArgsWithDefaults), 'The funcArgsWithDefaults must be a generated immutable SQL value.');
34        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($tableFuncColumnList), 'The tableFuncColumnList must be a generated immutable SQL value.');
35        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optCreatefuncOptList), 'The optCreatefuncOptList must be a generated immutable SQL value.');
36        $this->assert(\SqlSemantics\Statement\Model\PostgreSql\Contract\Contracts::contains($optRoutineBody), 'The optRoutineBody must be a generated immutable SQL value.');
37    }
38
39    /**
40     * Writes SQL entirely from this value's fields.
41     */
42    public function write(\SqlSemantics\Statement\Writer $writer): void
43    {
44        $writer->comments($this->comments, 0);
45        $writer->append('CREATE');
46        $writer->comments($this->comments, 1);
47        $this->optOrReplace->write($writer);
48        $writer->comments($this->comments, 2);
49        $writer->append('FUNCTION');
50        $writer->comments($this->comments, 3);
51        $this->funcName->write($writer);
52        $writer->comments($this->comments, 4);
53        $this->funcArgsWithDefaults->write($writer);
54        $writer->comments($this->comments, 5);
55        $writer->append('RETURNS');
56        $writer->comments($this->comments, 6);
57        $writer->append('TABLE');
58        $writer->comments($this->comments, 7);
59        $writer->append('(');
60        $writer->comments($this->comments, 8);
61        $this->tableFuncColumnList->write($writer);
62        $writer->comments($this->comments, 9);
63        $writer->append(')');
64        $writer->comments($this->comments, 10);
65        $this->optCreatefuncOptList->write($writer);
66        $writer->comments($this->comments, 11);
67        $this->optRoutineBody->write($writer);
68    }
69
70    /**
71     * Returns a copy with a new optOrReplace, preserving every other field.
72     */
73    public function withOptOrReplace(\SqlSemantics\Statement\Model\PostgreSql\Role\OptOrReplaceForm $optOrReplace): self
74    {
75        return new self($optOrReplace, $this->funcName, $this->funcArgsWithDefaults, $this->tableFuncColumnList, $this->optCreatefuncOptList, $this->optRoutineBody, $this->comments);
76    }
77
78    /**
79     * Returns a copy with a new funcName, preserving every other field.
80     */
81    public function withFuncName(\SqlSemantics\Statement\Model\PostgreSql\Role\FuncNameForm $funcName): self
82    {
83        return new self($this->optOrReplace, $funcName, $this->funcArgsWithDefaults, $this->tableFuncColumnList, $this->optCreatefuncOptList, $this->optRoutineBody, $this->comments);
84    }
85
86    /**
87     * Returns a copy with a new funcArgsWithDefaults, preserving every other field.
88     */
89    public function withFuncArgsWithDefaults(\SqlSemantics\Statement\Model\PostgreSql\Role\FuncArgsWithDefaultsForm $funcArgsWithDefaults): self
90    {
91        return new self($this->optOrReplace, $this->funcName, $funcArgsWithDefaults, $this->tableFuncColumnList, $this->optCreatefuncOptList, $this->optRoutineBody, $this->comments);
92    }
93
94    /**
95     * Returns a copy with a new tableFuncColumnList, preserving every other field.
96     */
97    public function withTableFuncColumnList(\SqlSemantics\Statement\Model\PostgreSql\Role\TableFuncColumnListForm $tableFuncColumnList): self
98    {
99        return new self($this->optOrReplace, $this->funcName, $this->funcArgsWithDefaults, $tableFuncColumnList, $this->optCreatefuncOptList, $this->optRoutineBody, $this->comments);
100    }
101
102    /**
103     * Returns a copy with a new optCreatefuncOptList, preserving every other field.
104     */
105    public function withOptCreatefuncOptList(\SqlSemantics\Statement\Model\PostgreSql\Role\OptCreatefuncOptListForm $optCreatefuncOptList): self
106    {
107        return new self($this->optOrReplace, $this->funcName, $this->funcArgsWithDefaults, $this->tableFuncColumnList, $optCreatefuncOptList, $this->optRoutineBody, $this->comments);
108    }
109
110    /**
111     * Returns a copy with a new optRoutineBody, preserving every other field.
112     */
113    public function withOptRoutineBody(\SqlSemantics\Statement\Model\PostgreSql\Role\OptRoutineBodyForm $optRoutineBody): self
114    {
115        return new self($this->optOrReplace, $this->funcName, $this->funcArgsWithDefaults, $this->tableFuncColumnList, $this->optCreatefuncOptList, $optRoutineBody, $this->comments);
116    }
117
118    /**
119     * Returns a copy with a new comments, preserving every other field.
120     */
121    public function withComments(\SqlSemantics\Statement\Comments $comments): self
122    {
123        return new self($this->optOrReplace, $this->funcName, $this->funcArgsWithDefaults, $this->tableFuncColumnList, $this->optCreatefuncOptList, $this->optRoutineBody, $comments);
124    }
125}
126