prepare 0.2.0
[awesomized/ext-ion] / docs / v0.2 / ion / Reader / Options.html
diff --git a/docs/v0.2/ion/Reader/Options.html b/docs/v0.2/ion/Reader/Options.html
new file mode 100644 (file)
index 0000000..3e2fe33
--- /dev/null
@@ -0,0 +1,213 @@
+<!doctype html>
+<html>
+       <head>
+               <meta charset="utf-8">
+               <title>
+                                                       Options -
+                                               mdref
+               </title>
+               <meta property="og:title" content="ion\Reader\Options">
+               <meta name="viewport" content="width=1200, initial-scale=0.5">
+                                       <base href="/ext-ion/v0.2/">
+                       <meta http-equiv="Content-Location" content="/ext-ion/v0.2/ion/Reader/Options">
+                       <link rel="stylesheet" href="index.css">
+               
+               <link rel="shortcut icon" href="/ext-ion/v0.2/favicon.ico">
+       </head>
+       <body>
+               <div class="page">
+               
+<div class="sidebar">
+       
+       <div class="edit">
+               <a href="https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit</a>
+       </div>
+       
+       
+       <ul>
+               <li>&lsh; <a href="./">Home</a>
+                       
+                       <ul>
+                               <li>
+                                                                                       
+                                       &uarr; <a href="./ion">
+                                                       ion
+                                               </a>
+                                               <ul>
+                                                       <li>
+                                                                                                                                       
+                                       &uarr; <a href="./ion/Reader">
+                                                       Reader
+                                               </a>
+                                               <ul>
+                                                       <li>
+                                                                                       
+                                                       &circlearrowright; <strong><a href="./ion/Reader/Options">Options</a></strong>
+
+                                                       
+                                                       <ul>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Reader/Options/__construct">Options::__construct</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                       </ul>
+                                                       
+                                                                                                                                                                                                                                                               
+                                               </ul>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
+                                                                                                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/Reader">Reader</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/Stream">Stream</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
+                                       </ul>
+                                                                                                       
+                               </li>
+                       </ul>
+                       
+               </li>
+       </ul>
+</div>
+                                       <meta charset="utf-8"><h1>
+<a class="permalink" href="ion/Reader/Options#">#</a><em>class</em> <a href="ion/Reader/Options">ion\Reader\Options</a>
+</h1><p>Reader options.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Reader/Options#Constants:">#</a>
+</h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Reader/Options#Properties:">#</a>
+</h2><ul>
+<li>
+<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>
+<span class="constant">ION</span> catalog to use for symbol lookup.</li>
+<li>
+<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>
+Decimal context to use.</li>
+<li>
+<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>
+Callback as function(<a href="ion/Reader">\ion\Reader</a>):void called upon local symbol table context change.</li>
+<li>
+<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>
+Whether to return otherwise hidden system values.</li>
+<li>
+<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>
+The maximum depth of nested containers.</li>
+<li>
+<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>
+The maximum number of annotations allowed on a single value.</li>
+<li>
+<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>
+The maximum number of bytes of all annotations on a single value.</li>
+<li>
+<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>
+The maximum number of bytes of a symbol/value/chunk.</li>
+<li>
+<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>
+Whether to skip <span class="constant">UTF</span>-8 validation.</li>
+</ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Reader/Options#Functions:">#</a>
+</h2><ul class="sub-entries sub-functions">
+       
+       <li>
+               <h3 id="Options::__construct">
+<a href="ion/Reader/Options/__construct">Options::__construct</a><a class="permalink" href="ion/Reader/Options#Options::__construct">#</a>
+</h3>
+               
+               <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>
+       </li>
+       
+</ul>                          
+                       <div class="comments">
+                                                                               <style>.giscus-frame {min-height: 16em;}</style>
+       <script>
+               function giscus_load(button) {
+                       let script = document.createElement("script");
+                                               script.setAttribute("data-repo", 'awesomized/ext-ion');
+                                               script.setAttribute("data-category", 'Comments on Docs');
+                                               script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
+                                               script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
+                                               script.setAttribute("data-mapping", 'og:title');
+                                               script.setAttribute("data-input-position", 'bottom');
+                                               script.setAttribute("data-reactions-enabled", false);
+                                               script.setAttribute("data-theme", 'light');
+                                               script.setAttribute("data-lang", 'en');
+                       
+                       script.src = "//giscus.app/client.js";
+                       button.parentNode.replaceChild(script, button);
+               }
+       </script>
+       <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
+                               
+                       </div>
+               
+                       <footer>
+                               
+<ul>
+       <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
+</a></li>
+       <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
+       <li>
+</li>
+</ul>
+
+                       </footer>
+               
+                       <script src="index.js" defer></script>
+               
+               </div>
+       </body>
+</html>