9 <meta property=
"og:title" content=
"ion\Reader">
10 <meta name=
"viewport" content=
"width=1200, initial-scale=0.5">
11 <base href=
"/ext-ion/v0.1/">
12 <meta http-equiv=
"Content-Location" content=
"/ext-ion/v0.1/ion/Reader">
13 <link rel=
"stylesheet" href=
"index.css">
15 <link rel=
"shortcut icon" href=
"/ext-ion/v0.1/favicon.ico">
23 <a href=
"https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit
</a>
28 <li>↰ <a href=
"./">Home
</a>
33 ↑ <a href=
"./ion">
39 ↻ <strong><a href=
"./ion/Reader">Reader
</a></strong>
45 ↳ <a href=
"./ion/Reader/Buffer">Buffer
</a>
49 <li>↳ <a href=
"./ion/Reader/Buffer/Reader">Reader
</a>
57 ↳ <a href=
"./ion/Reader/Options">Options
</a>
62 ↳ <a href=
"./ion/Reader/Reader">Reader
</a>
67 ↳ <a href=
"./ion/Reader/Stream">Stream
</a>
71 <li>↳ <a href=
"./ion/Reader/Stream/Reader">Reader
</a>
79 ↳ <a href=
"./ion/Reader/countAnnotations">Reader::countAnnotations
</a>
84 ↳ <a href=
"./ion/Reader/getAnnotation">Reader::getAnnotation
</a>
89 ↳ <a href=
"./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol
</a>
94 ↳ <a href=
"./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols
</a>
99 ↳ <a href=
"./ion/Reader/getAnnotations">Reader::getAnnotations
</a>
104 ↳ <a href=
"./ion/Reader/getDepth">Reader::getDepth
</a>
109 ↳ <a href=
"./ion/Reader/getFieldName">Reader::getFieldName
</a>
114 ↳ <a href=
"./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol
</a>
119 ↳ <a href=
"./ion/Reader/getPosition">Reader::getPosition
</a>
124 ↳ <a href=
"./ion/Reader/getType">Reader::getType
</a>
129 ↳ <a href=
"./ion/Reader/getValueLength">Reader::getValueLength
</a>
134 ↳ <a href=
"./ion/Reader/getValueOffset">Reader::getValueOffset
</a>
139 ↳ <a href=
"./ion/Reader/hasAnnotation">Reader::hasAnnotation
</a>
144 ↳ <a href=
"./ion/Reader/hasAnnotations">Reader::hasAnnotations
</a>
149 ↳ <a href=
"./ion/Reader/isInStruct">Reader::isInStruct
</a>
154 ↳ <a href=
"./ion/Reader/isNull">Reader::isNull
</a>
159 ↳ <a href=
"./ion/Reader/readBool">Reader::readBool
</a>
164 ↳ <a href=
"./ion/Reader/readDecimal">Reader::readDecimal
</a>
169 ↳ <a href=
"./ion/Reader/readFloat">Reader::readFloat
</a>
174 ↳ <a href=
"./ion/Reader/readInt">Reader::readInt
</a>
179 ↳ <a href=
"./ion/Reader/readLob">Reader::readLob
</a>
184 ↳ <a href=
"./ion/Reader/readLobPart">Reader::readLobPart
</a>
189 ↳ <a href=
"./ion/Reader/readNull">Reader::readNull
</a>
194 ↳ <a href=
"./ion/Reader/readString">Reader::readString
</a>
199 ↳ <a href=
"./ion/Reader/readStringPart">Reader::readStringPart
</a>
204 ↳ <a href=
"./ion/Reader/readSymbol">Reader::readSymbol
</a>
209 ↳ <a href=
"./ion/Reader/readTimestamp">Reader::readTimestamp
</a>
214 ↳ <a href=
"./ion/Reader/seek">Reader::seek
</a>
223 <li>↲ <a href=
"./ion/: Contributing">★ Contributing
</a></li>
225 <li>↲ <a href=
"./ion/: Security">★ Security
</a></li>
227 <li>↲ <a href=
"./ion/Catalog">Catalog
</a></li>
229 <li>↲ <a href=
"./ion/Decimal">Decimal
</a></li>
231 <li>↲ <a href=
"./ion/Exception">Exception
</a></li>
233 <li>↲ <a href=
"./ion/LOB">LOB
</a></li>
235 <li>↲ <a href=
"./ion/Serializer">Serializer
</a></li>
237 <li>↲ <a href=
"./ion/Symbol">Symbol
</a></li>
239 <li>↲ <a href=
"./ion/Timestamp">Timestamp
</a></li>
241 <li>↲ <a href=
"./ion/Type">Type
</a></li>
243 <li>↲ <a href=
"./ion/Unserializer">Unserializer
</a></li>
245 <li>↲ <a href=
"./ion/Writer">Writer
</a></li>
247 <li>↲ <a href=
"./ion/serialize">serialize
</a></li>
249 <li>↲ <a href=
"./ion/unserialize">unserialize
</a></li>
257 <meta charset=
"utf-8"><h1>
258 <a class=
"permalink" href=
"ion/Reader#">#
</a><em>interface
</em> <a href=
"ion/Reader">ion\Reader
</a> <br> <em>implements
</em> <code><a href=
"https://php.net/manual/en/class.recursiveiterator">RecursiveIterator
</a></code>
259 </h1><p>ION reader API.
</p><h2 id=
"Constants:">Constants:
<a class=
"permalink" href=
"ion/Reader#Constants:">#
</a>
260 </h2><p>None.
</p><h2 id=
"Properties:">Properties:
<a class=
"permalink" href=
"ion/Reader#Properties:">#
</a>
261 </h2><p>None.
</p><h2 id=
"Functions:">Functions:
<a class=
"permalink" href=
"ion/Reader#Functions:">#
</a>
262 </h2><ul class=
"sub-entries sub-functions">
265 <h3 id=
"Reader::countAnnotations">
266 <a href=
"ion/Reader/countAnnotations">Reader::countAnnotations
</a><a class=
"permalink" href=
"ion/Reader#Reader::countAnnotations">#
</a>
269 <p><code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/countAnnotations">ion\Reader::countAnnotations
</a>()
</p>
273 <h3 id=
"Reader::getAnnotation">
274 <a href=
"ion/Reader/getAnnotation">Reader::getAnnotation
</a><a class=
"permalink" href=
"ion/Reader#Reader::getAnnotation">#
</a>
277 <p><code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> <a href=
"ion/Reader/getAnnotation">ion\Reader::getAnnotation
</a>(
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$index
</span>)
</p>
281 <h3 id=
"Reader::getAnnotationSymbol">
282 <a href=
"ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol
</a><a class=
"permalink" href=
"ion/Reader#Reader::getAnnotationSymbol">#
</a>
285 <p><a href=
"ion/Symbol">ion\Symbol
</a> <a href=
"ion/Reader/getAnnotationSymbol">ion\Reader::getAnnotationSymbol
</a>(
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$index
</span>)
</p>
289 <h3 id=
"Reader::getAnnotationSymbols">
290 <a href=
"ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols
</a><a class=
"permalink" href=
"ion/Reader#Reader::getAnnotationSymbols">#
</a>
293 <p><code><a href=
"https://php.net/manual/en/language.types.array">array
</a></code> <a href=
"ion/Reader/getAnnotationSymbols">ion\Reader::getAnnotationSymbols
</a>()
</p>
297 <h3 id=
"Reader::getAnnotations">
298 <a href=
"ion/Reader/getAnnotations">Reader::getAnnotations
</a><a class=
"permalink" href=
"ion/Reader#Reader::getAnnotations">#
</a>
301 <p><code><a href=
"https://php.net/manual/en/language.types.array">array
</a></code> <a href=
"ion/Reader/getAnnotations">ion\Reader::getAnnotations
</a>()
</p>
305 <h3 id=
"Reader::getDepth">
306 <a href=
"ion/Reader/getDepth">Reader::getDepth
</a><a class=
"permalink" href=
"ion/Reader#Reader::getDepth">#
</a>
309 <p><code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/getDepth">ion\Reader::getDepth
</a>()
</p>
313 <h3 id=
"Reader::getFieldName">
314 <a href=
"ion/Reader/getFieldName">Reader::getFieldName
</a><a class=
"permalink" href=
"ion/Reader#Reader::getFieldName">#
</a>
317 <p><code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> <a href=
"ion/Reader/getFieldName">ion\Reader::getFieldName
</a>()
</p>
321 <h3 id=
"Reader::getFieldNameSymbol">
322 <a href=
"ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol
</a><a class=
"permalink" href=
"ion/Reader#Reader::getFieldNameSymbol">#
</a>
325 <p><a href=
"ion/Symbol">ion\Symbol
</a> <a href=
"ion/Reader/getFieldNameSymbol">ion\Reader::getFieldNameSymbol
</a>()
</p>
329 <h3 id=
"Reader::getPosition">
330 <a href=
"ion/Reader/getPosition">Reader::getPosition
</a><a class=
"permalink" href=
"ion/Reader#Reader::getPosition">#
</a>
333 <p><code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/getPosition">ion\Reader::getPosition
</a>()
</p>
337 <h3 id=
"Reader::getType">
338 <a href=
"ion/Reader/getType">Reader::getType
</a><a class=
"permalink" href=
"ion/Reader#Reader::getType">#
</a>
341 <p><a href=
"ion/Type">ion\Type
</a> <a href=
"ion/Reader/getType">ion\Reader::getType
</a>()
</p>
345 <h3 id=
"Reader::getValueLength">
346 <a href=
"ion/Reader/getValueLength">Reader::getValueLength
</a><a class=
"permalink" href=
"ion/Reader#Reader::getValueLength">#
</a>
349 <p><code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/getValueLength">ion\Reader::getValueLength
</a>()
</p>
353 <h3 id=
"Reader::getValueOffset">
354 <a href=
"ion/Reader/getValueOffset">Reader::getValueOffset
</a><a class=
"permalink" href=
"ion/Reader#Reader::getValueOffset">#
</a>
357 <p><code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/getValueOffset">ion\Reader::getValueOffset
</a>()
</p>
361 <h3 id=
"Reader::hasAnnotation">
362 <a href=
"ion/Reader/hasAnnotation">Reader::hasAnnotation
</a><a class=
"permalink" href=
"ion/Reader#Reader::hasAnnotation">#
</a>
365 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/hasAnnotation">ion\Reader::hasAnnotation
</a>(
<code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> <span class=
"var">$annotation
</span>)
</p>
369 <h3 id=
"Reader::hasAnnotations">
370 <a href=
"ion/Reader/hasAnnotations">Reader::hasAnnotations
</a><a class=
"permalink" href=
"ion/Reader#Reader::hasAnnotations">#
</a>
373 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/hasAnnotations">ion\Reader::hasAnnotations
</a>()
</p>
377 <h3 id=
"Reader::isInStruct">
378 <a href=
"ion/Reader/isInStruct">Reader::isInStruct
</a><a class=
"permalink" href=
"ion/Reader#Reader::isInStruct">#
</a>
381 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/isInStruct">ion\Reader::isInStruct
</a>()
</p>
385 <h3 id=
"Reader::isNull">
386 <a href=
"ion/Reader/isNull">Reader::isNull
</a><a class=
"permalink" href=
"ion/Reader#Reader::isNull">#
</a>
389 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/isNull">ion\Reader::isNull
</a>()
</p>
393 <h3 id=
"Reader::readBool">
394 <a href=
"ion/Reader/readBool">Reader::readBool
</a><a class=
"permalink" href=
"ion/Reader#Reader::readBool">#
</a>
397 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/readBool">ion\Reader::readBool
</a>()
</p>
401 <h3 id=
"Reader::readDecimal">
402 <a href=
"ion/Reader/readDecimal">Reader::readDecimal
</a><a class=
"permalink" href=
"ion/Reader#Reader::readDecimal">#
</a>
405 <p><a href=
"ion/Decimal">ion\Decimal
</a> <a href=
"ion/Reader/readDecimal">ion\Reader::readDecimal
</a>()
</p>
409 <h3 id=
"Reader::readFloat">
410 <a href=
"ion/Reader/readFloat">Reader::readFloat
</a><a class=
"permalink" href=
"ion/Reader#Reader::readFloat">#
</a>
413 <p><code><a href=
"https://php.net/manual/en/language.types.float">float
</a></code> <a href=
"ion/Reader/readFloat">ion\Reader::readFloat
</a>()
</p>
417 <h3 id=
"Reader::readInt">
418 <a href=
"ion/Reader/readInt">Reader::readInt
</a><a class=
"permalink" href=
"ion/Reader#Reader::readInt">#
</a>
421 <p><code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code>|
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <a href=
"ion/Reader/readInt">ion\Reader::readInt
</a>()
</p>
425 <h3 id=
"Reader::readLob">
426 <a href=
"ion/Reader/readLob">Reader::readLob
</a><a class=
"permalink" href=
"ion/Reader#Reader::readLob">#
</a>
429 <p><code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> <a href=
"ion/Reader/readLob">ion\Reader::readLob
</a>()
</p>
433 <h3 id=
"Reader::readLobPart">
434 <a href=
"ion/Reader/readLobPart">Reader::readLobPart
</a><a class=
"permalink" href=
"ion/Reader#Reader::readLobPart">#
</a>
437 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/readLobPart">ion\Reader::readLobPart
</a>(
&<span class=
"var">$string
</span>, [
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$length
</span> =
4096])
</p>
441 <h3 id=
"Reader::readNull">
442 <a href=
"ion/Reader/readNull">Reader::readNull
</a><a class=
"permalink" href=
"ion/Reader#Reader::readNull">#
</a>
445 <p><a href=
"ion/Type">ion\Type
</a> <a href=
"ion/Reader/readNull">ion\Reader::readNull
</a>()
</p>
449 <h3 id=
"Reader::readString">
450 <a href=
"ion/Reader/readString">Reader::readString
</a><a class=
"permalink" href=
"ion/Reader#Reader::readString">#
</a>
453 <p><code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> <a href=
"ion/Reader/readString">ion\Reader::readString
</a>()
</p>
457 <h3 id=
"Reader::readStringPart">
458 <a href=
"ion/Reader/readStringPart">Reader::readStringPart
</a><a class=
"permalink" href=
"ion/Reader#Reader::readStringPart">#
</a>
461 <p><code><a href=
"https://php.net/manual/en/language.types.boolean">bool
</a></code> <a href=
"ion/Reader/readStringPart">ion\Reader::readStringPart
</a>(
&<span class=
"var">$string
</span>, [
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$length
</span> =
4096])
</p>
465 <h3 id=
"Reader::readSymbol">
466 <a href=
"ion/Reader/readSymbol">Reader::readSymbol
</a><a class=
"permalink" href=
"ion/Reader#Reader::readSymbol">#
</a>
469 <p><a href=
"ion/Symbol">ion\Symbol
</a> <a href=
"ion/Reader/readSymbol">ion\Reader::readSymbol
</a>()
</p>
473 <h3 id=
"Reader::readTimestamp">
474 <a href=
"ion/Reader/readTimestamp">Reader::readTimestamp
</a><a class=
"permalink" href=
"ion/Reader#Reader::readTimestamp">#
</a>
477 <p><a href=
"ion/Timestamp">ion\Timestamp
</a> <a href=
"ion/Reader/readTimestamp">ion\Reader::readTimestamp
</a>()
</p>
481 <h3 id=
"Reader::seek">
482 <a href=
"ion/Reader/seek">Reader::seek
</a><a class=
"permalink" href=
"ion/Reader#Reader::seek">#
</a>
485 <p><code><a href=
"https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void
</a></code> <a href=
"ion/Reader/seek">ion\Reader::seek
</a>(
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$offset
</span>, [
<code><a href=
"https://php.net/manual/en/language.types.integer">int
</a></code> <span class=
"var">$length
</span> = -
1])
</p>
488 </ul><h2 id=
"Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:
<a class=
"permalink" href=
"ion/Reader#Namespaces.Interfaces.and.Classes:">#
</a>
489 </h2><ul class=
"sub-entries sub-ns-classes">
493 <a href=
"ion/Reader/Buffer">Buffer
</a><a class=
"permalink" href=
"ion/Reader#Buffer">#
</a>
495 <p>ION
<code><a href=
"https://php.net/manual/en/language.types.string">string
</a></code> buffer reader API.
</p>
497 <p><em>interface
</em> <a href=
"ion/Reader/Buffer">ion\Reader\Buffer
</a> <em>implements
</em> <a href=
"ion/Reader">ion\Reader
</a></p>
502 <a href=
"ion/Reader/Options">Options
</a><a class=
"permalink" href=
"ion/Reader#Options">#
</a>
504 <p>Reader options.
</p>
506 <p><em>class
</em> <a href=
"ion/Reader/Options">ion\Reader\Options
</a></p>
511 <a href=
"ion/Reader/Reader">Reader
</a><a class=
"permalink" href=
"ion/Reader#Reader">#
</a>
513 <p>Base implementation of ION readers.
</p>
515 <p><em>abstract
</em> <em>class
</em> <a href=
"ion/Reader/Reader">ion\Reader\Reader
</a> <em>implements
</em> <a href=
"ion/Reader">ion\Reader
</a></p>
520 <a href=
"ion/Reader/Stream">Stream
</a><a class=
"permalink" href=
"ion/Reader#Stream">#
</a>
522 <p>ION stream reader API.
</p>
524 <p><em>interface
</em> <a href=
"ion/Reader/Stream">ion\Reader\Stream
</a> <em>implements
</em> <a href=
"ion/Reader">ion\Reader
</a></p>
528 <div class=
"comments">
529 <style>.giscus-frame {min-height:
16em;}
</style>
531 function giscus_load(button) {
532 let script = document.createElement(
"script");
533 script.setAttribute(
"data-repo", 'awesomized/ext-ion');
534 script.setAttribute(
"data-category", 'Comments on Docs');
535 script.setAttribute(
"data-repo-id", 'R_kgDOGfXEXw');
536 script.setAttribute(
"data-category-id", 'DIC_kwDOGfXEX84CBHuf');
537 script.setAttribute(
"data-mapping", 'og:title');
538 script.setAttribute(
"data-input-position", 'bottom');
539 script.setAttribute(
"data-reactions-enabled", false);
540 script.setAttribute(
"data-theme", 'light');
541 script.setAttribute(
"data-lang", 'en');
543 script.src =
"//giscus.app/client.js";
544 button.parentNode.replaceChild(script, button);
547 <button class=
"activator" onclick=
"giscus_load(this)">Show Comments from Github Discussions
</button>
554 <li><a href=
"https://github.com/m6w6/mdref">mdref-v3.0
556 <li><a href=
"LICENSE">© 2013-
2022 All rights reserved.
</a></li>
563 <script src=
"index.js" defer
></script>