9 <meta property=
"og:title" content=
"ion\Writer\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/Writer">
13 <link rel=
"stylesheet" href=
"index.css">
15 <link rel=
"shortcut icon" href=
"/ext-ion/v0.2/favicon.ico">
23 <a href=
"https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit
</a>
28 <li>↰ <a href=
"./">Home
</a>
33 ↑ <a href=
"./ion">
39 ↑ <a href=
"./ion/Writer">
45 ↻ <strong><a href=
"./ion/Writer/Writer">Writer
</a></strong>
51 ↳ <a href=
"./ion/Writer/Writer/__construct">Writer::__construct
</a>
60 <li>↲ <a href=
"./ion/Writer/Buffer">Buffer
</a></li>
62 <li>↲ <a href=
"./ion/Writer/Options">Options
</a></li>
64 <li>↲ <a href=
"./ion/Writer/Stream">Stream
</a></li>
66 <li>↲ <a href=
"./ion/Writer/appendLob">Writer::appendLob
</a></li>
68 <li>↲ <a href=
"./ion/Writer/finish">Writer::finish
</a></li>
70 <li>↲ <a href=
"./ion/Writer/finishContainer">Writer::finishContainer
</a></li>
72 <li>↲ <a href=
"./ion/Writer/finishLob">Writer::finishLob
</a></li>
74 <li>↲ <a href=
"./ion/Writer/flush">Writer::flush
</a></li>
76 <li>↲ <a href=
"./ion/Writer/getDepth">Writer::getDepth
</a></li>
78 <li>↲ <a href=
"./ion/Writer/startContainer">Writer::startContainer
</a></li>
80 <li>↲ <a href=
"./ion/Writer/startLob">Writer::startLob
</a></li>
82 <li>↲ <a href=
"./ion/Writer/writeAnnotation">Writer::writeAnnotation
</a></li>
84 <li>↲ <a href=
"./ion/Writer/writeBLob">Writer::writeBLob
</a></li>
86 <li>↲ <a href=
"./ion/Writer/writeBool">Writer::writeBool
</a></li>
88 <li>↲ <a href=
"./ion/Writer/writeCLob">Writer::writeCLob
</a></li>
90 <li>↲ <a href=
"./ion/Writer/writeDecimal">Writer::writeDecimal
</a></li>
92 <li>↲ <a href=
"./ion/Writer/writeFieldName">Writer::writeFieldName
</a></li>
94 <li>↲ <a href=
"./ion/Writer/writeFloat">Writer::writeFloat
</a></li>
96 <li>↲ <a href=
"./ion/Writer/writeInt">Writer::writeInt
</a></li>
98 <li>↲ <a href=
"./ion/Writer/writeNull">Writer::writeNull
</a></li>
100 <li>↲ <a href=
"./ion/Writer/writeString">Writer::writeString
</a></li>
102 <li>↲ <a href=
"./ion/Writer/writeSymbol">Writer::writeSymbol
</a></li>
104 <li>↲ <a href=
"./ion/Writer/writeTimestamp">Writer::writeTimestamp
</a></li>
106 <li>↲ <a href=
"./ion/Writer/writeTypedNull">Writer::writeTypedNull
</a></li>
116 <meta charset=
"utf-8"><h1>
117 <a class=
"permalink" href=
"ion/Writer/Writer#">#
</a><em>abstract
</em> <em>class
</em> <a href=
"ion/Writer/Writer">ion\Writer\Writer
</a> <br> <em>implements
</em> <a href=
"ion/Writer">ion\Writer
</a>
118 </h1><p>Base implementation of common functionality of ION writers.
</p><h2 id=
"Constants:">Constants:
<a class=
"permalink" href=
"ion/Writer/Writer#Constants:">#
</a>
119 </h2><p>None.
</p><h2 id=
"Properties:">Properties:
<a class=
"permalink" href=
"ion/Writer/Writer#Properties:">#
</a>
122 <em>public
</em> ?
<a href=
"ion/Catalog">ion\Catalog
</a> <span class=
"var" id=
"$catalog">$catalog
<a class=
"permalink" href=
"ion/Writer/Writer#%24catalog">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.null">NULL
</a></code><br>
123 <span class=
"constant">ION
</span> catalog to use for symbol lookup.
</li>
125 <em>public
</em> ?
<a href=
"ion/Decimal/Context">ion\Decimal\Context
</a> <span class=
"var" id=
"$decimalContext">$decimalContext
<a class=
"permalink" href=
"ion/Writer/Writer#%24decimalContext">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.null">NULL
</a></code><br>
126 Decimal context to use.
</li>
128 <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/Writer#%24outputBinary">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
129 Whether to output binary
<span class=
"constant">ION
</span>.
</li>
131 <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/Writer#%24compactFloats">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
132 Whether to write doubles which fit in
32 bits as floats.
</li>
134 <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/Writer#%24escapeNonAscii">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
135 Whether to slash-escape all non
<span class=
"constant">ASCII
</span> bytes.
</li>
137 <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/Writer#%24prettyPrint">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
138 Whether to produce pretty-printed output.
</li>
140 <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/Writer#%24indentTabs">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">true
</a></code><br>
141 Whether to indent with tabs, when pretty-printing.
</li>
143 <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/Writer#%24indentSize">#
</a></span> =
2<br>
144 The number of spaces to use for indentation instead of tabs, when pretty-printing.
</li>
146 <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/Writer#%24flushEveryValue">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
147 Whether to immediately flush every value written.
</li>
149 <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/Writer#%24maxContainerDepth">#
</a></span> =
10<br>
150 Maximum depth of nested containers.
</li>
152 <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/Writer#%24maxAnnotations">#
</a></span> =
10<br>
153 The maximum number of annotations allowed on a single value.
</li>
155 <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/Writer#%24tempBufferSize">#
</a></span> =
16384<br>
156 Temporary buffer size.
</li>
157 </ul><h2 id=
"Functions:">Functions:
<a class=
"permalink" href=
"ion/Writer/Writer#Functions:">#
</a>
158 </h2><ul class=
"sub-entries sub-functions">
161 <h3 id=
"Writer::__construct">
162 <a href=
"ion/Writer/Writer/__construct">Writer::__construct
</a><a class=
"permalink" href=
"ion/Writer/Writer#Writer::__construct">#
</a>
164 <p>Create custom ION writer.
</p>
166 <p><code><a href=
"https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void
</a></code> <a href=
"ion/Writer/Writer/__construct">ion\Writer\Writer::__construct
</a>([?
<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>
170 <div class=
"comments">
171 <style>.giscus-frame {min-height:
16em;}
</style>
173 function giscus_load(button) {
174 let script = document.createElement(
"script");
175 script.setAttribute(
"data-repo", 'awesomized/ext-ion');
176 script.setAttribute(
"data-category", 'Comments on Docs');
177 script.setAttribute(
"data-repo-id", 'R_kgDOGfXEXw');
178 script.setAttribute(
"data-category-id", 'DIC_kwDOGfXEX84CBHuf');
179 script.setAttribute(
"data-mapping", 'og:title');
180 script.setAttribute(
"data-input-position", 'bottom');
181 script.setAttribute(
"data-reactions-enabled", false);
182 script.setAttribute(
"data-theme", 'light');
183 script.setAttribute(
"data-lang", 'en');
185 script.src =
"//giscus.app/client.js";
186 button.parentNode.replaceChild(script, button);
189 <button class=
"activator" onclick=
"giscus_load(this)">Show Comments from Github Discussions
</button>
196 <li><a href=
"https://github.com/m6w6/mdref">mdref-v3.0
198 <li><a href=
"LICENSE">© 2013-
2022 All rights reserved.
</a></li>
205 <script src=
"index.js" defer
></script>