9 <meta name=
"viewport" content=
"width=1200, initial-scale=0.5">
11 <meta http-equiv=
"Content-Location" content=
"/v0.0/ion/Writer/Options">
12 <link rel=
"stylesheet" href=
"index.css">
14 <link href=
"https://fonts.googleapis.com/css?family=Inconsolata&subset=latin-ext" rel=
"stylesheet">
15 <script src=
"//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
16 <link rel=
"shortcut icon" href=
"/v0.0/favicon.ico">
24 <a href=
"./ion/Writer/Options">Edit
</a>
29 <li>↰ <a href=
"./">Home
</a>
34 ↑ <a href=
"./ion">
40 ↑ <a href=
"./ion/Writer">
46 ↻ <strong><a href=
"./ion/Writer/Options">Options
</a></strong>
52 ↳ <a href=
"./ion/Writer/Options/__construct">Options::__construct
</a>
61 <li>↲ <a href=
"./ion/Writer/Buffer">Buffer
</a></li>
63 <li>↲ <a href=
"./ion/Writer/Stream">Stream
</a></li>
65 <li>↲ <a href=
"./ion/Writer/Writer">Writer
</a></li>
67 <li>↲ <a href=
"./ion/Writer/appendLob">Writer::appendLob
</a></li>
69 <li>↲ <a href=
"./ion/Writer/finish">Writer::finish
</a></li>
71 <li>↲ <a href=
"./ion/Writer/finishContainer">Writer::finishContainer
</a></li>
73 <li>↲ <a href=
"./ion/Writer/finishLob">Writer::finishLob
</a></li>
75 <li>↲ <a href=
"./ion/Writer/flush">Writer::flush
</a></li>
77 <li>↲ <a href=
"./ion/Writer/getDepth">Writer::getDepth
</a></li>
79 <li>↲ <a href=
"./ion/Writer/startContainer">Writer::startContainer
</a></li>
81 <li>↲ <a href=
"./ion/Writer/startLob">Writer::startLob
</a></li>
83 <li>↲ <a href=
"./ion/Writer/writeAnnotation">Writer::writeAnnotation
</a></li>
85 <li>↲ <a href=
"./ion/Writer/writeBLob">Writer::writeBLob
</a></li>
87 <li>↲ <a href=
"./ion/Writer/writeBool">Writer::writeBool
</a></li>
89 <li>↲ <a href=
"./ion/Writer/writeCLob">Writer::writeCLob
</a></li>
91 <li>↲ <a href=
"./ion/Writer/writeDecimal">Writer::writeDecimal
</a></li>
93 <li>↲ <a href=
"./ion/Writer/writeFieldName">Writer::writeFieldName
</a></li>
95 <li>↲ <a href=
"./ion/Writer/writeFloat">Writer::writeFloat
</a></li>
97 <li>↲ <a href=
"./ion/Writer/writeInt">Writer::writeInt
</a></li>
99 <li>↲ <a href=
"./ion/Writer/writeNull">Writer::writeNull
</a></li>
101 <li>↲ <a href=
"./ion/Writer/writeString">Writer::writeString
</a></li>
103 <li>↲ <a href=
"./ion/Writer/writeSymbol">Writer::writeSymbol
</a></li>
105 <li>↲ <a href=
"./ion/Writer/writeTimestamp">Writer::writeTimestamp
</a></li>
107 <li>↲ <a href=
"./ion/Writer/writeTypedNull">Writer::writeTypedNull
</a></li>
117 <meta charset=
"utf-8"><h1>
118 <a class=
"permalink" href=
"ion/Writer/Options#">#
</a><em>class
</em> <a href=
"ion/Writer/Options">ion\Writer\Options
</a>
119 </h1><p>ION writer options.
</p><h2 id=
"Constants:">Constants:
<a class=
"permalink" href=
"ion/Writer/Options#Constants:">#
</a>
120 </h2><p>None.
</p><h2 id=
"Properties:">Properties:
<a class=
"permalink" href=
"ion/Writer/Options#Properties:">#
</a>
123 <em>public
</em> ?
<a href=
"ion/Catalog">ion\Catalog
</a> <span class=
"var" id=
"$catalog">$catalog
<a class=
"permalink" href=
"ion/Writer/Options#%24catalog">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.null">NULL
</a></code><br>
124 <span class=
"constant">ION
</span> catalog to use for symbol lookup.
</li>
126 <em>public
</em> ?
<a href=
"ion/Decimal/Context">ion\Decimal\Context
</a> <span class=
"var" id=
"$decimalContext">$decimalContext
<a class=
"permalink" href=
"ion/Writer/Options#%24decimalContext">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.null">NULL
</a></code><br>
127 Decimal context to use.
</li>
129 <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/Options#%24outputBinary">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
130 Whether to output binary
<span class=
"constant">ION
</span>.
</li>
132 <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/Options#%24compactFloats">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
133 Whether to write doubles which fit in
32 bits as floats.
</li>
135 <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/Options#%24escapeNonAscii">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
136 Whether to slash-escape all non
<span class=
"constant">ASCII
</span> bytes.
</li>
138 <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/Options#%24prettyPrint">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
139 Whether to produce pretty-printed output.
</li>
141 <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/Options#%24indentTabs">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">true
</a></code><br>
142 Whether to indent with tabs, when pretty-printing.
</li>
144 <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/Options#%24indentSize">#
</a></span> =
2<br>
145 The number of spaces to use for indentation instead of tabs, when pretty-printing.
</li>
147 <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/Options#%24flushEveryValue">#
</a></span> =
<code><a href=
"https://php.net/manual/en/language.types.boolean">false
</a></code><br>
148 Whether to immediately flush every value written.
</li>
150 <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/Options#%24maxContainerDepth">#
</a></span> =
10<br>
151 Maximum depth of nested containers.
</li>
153 <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/Options#%24maxAnnotations">#
</a></span> =
10<br>
154 The maximum number of annotations allowed on a single value.
</li>
156 <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/Options#%24tempBufferSize">#
</a></span> =
16384<br>
157 Temporary buffer size.
</li>
158 </ul><h2 id=
"Functions:">Functions:
<a class=
"permalink" href=
"ion/Writer/Options#Functions:">#
</a>
162 <h3 id=
"Options::__construct">
163 <a href=
"ion/Writer/Options/__construct">Options::__construct
</a><a class=
"permalink" href=
"ion/Writer/Options#Options::__construct">#
</a>
165 <p>Create custom ION writer options.
</p>
167 <p><code><a href=
"https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void
</a></code> <a href=
"ion/Writer/Options/__construct">ion\Writer\Options::__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>
171 <div id=
"disqus_thread"><button id=
"disqus_activator">Show
<span> </span> Comment(s)
</button></div>
173 var disqus_shortname = 'mdref';
174 var disqus_identifier = 'ion/Writer/Options';
180 <li><a href=
"https://github.com/m6w6/mdref">mdref-v3.0
182 <li><a href=
"LICENSE">© 2013-
2022 All rights reserved.
</a></li>
189 <script src=
"index.js"></script>