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

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Reader -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion\Reader\Reader">
  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/Reader/Reader">
  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/Reader">
  40                                                         Reader
  41                                                 </a>
  42                                                 <ul>
  43                                                         <li>
  44
  45                                                         &circlearrowright; <strong><a href="./ion/Reader/Reader">Reader</a></strong>
  46
  47
  48                                                         <ul>
  49
  50                                                                 <li>
  51                                                                         &rdsh; <a href="./ion/Reader/Reader/__construct">Reader::__construct</a>
  52
  53                                                                 </li>
  54
  55                                                         </ul>
  56
  57
  58                                                 </ul>
  59
  60                                                 <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
  61
  62                                                 <li>&ldsh; <a href="./ion/Reader/Options">Options</a></li>
  63
  64                                                 <li>&ldsh; <a href="./ion/Reader/Stream">Stream</a></li>
  65
  66                                                 <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
  67
  68                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
  69
  70                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
  71
  72                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
  73
  74                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
  75
  76                                                 <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
  77
  78                                                 <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
  79
  80                                                 <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
  81
  82                                                 <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
  83
  84                                                 <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
  85
  86                                                 <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
  87
  88                                                 <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
  89
  90                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
  91
  92                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
  93
  94                                                 <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
  95
  96                                                 <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
  97
  98                                                 <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
  99
 100                                                 <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
 101
 102                                                 <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
 103
 104                                                 <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
 105
 106                                                 <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
 107
 108                                                 <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
 109
 110                                                 <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
 111
 112                                                 <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
 113
 114                                                 <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
 115
 116                                                 <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
 117
 118                                                 <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
 119
 120                                                 <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
 121
 122                                         </ul>
 123
 124                                 </li>
 125                         </ul>
 126
 127                 </li>
 128         </ul>
 129 </div>
 130                                         <meta charset="utf-8"><h1>
 131 <a class="permalink" href="ion/Reader/Reader#">#</a><em>abstract</em> <em>class</em> <a href="ion/Reader/Reader">ion\Reader\Reader</a> <br>&nbsp;<em>implements</em> <a href="ion/Reader">ion\Reader</a>
 132 </h1><p>Base implementation of ION readers.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Reader/Reader#Constants:">#</a>
 133 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Reader/Reader#Properties:">#</a>
 134 </h2><ul>
 135 <li>
 136 <em>public</em> ?<a href="ion/Catalog">ion\Catalog</a> <span class="var" id="$catalog">$catalog<a class="permalink" href="ion/Reader/Reader#%24catalog">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 137 <span class="constant">ION</span> catalog to use for symbol lookup.</li>
 138 <li>
 139 <em>public</em> ?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var" id="$decimalContext">$decimalContext<a class="permalink" href="ion/Reader/Reader#%24decimalContext">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 140 Decimal context to use.</li>
 141 <li>
 142 <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/Reader#%24onContextChange">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 143 Callback as function(<a href="ion/Reader">\ion\Reader</a>):void called upon local symbol table context change.</li>
 144 <li>
 145 <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/Reader#%24returnSystemValues">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
 146 Whether to return otherwise hidden system values.</li>
 147 <li>
 148 <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/Reader#%24maxContainerDepth">#</a></span> = 10<br>
 149 The maximum depth of nested containers.</li>
 150 <li>
 151 <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/Reader#%24maxAnnotations">#</a></span> = 10<br>
 152 The maximum number of annotations allowed on a single value.</li>
 153 <li>
 154 <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/Reader#%24annotationBufferSize">#</a></span> = 16384<br>
 155 The maximum number of bytes of all annotations on a single value.</li>
 156 <li>
 157 <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/Reader#%24tempBufferSize">#</a></span> = 16384<br>
 158 The maximum number of bytes of a symbol/value/chunk.</li>
 159 <li>
 160 <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/Reader#%24skipCharacterValidation">#</a></span> = <code><a href="https://php.net/manual/en/language.types.boolean">false</a></code><br>
 161 Whether to skip <span class="constant">UTF</span>-8 validation.</li>
 162 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Reader/Reader#Functions:">#</a>
 163 </h2><ul class="sub-entries sub-functions">
 164
 165         <li>
 166                 <h3 id="Reader::__construct">
 167 <a href="ion/Reader/Reader/__construct">Reader::__construct</a><a class="permalink" href="ion/Reader/Reader#Reader::__construct">#</a>
 168 </h3>
 169
 170                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Reader/Reader/__construct">ion\Reader\Reader::__construct</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.resource">resource</a></code> <span class="var">$data</span>, [?<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>
 171         </li>
 172
 173 </ul>
 174                         <div class="comments">
 175                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 176         <script>
 177                 function giscus_load(button) {
 178                         let script = document.createElement("script");
 179                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 180                                                 script.setAttribute("data-category", 'Comments on Docs');
 181                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 182                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 183                                                 script.setAttribute("data-mapping", 'og:title');
 184                                                 script.setAttribute("data-input-position", 'bottom');
 185                                                 script.setAttribute("data-reactions-enabled", false);
 186                                                 script.setAttribute("data-theme", 'light');
 187                                                 script.setAttribute("data-lang", 'en');
 188
 189                         script.src = "//giscus.app/client.js";
 190                         button.parentNode.replaceChild(script, button);
 191                 }
 192         </script>
 193         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 194
 195                         </div>
 196
 197                         <footer>
 198
 199 <ul>
 200         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 201 </a></li>
 202         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 203         <li>
 204 </li>
 205 </ul>
 206
 207                         </footer>
 208
 209                         <script src="index.js" defer></script>
 210
 211                 </div>
 212         </body>
 213 </html>