mdref
</title>
<meta name="viewport" content="width=1200, initial-scale=0.5">
- <base href="/v0.0/">
- <meta http-equiv="Content-Location" content="/v0.0/ion/Reader">
+ <base href="/ext-ion/v0.0/">
+ <meta http-equiv="Content-Location" content="/ext-ion/v0.0/ion/Reader">
<link rel="stylesheet" href="index.css">
<link href="https://fonts.googleapis.com/css?family=Inconsolata&subset=latin-ext" rel="stylesheet">
<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
- <link rel="shortcut icon" href="/v0.0/favicon.ico">
+ <link rel="shortcut icon" href="/ext-ion/v0.0/favicon.ico">
</head>
<body>
<div class="page">
</ul>
+ <li>↲ <a href="./ion/: Contributing">★ Contributing</a></li>
+
+ <li>↲ <a href="./ion/: Security">★ Security</a></li>
+
<li>↲ <a href="./ion/Catalog">Catalog</a></li>
<li>↲ <a href="./ion/Decimal">Decimal</a></li>
</li>
</ul>
</div>
-
-<h1>interface ion\Reader implements Iterator, RecursiveIterator, Traversable</h1>
-<p>ION reader API.</p>
-<h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
-<p>None.</p>
-<h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
-<p>None.</p>
-
-
-
-<h2 id="Functions:">Functions:</h2>
-<ul>
+ <meta charset="utf-8"><h1>
+<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>
+</h1><p>ION reader API.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Reader#Constants:">#</a>
+</h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Reader#Properties:">#</a>
+</h2><p>None.</p><h2 id="Functions:">Functions:<a class="permalink" href="ion/Reader#Functions:">#</a>
+</h2><ul>
<li>
- <h3><a href="ion/Reader/countAnnotations">Reader::countAnnotations</a></h3>
+ <h3 id="Reader::countAnnotations">
+<a href="ion/Reader/countAnnotations">Reader::countAnnotations</a><a class="permalink" href="ion/Reader#Reader::countAnnotations">#</a>
+</h3>
- <p>int ion\Reader::countAnnotations()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getAnnotation">Reader::getAnnotation</a></h3>
+ <h3 id="Reader::getAnnotation">
+<a href="ion/Reader/getAnnotation">Reader::getAnnotation</a><a class="permalink" href="ion/Reader#Reader::getAnnotation">#</a>
+</h3>
- <p>string ion\Reader::getAnnotation(int $index)</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></h3>
+ <h3 id="Reader::getAnnotationSymbol">
+<a href="ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a><a class="permalink" href="ion/Reader#Reader::getAnnotationSymbol">#</a>
+</h3>
- <p>ion\Symbol ion\Reader::getAnnotationSymbol(int $index)</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></h3>
+ <h3 id="Reader::getAnnotationSymbols">
+<a href="ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a><a class="permalink" href="ion/Reader#Reader::getAnnotationSymbols">#</a>
+</h3>
- <p>array ion\Reader::getAnnotationSymbols()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getAnnotations">Reader::getAnnotations</a></h3>
+ <h3 id="Reader::getAnnotations">
+<a href="ion/Reader/getAnnotations">Reader::getAnnotations</a><a class="permalink" href="ion/Reader#Reader::getAnnotations">#</a>
+</h3>
- <p>array ion\Reader::getAnnotations()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getDepth">Reader::getDepth</a></h3>
+ <h3 id="Reader::getDepth">
+<a href="ion/Reader/getDepth">Reader::getDepth</a><a class="permalink" href="ion/Reader#Reader::getDepth">#</a>
+</h3>
- <p>int ion\Reader::getDepth()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getFieldName">Reader::getFieldName</a></h3>
+ <h3 id="Reader::getFieldName">
+<a href="ion/Reader/getFieldName">Reader::getFieldName</a><a class="permalink" href="ion/Reader#Reader::getFieldName">#</a>
+</h3>
- <p>string ion\Reader::getFieldName()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></h3>
+ <h3 id="Reader::getFieldNameSymbol">
+<a href="ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a><a class="permalink" href="ion/Reader#Reader::getFieldNameSymbol">#</a>
+</h3>
- <p>ion\Symbol ion\Reader::getFieldNameSymbol()</p>
+ <p><a href="ion/Symbol">ion\Symbol</a> <a href="ion/Reader/getFieldNameSymbol">ion\Reader::getFieldNameSymbol</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/getPosition">Reader::getPosition</a></h3>
+ <h3 id="Reader::getPosition">
+<a href="ion/Reader/getPosition">Reader::getPosition</a><a class="permalink" href="ion/Reader#Reader::getPosition">#</a>
+</h3>
- <p>int ion\Reader::getPosition()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getType">Reader::getType</a></h3>
+ <h3 id="Reader::getType">
+<a href="ion/Reader/getType">Reader::getType</a><a class="permalink" href="ion/Reader#Reader::getType">#</a>
+</h3>
- <p>ion\Type ion\Reader::getType()</p>
+ <p><a href="ion/Type">ion\Type</a> <a href="ion/Reader/getType">ion\Reader::getType</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/getValueLength">Reader::getValueLength</a></h3>
+ <h3 id="Reader::getValueLength">
+<a href="ion/Reader/getValueLength">Reader::getValueLength</a><a class="permalink" href="ion/Reader#Reader::getValueLength">#</a>
+</h3>
- <p>int ion\Reader::getValueLength()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/getValueOffset">Reader::getValueOffset</a></h3>
+ <h3 id="Reader::getValueOffset">
+<a href="ion/Reader/getValueOffset">Reader::getValueOffset</a><a class="permalink" href="ion/Reader#Reader::getValueOffset">#</a>
+</h3>
- <p>int ion\Reader::getValueOffset()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/hasAnnotation">Reader::hasAnnotation</a></h3>
+ <h3 id="Reader::hasAnnotation">
+<a href="ion/Reader/hasAnnotation">Reader::hasAnnotation</a><a class="permalink" href="ion/Reader#Reader::hasAnnotation">#</a>
+</h3>
- <p>bool ion\Reader::hasAnnotation(string $annotation)</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/hasAnnotations">Reader::hasAnnotations</a></h3>
+ <h3 id="Reader::hasAnnotations">
+<a href="ion/Reader/hasAnnotations">Reader::hasAnnotations</a><a class="permalink" href="ion/Reader#Reader::hasAnnotations">#</a>
+</h3>
- <p>bool ion\Reader::hasAnnotations()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/isInStruct">Reader::isInStruct</a></h3>
+ <h3 id="Reader::isInStruct">
+<a href="ion/Reader/isInStruct">Reader::isInStruct</a><a class="permalink" href="ion/Reader#Reader::isInStruct">#</a>
+</h3>
- <p>bool ion\Reader::isInStruct()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/isNull">Reader::isNull</a></h3>
+ <h3 id="Reader::isNull">
+<a href="ion/Reader/isNull">Reader::isNull</a><a class="permalink" href="ion/Reader#Reader::isNull">#</a>
+</h3>
- <p>bool ion\Reader::isNull()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readBool">Reader::readBool</a></h3>
+ <h3 id="Reader::readBool">
+<a href="ion/Reader/readBool">Reader::readBool</a><a class="permalink" href="ion/Reader#Reader::readBool">#</a>
+</h3>
- <p>bool ion\Reader::readBool()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readDecimal">Reader::readDecimal</a></h3>
+ <h3 id="Reader::readDecimal">
+<a href="ion/Reader/readDecimal">Reader::readDecimal</a><a class="permalink" href="ion/Reader#Reader::readDecimal">#</a>
+</h3>
- <p>ion\Decimal ion\Reader::readDecimal()</p>
+ <p><a href="ion/Decimal">ion\Decimal</a> <a href="ion/Reader/readDecimal">ion\Reader::readDecimal</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/readFloat">Reader::readFloat</a></h3>
+ <h3 id="Reader::readFloat">
+<a href="ion/Reader/readFloat">Reader::readFloat</a><a class="permalink" href="ion/Reader#Reader::readFloat">#</a>
+</h3>
- <p>float ion\Reader::readFloat()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readInt">Reader::readInt</a></h3>
+ <h3 id="Reader::readInt">
+<a href="ion/Reader/readInt">Reader::readInt</a><a class="permalink" href="ion/Reader#Reader::readInt">#</a>
+</h3>
- <p>string|int ion\Reader::readInt()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readLob">Reader::readLob</a></h3>
+ <h3 id="Reader::readLob">
+<a href="ion/Reader/readLob">Reader::readLob</a><a class="permalink" href="ion/Reader#Reader::readLob">#</a>
+</h3>
- <p>string ion\Reader::readLob()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readLobPart">Reader::readLobPart</a></h3>
+ <h3 id="Reader::readLobPart">
+<a href="ion/Reader/readLobPart">Reader::readLobPart</a><a class="permalink" href="ion/Reader#Reader::readLobPart">#</a>
+</h3>
- <p>bool ion\Reader::readLobPart( &$string, [int $length = 4096])</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readNull">Reader::readNull</a></h3>
+ <h3 id="Reader::readNull">
+<a href="ion/Reader/readNull">Reader::readNull</a><a class="permalink" href="ion/Reader#Reader::readNull">#</a>
+</h3>
- <p>ion\Type ion\Reader::readNull()</p>
+ <p><a href="ion/Type">ion\Type</a> <a href="ion/Reader/readNull">ion\Reader::readNull</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/readString">Reader::readString</a></h3>
+ <h3 id="Reader::readString">
+<a href="ion/Reader/readString">Reader::readString</a><a class="permalink" href="ion/Reader#Reader::readString">#</a>
+</h3>
- <p>string ion\Reader::readString()</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readStringPart">Reader::readStringPart</a></h3>
+ <h3 id="Reader::readStringPart">
+<a href="ion/Reader/readStringPart">Reader::readStringPart</a><a class="permalink" href="ion/Reader#Reader::readStringPart">#</a>
+</h3>
- <p>bool ion\Reader::readStringPart( &$string, [int $length = 4096])</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/readSymbol">Reader::readSymbol</a></h3>
+ <h3 id="Reader::readSymbol">
+<a href="ion/Reader/readSymbol">Reader::readSymbol</a><a class="permalink" href="ion/Reader#Reader::readSymbol">#</a>
+</h3>
- <p>ion\Symbol ion\Reader::readSymbol()</p>
+ <p><a href="ion/Symbol">ion\Symbol</a> <a href="ion/Reader/readSymbol">ion\Reader::readSymbol</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/readTimestamp">Reader::readTimestamp</a></h3>
+ <h3 id="Reader::readTimestamp">
+<a href="ion/Reader/readTimestamp">Reader::readTimestamp</a><a class="permalink" href="ion/Reader#Reader::readTimestamp">#</a>
+</h3>
- <p>ion\Timestamp ion\Reader::readTimestamp()</p>
+ <p><a href="ion/Timestamp">ion\Timestamp</a> <a href="ion/Reader/readTimestamp">ion\Reader::readTimestamp</a>()</p>
</li>
<li>
- <h3><a href="ion/Reader/seek">Reader::seek</a></h3>
+ <h3 id="Reader::seek">
+<a href="ion/Reader/seek">Reader::seek</a><a class="permalink" href="ion/Reader#Reader::seek">#</a>
+</h3>
- <p>void ion\Reader::seek(int $offset, [int $length = -1])</p>
+ <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>
</li>
-</ul>
-
-
-<h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
-<ul>
+</ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Reader#Namespaces.Interfaces.and.Classes:">#</a>
+</h2><ul>
<li>
- <h3><a href="ion/Reader/Buffer">Buffer</a></h3>
- <p>ION string buffer reader API.</p>
+ <h3 id="Buffer">
+<a href="ion/Reader/Buffer">Buffer</a><a class="permalink" href="ion/Reader#Buffer">#</a>
+</h3>
+ <p>ION <code><a href="https://php.net/manual/en/language.types.string">string</a></code> buffer reader API.</p>
- <p>interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
+ <p><em>interface</em> <a href="ion/Reader/Buffer">ion\Reader\Buffer</a> <em>implements</em> <a href="ion/Reader">ion\Reader</a></p>
</li>
<li>
- <h3><a href="ion/Reader/Options">Options</a></h3>
+ <h3 id="Options">
+<a href="ion/Reader/Options">Options</a><a class="permalink" href="ion/Reader#Options">#</a>
+</h3>
<p>Reader options.</p>
- <p>class ion\Reader\Options</p>
+ <p><em>class</em> <a href="ion/Reader/Options">ion\Reader\Options</a></p>
</li>
<li>
- <h3><a href="ion/Reader/Reader">Reader</a></h3>
+ <h3 id="Reader">
+<a href="ion/Reader/Reader">Reader</a><a class="permalink" href="ion/Reader#Reader">#</a>
+</h3>
<p>Base implementation of ION readers.</p>
- <p>abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
+ <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>
</li>
<li>
- <h3><a href="ion/Reader/Stream">Stream</a></h3>
+ <h3 id="Stream">
+<a href="ion/Reader/Stream">Stream</a><a class="permalink" href="ion/Reader#Stream">#</a>
+</h3>
<p>ION stream reader API.</p>
- <p>interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
+ <p><em>interface</em> <a href="ion/Reader/Stream">ion\Reader\Stream</a> <em>implements</em> <a href="ion/Reader">ion\Reader</a></p>
</li>
-</ul>
-
+</ul>
<div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
<script>
var disqus_shortname = 'mdref';
<footer>
<ul>
- <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
+ <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
</a></li>
<li><a href="LICENSE">© 2013-2022 All rights reserved.</a></li>
<li>
projects / awesomized / ext-ion / blobdiff