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

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Options::__construct -
   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/__construct">
  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/__construct">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                                         &uarr; <a href="./ion/Writer/Options">
  47                                                         Options
  48                                                 </a>
  49                                                 <ul>
  50                                                         <li>
  51
  52                                                         &circlearrowright; <strong><a href="./ion/Writer/Options/__construct">Options::__construct</a></strong>
  53
  54
  55
  56                                                 </ul>
  57
  58                                         </ul>
  59
  60                                                 </li>
  61
  62                                         </ul>
  63
  64                                 </li>
  65                         </ul>
  66
  67                 </li>
  68         </ul>
  69 </div>
  70                                         <meta charset="utf-8"><h1>
  71 <a class="permalink" href="ion/Writer/Options/__construct#">#</a><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]]]]]]]]]]]])</h1><p>Create custom ION writer options.</p><h2 id="Params:">Params:<a class="permalink" href="ion/Writer/Options/__construct#Params:">#</a>
  72 </h2><ul>
  73 <li>Optional ?<a href="ion/Catalog">ion\Catalog</a> <span class="var" id="$catalog">$catalog<a class="permalink" href="ion/Writer/Options/__construct#%24catalog">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
  74 ION catalog to use for symbol lookup.</li>
  75 <li>Optional ?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var" id="$decimalContext">$decimalContext<a class="permalink" href="ion/Writer/Options/__construct#%24decimalContext">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
  76 Decimal context to use.</li>
  77 <li>Optional <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/__construct#%24outputBinary">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
  78 Whether to output binary ION.</li>
  79 <li>Optional <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/__construct#%24compactFloats">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
  80 Whether to write doubles which fit in 32 bits as floats.</li>
  81 <li>Optional <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/__construct#%24escapeNonAscii">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
  82 Whether to slash-escape all non ASCII bytes.</li>
  83 <li>Optional <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/__construct#%24prettyPrint">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
  84 Whether to produce pretty-printed output.</li>
  85 <li>Optional <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/__construct#%24indentTabs">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">true</a></code><br>
  86 Whether to indent with tabs, when pretty-printing.</li>
  87 <li>Optional <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/__construct#%24indentSize">#</a></span> = 2<br>
  88 The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
  89 <li>Optional <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/__construct#%24flushEveryValue">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
  90 Whether to immediately flush every value written.</li>
  91 <li>Optional <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/__construct#%24maxContainerDepth">#</a></span> = 10<br>
  92 Maximum depth of nested containers.</li>
  93 <li>Optional <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/__construct#%24maxAnnotations">#</a></span> = 10<br>
  94 The maximum number of annotations allowed on a single value.</li>
  95 <li>Optional <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/__construct#%24tempBufferSize">#</a></span> = 16384<br>
  96 Temporary buffer size.</li>
  97 </ul>
  98                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
  99                         <script>
 100                                 var disqus_shortname = 'mdref';
 101                                 var disqus_identifier = 'ion/Writer/Options/__construct';
 102                         </script>
 103
 104                         <footer>
 105
 106 <ul>
 107         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 108 </a></li>
 109         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 110         <li>
 111 </li>
 112 </ul>
 113
 114                         </footer>
 115
 116                         <script src="index.js"></script>
 117
 118                 </div>
 119         </body>
 120 </html>