a547b1a2b0b2fc3fa06c85220e7e66195b3af6e8
[awesomized/ext-ion] / docs / v0.2 / ion / Writer / Stream / Writer.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 Writer -
7 mdref
8 </title>
9 <meta property="og:title" content="ion\Writer\Stream\Writer">
10 <meta name="viewport" content="width=1200, initial-scale=0.5">
11 <base href="/ext-ion/v0.2/">
12 <meta http-equiv="Content-Location" content="/ext-ion/v0.2/ion/Writer/Stream/Writer">
13 <link rel="stylesheet" href="index.css">
14
15 <link rel="shortcut icon" href="/ext-ion/v0.2/favicon.ico">
16 </head>
17 <body>
18 <div class="page">
19
20 <div class="sidebar">
21
22 <div class="edit">
23 <a href="https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit</a>
24 </div>
25
26
27 <ul>
28 <li>&lsh; <a href="./">Home</a>
29
30 <ul>
31 <li>
32
33 &uarr; <a href="./ion">
34 ion
35 </a>
36 <ul>
37 <li>
38
39 &uarr; <a href="./ion/Writer">
40 Writer
41 </a>
42 <ul>
43 <li>
44
45 &uarr; <a href="./ion/Writer/Stream">
46 Stream
47 </a>
48 <ul>
49 <li>
50
51 &circlearrowright; <strong><a href="./ion/Writer/Stream/Writer">Writer</a></strong>
52
53
54 <ul>
55
56 <li>
57 &rdsh; <a href="./ion/Writer/Stream/Writer/__construct">Writer::__construct</a>
58
59 </li>
60
61 </ul>
62
63
64 </ul>
65
66 <li>&ldsh; <a href="./ion/Writer/Stream/getStream">Stream::getStream</a></li>
67
68 </ul>
69
70 </li>
71
72 </ul>
73
74 </li>
75 </ul>
76
77 </li>
78 </ul>
79 </div>
80 <meta charset="utf-8"><h1>
81 <a class="permalink" href="ion/Writer/Stream/Writer#">#</a><em>class</em> <a href="ion/Writer/Stream/Writer">ion\Writer\Stream\Writer</a> <br>&nbsp;<em>extends</em> <a href="ion/Writer/Writer">ion\Writer\Writer</a> <br>&nbsp;<em>implements</em> <a href="ion/Writer/Stream">ion\Writer\Stream</a>
82 </h1><p>ION stream writer.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Writer/Stream/Writer#Constants:">#</a>
83 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Writer/Stream/Writer#Properties:">#</a>
84 </h2><ul>
85 <li>
86 <em>public</em> ?<a href="ion/Catalog">ion\Catalog</a> <span class="var" id="$catalog">$catalog<a class="permalink" href="ion/Writer/Stream/Writer#%24catalog">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
87 <span class="constant">ION</span> catalog to use for symbol lookup.</li>
88 <li>
89 <em>public</em> ?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var" id="$decimalContext">$decimalContext<a class="permalink" href="ion/Writer/Stream/Writer#%24decimalContext">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
90 Decimal context to use.</li>
91 <li>
92 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$outputBinary">$outputBinary<a class="permalink" href="ion/Writer/Stream/Writer#%24outputBinary">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
93 Whether to output binary <span class="constant">ION</span>.</li>
94 <li>
95 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$compactFloats">$compactFloats<a class="permalink" href="ion/Writer/Stream/Writer#%24compactFloats">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
96 Whether to write doubles which fit in 32 bits as floats.</li>
97 <li>
98 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$escapeNonAscii">$escapeNonAscii<a class="permalink" href="ion/Writer/Stream/Writer#%24escapeNonAscii">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
99 Whether to slash-escape all non <span class="constant">ASCII</span> bytes.</li>
100 <li>
101 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$prettyPrint">$prettyPrint<a class="permalink" href="ion/Writer/Stream/Writer#%24prettyPrint">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
102 Whether to produce pretty-printed output.</li>
103 <li>
104 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$indentTabs">$indentTabs<a class="permalink" href="ion/Writer/Stream/Writer#%24indentTabs">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">true</a></code><br>
105 Whether to indent with tabs, when pretty-printing.</li>
106 <li>
107 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$indentSize">$indentSize<a class="permalink" href="ion/Writer/Stream/Writer#%24indentSize">#</a></span> = 2<br>
108 The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
109 <li>
110 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$flushEveryValue">$flushEveryValue<a class="permalink" href="ion/Writer/Stream/Writer#%24flushEveryValue">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
111 Whether to immediately flush every value written.</li>
112 <li>
113 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$maxContainerDepth">$maxContainerDepth<a class="permalink" href="ion/Writer/Stream/Writer#%24maxContainerDepth">#</a></span> = 10<br>
114 Maximum depth of nested containers.</li>
115 <li>
116 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$maxAnnotations">$maxAnnotations<a class="permalink" href="ion/Writer/Stream/Writer#%24maxAnnotations">#</a></span> = 10<br>
117 The maximum number of annotations allowed on a single value.</li>
118 <li>
119 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$tempBufferSize">$tempBufferSize<a class="permalink" href="ion/Writer/Stream/Writer#%24tempBufferSize">#</a></span> = 16384<br>
120 Temporary buffer size.</li>
121 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Writer/Stream/Writer#Functions:">#</a>
122 </h2><ul class="sub-entries sub-functions">
123
124 <li>
125 <h3 id="Writer::__construct">
126 <a href="ion/Writer/Stream/Writer/__construct">Writer::__construct</a><a class="permalink" href="ion/Writer/Stream/Writer#Writer::__construct">#</a>
127 </h3>
128 <p>Create a new stream writer.</p>
129
130 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/Stream/Writer/__construct">ion\Writer\Stream\Writer::__construct</a>(<code><a href="https://php.net/manual/en/language.types.resource">resource</a></code> <span class="var">$stream</span>, [?<a href="ion/Catalog">ion\Catalog</a> <span class="var">$catalog</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>, [?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var">$decimalContext</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$outputBinary</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$compactFloats</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$escapeNonAscii</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$prettyPrint</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$indentTabs</span> = <code><a href="https://php.net/manual/en/language.types.boolean">true</a></code>, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$indentSize</span> = 2, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$flushEveryValue</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$maxContainerDepth</span> = 10, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$maxAnnotations</span> = 10, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$tempBufferSize</span> = 16384]]]]]]]]]]]])</p>
131 </li>
132
133 </ul>
134 <div class="comments">
135 <style>.giscus-frame {min-height: 16em;}</style>
136 <script>
137 function giscus_load(button) {
138 let script = document.createElement("script");
139 script.setAttribute("data-repo", 'awesomized/ext-ion');
140 script.setAttribute("data-category", 'Comments on Docs');
141 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
142 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
143 script.setAttribute("data-mapping", 'og:title');
144 script.setAttribute("data-input-position", 'bottom');
145 script.setAttribute("data-reactions-enabled", false);
146 script.setAttribute("data-theme", 'light');
147 script.setAttribute("data-lang", 'en');
148
149 script.src = "//giscus.app/client.js";
150 button.parentNode.replaceChild(script, button);
151 }
152 </script>
153 <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
154
155 </div>
156
157 <footer>
158
159 <ul>
160 <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
161 </a></li>
162 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
163 <li>
164 </li>
165 </ul>
166
167 </footer>
168
169 <script src="index.js" defer></script>
170
171 </div>
172 </body>
173 </html>