git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/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 name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/v0.0/ion/Writer/Options">
  12                         <link rel="stylesheet" href="index.css">
  13
  14                 <link href="https://fonts.googleapis.com/css?family=Inconsolata&amp;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">
  17         </head>
  18         <body>
  19                 <div class="page">
  20
  21 <div class="sidebar">
  22
  23         <div class="edit">
  24                 <a href="./ion/Writer/Options">Edit</a>
  25         </div>
  26
  27
  28         <ul>
  29                 <li>&lsh; <a href="./">Home</a>
  30
  31                         <ul>
  32                                 <li>
  33
  34                                         &uarr; <a href="./ion">
  35                                                         ion
  36                                                 </a>
  37                                                 <ul>
  38                                                         <li>
  39
  40                                         &uarr; <a href="./ion/Writer">
  41                                                         Writer
  42                                                 </a>
  43                                                 <ul>
  44                                                         <li>
  45
  46                                                         &circlearrowright; <strong><a href="./ion/Writer/Options">Options</a></strong>
  47
  48
  49                                                         <ul>
  50
  51                                                                 <li>
  52                                                                         &rdsh; <a href="./ion/Writer/Options/__construct">Options::__construct</a>
  53
  54                                                                 </li>
  55
  56                                                         </ul>
  57
  58
  59                                                 </ul>
  60
  61                                                 <li>&ldsh; <a href="./ion/Writer/Buffer">Buffer</a></li>
  62
  63                                                 <li>&ldsh; <a href="./ion/Writer/Stream">Stream</a></li>
  64
  65                                                 <li>&ldsh; <a href="./ion/Writer/Writer">Writer</a></li>
  66
  67                                                 <li>&ldsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a></li>
  68
  69                                                 <li>&ldsh; <a href="./ion/Writer/finish">Writer::finish</a></li>
  70
  71                                                 <li>&ldsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a></li>
  72
  73                                                 <li>&ldsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a></li>
  74
  75                                                 <li>&ldsh; <a href="./ion/Writer/flush">Writer::flush</a></li>
  76
  77                                                 <li>&ldsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a></li>
  78
  79                                                 <li>&ldsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a></li>
  80
  81                                                 <li>&ldsh; <a href="./ion/Writer/startLob">Writer::startLob</a></li>
  82
  83                                                 <li>&ldsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a></li>
  84
  85                                                 <li>&ldsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a></li>
  86
  87                                                 <li>&ldsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a></li>
  88
  89                                                 <li>&ldsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a></li>
  90
  91                                                 <li>&ldsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a></li>
  92
  93                                                 <li>&ldsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a></li>
  94
  95                                                 <li>&ldsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a></li>
  96
  97                                                 <li>&ldsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a></li>
  98
  99                                                 <li>&ldsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/Writer/writeString">Writer::writeString</a></li>
 102
 103                                                 <li>&ldsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a></li>
 104
 105                                                 <li>&ldsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a></li>
 106
 107                                                 <li>&ldsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a></li>
 108
 109                                         </ul>
 110
 111                                 </li>
 112                         </ul>
 113
 114                 </li>
 115         </ul>
 116 </div>
 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>
 121 </h2><ul>
 122 <li>
 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>
 125 <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>
 128 <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>
 131 <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>
 134 <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>
 137 <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>
 140 <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>
 143 <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>
 146 <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>
 149 <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>
 152 <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>
 155 <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>
 159 </h2><ul>
 160
 161         <li>
 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>
 164 </h3>
 165                 <p>Create custom ION writer options.</p>
 166
 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>
 168         </li>
 169
 170 </ul>
 171                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 172                         <script>
 173                                 var disqus_shortname = 'mdref';
 174                                 var disqus_identifier = 'ion/Writer/Options';
 175                         </script>
 176
 177                         <footer>
 178
 179 <ul>
 180         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 181 </a></li>
 182         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 183         <li>
 184 </li>
 185 </ul>
 186
 187                         </footer>
 188
 189                         <script src="index.js"></script>
 190
 191                 </div>
 192         </body>
 193 </html>