git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.2/ion/Writer/Options.html

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Options -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion\Writer\Options">
  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/Options">
  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                                                         &circlearrowright; <strong><a href="./ion/Writer/Options">Options</a></strong>
  46
  47
  48                                                         <ul>
  49
  50                                                                 <li>
  51                                                                         &rdsh; <a href="./ion/Writer/Options/__construct">Options::__construct</a>
  52
  53                                                                 </li>
  54
  55                                                         </ul>
  56
  57
  58                                                 </ul>
  59
  60                                                 <li>&ldsh; <a href="./ion/Writer/Buffer">Buffer</a></li>
  61
  62                                                 <li>&ldsh; <a href="./ion/Writer/Stream">Stream</a></li>
  63
  64                                                 <li>&ldsh; <a href="./ion/Writer/Writer">Writer</a></li>
  65
  66                                                 <li>&ldsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a></li>
  67
  68                                                 <li>&ldsh; <a href="./ion/Writer/finish">Writer::finish</a></li>
  69
  70                                                 <li>&ldsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a></li>
  71
  72                                                 <li>&ldsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a></li>
  73
  74                                                 <li>&ldsh; <a href="./ion/Writer/flush">Writer::flush</a></li>
  75
  76                                                 <li>&ldsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a></li>
  77
  78                                                 <li>&ldsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a></li>
  79
  80                                                 <li>&ldsh; <a href="./ion/Writer/startLob">Writer::startLob</a></li>
  81
  82                                                 <li>&ldsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a></li>
  83
  84                                                 <li>&ldsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a></li>
  85
  86                                                 <li>&ldsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a></li>
  87
  88                                                 <li>&ldsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a></li>
  89
  90                                                 <li>&ldsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a></li>
  91
  92                                                 <li>&ldsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a></li>
  93
  94                                                 <li>&ldsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a></li>
  95
  96                                                 <li>&ldsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a></li>
  97
  98                                                 <li>&ldsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a></li>
  99
 100                                                 <li>&ldsh; <a href="./ion/Writer/writeString">Writer::writeString</a></li>
 101
 102                                                 <li>&ldsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a></li>
 103
 104                                                 <li>&ldsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a></li>
 105
 106                                                 <li>&ldsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a></li>
 107
 108                                         </ul>
 109
 110                                 </li>
 111                         </ul>
 112
 113                 </li>
 114         </ul>
 115 </div>
 116                                         <meta charset="utf-8"><h1>
 117 <a class="permalink" href="ion/Writer/Options#">#</a><em>class</em> <a href="ion/Writer/Options">ion\Writer\Options</a>
 118 </h1><p>ION writer options.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Writer/Options#Constants:">#</a>
 119 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Writer/Options#Properties:">#</a>
 120 </h2><ul>
 121 <li>
 122 <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>
 123 <span class="constant">ION</span> catalog to use for symbol lookup.</li>
 124 <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/Options#%24decimalContext">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 126 Decimal context to use.</li>
 127 <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/Options#%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>
 130 <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/Options#%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>
 133 <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/Options#%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>
 136 <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/Options#%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>
 139 <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/Options#%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>
 142 <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/Options#%24indentSize">#</a></span> = 2<br>
 144 The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
 145 <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/Options#%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>
 148 <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/Options#%24maxContainerDepth">#</a></span> = 10<br>
 150 Maximum depth of nested containers.</li>
 151 <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/Options#%24maxAnnotations">#</a></span> = 10<br>
 153 The maximum number of annotations allowed on a single value.</li>
 154 <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/Options#%24tempBufferSize">#</a></span> = 16384<br>
 156 Temporary buffer size.</li>
 157 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Writer/Options#Functions:">#</a>
 158 </h2><ul class="sub-entries sub-functions">
 159
 160         <li>
 161                 <h3 id="Options::__construct">
 162 <a href="ion/Writer/Options/__construct">Options::__construct</a><a class="permalink" href="ion/Writer/Options#Options::__construct">#</a>
 163 </h3>
 164                 <p>Create custom ION writer options.</p>
 165
 166                 <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>
 167         </li>
 168
 169 </ul>
 170                         <div class="comments">
 171                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 172         <script>
 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');
 184
 185                         script.src = "//giscus.app/client.js";
 186                         button.parentNode.replaceChild(script, button);
 187                 }
 188         </script>
 189         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 190
 191                         </div>
 192
 193                         <footer>
 194
 195 <ul>
 196         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 197 </a></li>
 198         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 199         <li>
 200 </li>
 201 </ul>
 202
 203                         </footer>
 204
 205                         <script src="index.js" defer></script>
 206
 207                 </div>
 208         </body>
 209 </html>