git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/ion/Reader/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="/ext-ion/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/ext-ion/v0.0/ion/Reader/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="/ext-ion/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/Reader/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/Reader">
  41                                                         Reader
  42                                                 </a>
  43                                                 <ul>
  44                                                         <li>
  45
  46                                                         &circlearrowright; <strong><a href="./ion/Reader/Options">Options</a></strong>
  47
  48
  49                                                         <ul>
  50
  51                                                                 <li>
  52                                                                         &rdsh; <a href="./ion/Reader/Options/__construct">Options::__construct</a>
  53
  54                                                                 </li>
  55
  56                                                         </ul>
  57
  58
  59                                                 </ul>
  60
  61                                                 <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
  62
  63                                                 <li>&ldsh; <a href="./ion/Reader/Reader">Reader</a></li>
  64
  65                                                 <li>&ldsh; <a href="./ion/Reader/Stream">Stream</a></li>
  66
  67                                                 <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
  68
  69                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
  70
  71                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
  72
  73                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
  74
  75                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
  76
  77                                                 <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
  78
  79                                                 <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
  80
  81                                                 <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
  82
  83                                                 <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
  84
  85                                                 <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
  86
  87                                                 <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
  88
  89                                                 <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
  90
  91                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
  92
  93                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
  94
  95                                                 <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
  96
  97                                                 <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
  98
  99                                                 <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
 102
 103                                                 <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
 104
 105                                                 <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
 106
 107                                                 <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
 108
 109                                                 <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
 110
 111                                                 <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
 112
 113                                                 <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
 114
 115                                                 <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
 116
 117                                                 <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
 118
 119                                                 <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
 120
 121                                                 <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
 122
 123                                         </ul>
 124
 125                                 </li>
 126                         </ul>
 127
 128                 </li>
 129         </ul>
 130 </div>
 131                                         <meta charset="utf-8"><h1>
 132 <a class="permalink" href="ion/Reader/Options#">#</a><em>class</em> <a href="ion/Reader/Options">ion\Reader\Options</a>
 133 </h1><p>Reader options.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Reader/Options#Constants:">#</a>
 134 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Reader/Options#Properties:">#</a>
 135 </h2><ul>
 136 <li>
 137 <em>public</em> ?<a href="ion/Catalog">ion\Catalog</a> <span class="var" id="$catalog">$catalog<a class="permalink" href="ion/Reader/Options#%24catalog">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 138 <span class="constant">ION</span> catalog to use for symbol lookup.</li>
 139 <li>
 140 <em>public</em> ?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var" id="$decimalContext">$decimalContext<a class="permalink" href="ion/Reader/Options#%24decimalContext">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 141 Decimal context to use.</li>
 142 <li>
 143 <em>public</em> ?<code><a href="https://php.net/manual/en/class.closure">Closure</a></code> <span class="var" id="$onContextChange">$onContextChange<a class="permalink" href="ion/Reader/Options#%24onContextChange">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 144 Callback as function(<a href="ion/Reader">\ion\Reader</a>):void called upon local symbol table context change.</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="$returnSystemValues">$returnSystemValues<a class="permalink" href="ion/Reader/Options#%24returnSystemValues">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
 147 Whether to return otherwise hidden system values.</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/Reader/Options#%24maxContainerDepth">#</a></span> = 10<br>
 150 The 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/Reader/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="$annotationBufferSize">$annotationBufferSize<a class="permalink" href="ion/Reader/Options#%24annotationBufferSize">#</a></span> = 16384<br>
 156 The maximum number of bytes of all annotations on a single value.</li>
 157 <li>
 158 <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/Reader/Options#%24tempBufferSize">#</a></span> = 16384<br>
 159 The maximum number of bytes of a symbol/value/chunk.</li>
 160 <li>
 161 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$skipCharacterValidation">$skipCharacterValidation<a class="permalink" href="ion/Reader/Options#%24skipCharacterValidation">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
 162 Whether to skip <span class="constant">UTF</span>-8 validation.</li>
 163 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Reader/Options#Functions:">#</a>
 164 </h2><ul>
 165
 166         <li>
 167                 <h3 id="Options::__construct">
 168 <a href="ion/Reader/Options/__construct">Options::__construct</a><a class="permalink" href="ion/Reader/Options#Options::__construct">#</a>
 169 </h3>
 170
 171                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Reader/Options/__construct">ion\Reader\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/class.closure">Closure</a></code> <span class="var">$onContextChange</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">$returnSystemValues</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">$annotationBufferSize</span> = 16384, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$tempBufferSize</span> = 16384, [<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$skipCharacterValidation</span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code>]]]]]]]]])</p>
 172         </li>
 173
 174 </ul>
 175                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 176                         <script>
 177                                 var disqus_shortname = 'mdref';
 178                                 var disqus_identifier = 'ion/Reader/Options';
 179                         </script>
 180
 181                         <footer>
 182
 183 <ul>
 184         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 185 </a></li>
 186         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 187         <li>
 188 </li>
 189 </ul>
 190
 191                         </footer>
 192
 193                         <script src="index.js"></script>
 194
 195                 </div>
 196         </body>
 197 </html>