mdref
</title>
<meta name="viewport" content="width=1200, initial-scale=0.5">
- <base href="/v0.0/">
- <meta http-equiv="Content-Location" content="/v0.0/ion/Writer/Options">
+ <base href="/ext-ion/v0.0/">
+ <meta http-equiv="Content-Location" content="/ext-ion/v0.0/ion/Writer/Options">
<link rel="stylesheet" href="index.css">
<link href="https://fonts.googleapis.com/css?family=Inconsolata&subset=latin-ext" rel="stylesheet">
<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
- <link rel="shortcut icon" href="/v0.0/favicon.ico">
+ <link rel="shortcut icon" href="/ext-ion/v0.0/favicon.ico">
</head>
<body>
<div class="page">
</li>
</ul>
</div>
-
-<h1>class ion\Writer\Options</h1>
-<p>ION writer options.</p>
-<h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
-<p>None.</p>
-<h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
-<ul>
-<li>public ?ion\Catalog $catalog<br />
-ION catalog to use for symbol lookup.</li>
-<li>public ?ion\Decimal\Context $decimalContext<br />
+ <meta charset="utf-8"><h1>
+<a class="permalink" href="ion/Writer/Options#">#</a><em>class</em> <a href="ion/Writer/Options">ion\Writer\Options</a>
+</h1><p>ION writer options.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Writer/Options#Constants:">#</a>
+</h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Writer/Options#Properties:">#</a>
+</h2><ul>
+<li>
+<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>
+<span class="constant">ION</span> catalog to use for symbol lookup.</li>
+<li>
+<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>
Decimal context to use.</li>
-<li>public bool $outputBinary<br />
-Whether to output binary ION.</li>
-<li>public bool $compactFloats<br />
+<li>
+<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>
+Whether to output binary <span class="constant">ION</span>.</li>
+<li>
+<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>
Whether to write doubles which fit in 32 bits as floats.</li>
-<li>public bool $escapeNonAscii<br />
-Whether to slash-escape all non ASCII bytes.</li>
-<li>public bool $prettyPrint<br />
+<li>
+<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>
+Whether to slash-escape all non <span class="constant">ASCII</span> bytes.</li>
+<li>
+<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>
Whether to produce pretty-printed output.</li>
-<li>public bool $indentTabs<br />
+<li>
+<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>
Whether to indent with tabs, when pretty-printing.</li>
-<li>public int $indentSize<br />
+<li>
+<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>
The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
-<li>public bool $flushEveryValue<br />
+<li>
+<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>
Whether to immediately flush every value written.</li>
-<li>public int $maxContainerDepth<br />
+<li>
+<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>
Maximum depth of nested containers.</li>
-<li>public int $maxAnnotations<br />
+<li>
+<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>
The maximum number of annotations allowed on a single value.</li>
-<li>public int $tempBufferSize<br />
+<li>
+<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>
Temporary buffer size.</li>
-</ul>
-
-
-
-<h2 id="Functions:">Functions:</h2>
-<ul>
+</ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Writer/Options#Functions:">#</a>
+</h2><ul>
<li>
- <h3><a href="ion/Writer/Options/__construct">Options::__construct</a></h3>
+ <h3 id="Options::__construct">
+<a href="ion/Writer/Options/__construct">Options::__construct</a><a class="permalink" href="ion/Writer/Options#Options::__construct">#</a>
+</h3>
<p>Create custom ION writer options.</p>
- <p>void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])</p>
+ <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>
</li>
-</ul>
-
-
+</ul>
<div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
<script>
var disqus_shortname = 'mdref';
<footer>
<ul>
- <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
+ <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
</a></li>
<li><a href="LICENSE">© 2013-2022 All rights reserved.</a></li>
<li>
projects / awesomized / ext-ion / blobdiff