git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.2/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 property="og:title" content="ion\Writer\Options::__construct">
  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/__construct">
  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                                         &uarr; <a href="./ion/Writer/Options">
  46                                                         Options
  47                                                 </a>
  48                                                 <ul>
  49                                                         <li>
  50
  51                                                         &circlearrowright; <strong><a href="./ion/Writer/Options/__construct">Options::__construct</a></strong>
  52
  53
  54
  55                                                 </ul>
  56
  57                                         </ul>
  58
  59                                                 </li>
  60
  61                                         </ul>
  62
  63                                 </li>
  64                         </ul>
  65
  66                 </li>
  67         </ul>
  68 </div>
  69                                         <meta charset="utf-8"><h1>
  70 <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>
  71 </h2><ul>
  72 <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>
  73 ION catalog to use for symbol lookup.</li>
  74 <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>
  75 Decimal context to use.</li>
  76 <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>
  77 Whether to output binary ION.</li>
  78 <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>
  79 Whether to write doubles which fit in 32 bits as floats.</li>
  80 <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>
  81 Whether to slash-escape all non ASCII bytes.</li>
  82 <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>
  83 Whether to produce pretty-printed output.</li>
  84 <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>
  85 Whether to indent with tabs, when pretty-printing.</li>
  86 <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>
  87 The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
  88 <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>
  89 Whether to immediately flush every value written.</li>
  90 <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>
  91 Maximum depth of nested containers.</li>
  92 <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>
  93 The maximum number of annotations allowed on a single value.</li>
  94 <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>
  95 Temporary buffer size.</li>
  96 </ul>
  97                         <div class="comments">
  98                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
  99         <script>
 100                 function giscus_load(button) {
 101                         let script = document.createElement("script");
 102                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 103                                                 script.setAttribute("data-category", 'Comments on Docs');
 104                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 105                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 106                                                 script.setAttribute("data-mapping", 'og:title');
 107                                                 script.setAttribute("data-input-position", 'bottom');
 108                                                 script.setAttribute("data-reactions-enabled", false);
 109                                                 script.setAttribute("data-theme", 'light');
 110                                                 script.setAttribute("data-lang", 'en');
 111
 112                         script.src = "//giscus.app/client.js";
 113                         button.parentNode.replaceChild(script, button);
 114                 }
 115         </script>
 116         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 117
 118                         </div>
 119
 120                         <footer>
 121
 122 <ul>
 123         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 124 </a></li>
 125         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 126         <li>
 127 </li>
 128 </ul>
 129
 130                         </footer>
 131
 132                         <script src="index.js" defer></script>
 133
 134                 </div>
 135         </body>
 136 </html>