prepare 0.2.0
[awesomized/ext-ion] / docs / v0.2 / ion / Writer.html
diff --git a/docs/v0.2/ion/Writer.html b/docs/v0.2/ion/Writer.html
new file mode 100644 (file)
index 0000000..6c8e617
--- /dev/null
@@ -0,0 +1,478 @@
+<!doctype html>
+<html>
+       <head>
+               <meta charset="utf-8">
+               <title>
+                                                       Writer -
+                                               mdref
+               </title>
+               <meta property="og:title" content="ion\Writer">
+               <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/Writer">
+                       <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>
+                                                                                       
+                                                       &circlearrowright; <strong><a href="./ion/Writer">Writer</a></strong>
+
+                                                       
+                                                       <ul>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/Buffer">Buffer</a>
+                                                                               
+                                                                       <ul>
+                                                                                               
+                                                                               <li>&rdsh; <a href="./ion/Writer/Buffer/Writer">Writer</a>
+                                                                               </li>
+                                                                                                                                                                                                                               
+                                                                       </ul>
+
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/Options">Options</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/Stream">Stream</a>
+                                                                               
+                                                                       <ul>
+                                                                                               
+                                                                               <li>&rdsh; <a href="./ion/Writer/Stream/Writer">Writer</a>
+                                                                               </li>
+                                                                                                                                               
+                                                                       </ul>
+
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/Writer">Writer</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/finish">Writer::finish</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/flush">Writer::flush</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/startLob">Writer::startLob</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeString">Writer::writeString</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                       </ul>
+                                                       
+                                                                                                                                                                                                                                                               
+                                               </ul>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/: Tutorial">★ Tutorial</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Type">Type</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
+                                                                                                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
+                                                                                                                                                       
+                                               <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
+                               </li>
+                       </ul>
+                       
+               </li>
+       </ul>
+</div>
+                                       <meta charset="utf-8"><h1>
+<a class="permalink" href="ion/Writer#">#</a><em>interface</em> <a href="ion/Writer">ion\Writer</a>
+</h1><p>ION writer API.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Writer#Constants:">#</a>
+</h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Writer#Properties:">#</a>
+</h2><p>None.</p><h2 id="Functions:">Functions:<a class="permalink" href="ion/Writer#Functions:">#</a>
+</h2><ul class="sub-entries sub-functions">
+       
+       <li>
+               <h3 id="Writer::appendLob">
+<a href="ion/Writer/appendLob">Writer::appendLob</a><a class="permalink" href="ion/Writer#Writer::appendLob">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/appendLob">ion\Writer::appendLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$data</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::finish">
+<a href="ion/Writer/finish">Writer::finish</a><a class="permalink" href="ion/Writer#Writer::finish">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/finish">ion\Writer::finish</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::finishContainer">
+<a href="ion/Writer/finishContainer">Writer::finishContainer</a><a class="permalink" href="ion/Writer#Writer::finishContainer">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/finishContainer">ion\Writer::finishContainer</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::finishLob">
+<a href="ion/Writer/finishLob">Writer::finishLob</a><a class="permalink" href="ion/Writer#Writer::finishLob">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/finishLob">ion\Writer::finishLob</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::flush">
+<a href="ion/Writer/flush">Writer::flush</a><a class="permalink" href="ion/Writer#Writer::flush">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/flush">ion\Writer::flush</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::getDepth">
+<a href="ion/Writer/getDepth">Writer::getDepth</a><a class="permalink" href="ion/Writer#Writer::getDepth">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/getDepth">ion\Writer::getDepth</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::startContainer">
+<a href="ion/Writer/startContainer">Writer::startContainer</a><a class="permalink" href="ion/Writer#Writer::startContainer">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/startContainer">ion\Writer::startContainer</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::startLob">
+<a href="ion/Writer/startLob">Writer::startLob</a><a class="permalink" href="ion/Writer#Writer::startLob">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/startLob">ion\Writer::startLob</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeAnnotation">
+<a href="ion/Writer/writeAnnotation">Writer::writeAnnotation</a><a class="permalink" href="ion/Writer#Writer::writeAnnotation">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeAnnotation">ion\Writer::writeAnnotation</a>([<a href="ion/Symbol">ion\Symbol</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code>   ?&gt;...<span class="var">$annotation</span>])</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeBLob">
+<a href="ion/Writer/writeBLob">Writer::writeBLob</a><a class="permalink" href="ion/Writer#Writer::writeBLob">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeBLob">ion\Writer::writeBLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeBool">
+<a href="ion/Writer/writeBool">Writer::writeBool</a><a class="permalink" href="ion/Writer#Writer::writeBool">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeBool">ion\Writer::writeBool</a>(<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeCLob">
+<a href="ion/Writer/writeCLob">Writer::writeCLob</a><a class="permalink" href="ion/Writer#Writer::writeCLob">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeCLob">ion\Writer::writeCLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeDecimal">
+<a href="ion/Writer/writeDecimal">Writer::writeDecimal</a><a class="permalink" href="ion/Writer#Writer::writeDecimal">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeDecimal">ion\Writer::writeDecimal</a>(<a href="ion/Decimal">ion\Decimal</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeFieldName">
+<a href="ion/Writer/writeFieldName">Writer::writeFieldName</a><a class="permalink" href="ion/Writer#Writer::writeFieldName">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeFieldName">ion\Writer::writeFieldName</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$name</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeFloat">
+<a href="ion/Writer/writeFloat">Writer::writeFloat</a><a class="permalink" href="ion/Writer#Writer::writeFloat">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeFloat">ion\Writer::writeFloat</a>(<code><a href="https://php.net/manual/en/language.types.float">float</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeInt">
+<a href="ion/Writer/writeInt">Writer::writeInt</a><a class="permalink" href="ion/Writer#Writer::writeInt">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeInt">ion\Writer::writeInt</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.integer">int</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeNull">
+<a href="ion/Writer/writeNull">Writer::writeNull</a><a class="permalink" href="ion/Writer#Writer::writeNull">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeNull">ion\Writer::writeNull</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeString">
+<a href="ion/Writer/writeString">Writer::writeString</a><a class="permalink" href="ion/Writer#Writer::writeString">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeString">ion\Writer::writeString</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeSymbol">
+<a href="ion/Writer/writeSymbol">Writer::writeSymbol</a><a class="permalink" href="ion/Writer#Writer::writeSymbol">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeSymbol">ion\Writer::writeSymbol</a>(<a href="ion/Symbol">ion\Symbol</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeTimestamp">
+<a href="ion/Writer/writeTimestamp">Writer::writeTimestamp</a><a class="permalink" href="ion/Writer#Writer::writeTimestamp">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeTimestamp">ion\Writer::writeTimestamp</a>(<a href="ion/Timestamp">ion\Timestamp</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Writer::writeTypedNull">
+<a href="ion/Writer/writeTypedNull">Writer::writeTypedNull</a><a class="permalink" href="ion/Writer#Writer::writeTypedNull">#</a>
+</h3>
+               
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeTypedNull">ion\Writer::writeTypedNull</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
+       </li>
+       
+</ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Writer#Namespaces.Interfaces.and.Classes:">#</a>
+</h2><ul class="sub-entries sub-ns-classes">
+       
+       <li>
+               <h3 id="Buffer">
+<a href="ion/Writer/Buffer">Buffer</a><a class="permalink" href="ion/Writer#Buffer">#</a>
+</h3>
+               <p>ION buffer writer API.</p>
+
+               <p><em>interface</em> <a href="ion/Writer/Buffer">ion\Writer\Buffer</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></p>
+       </li>
+       
+       <li>
+               <h3 id="Options">
+<a href="ion/Writer/Options">Options</a><a class="permalink" href="ion/Writer#Options">#</a>
+</h3>
+               <p>ION writer options.</p>
+
+               <p><em>class</em> <a href="ion/Writer/Options">ion\Writer\Options</a></p>
+       </li>
+       
+       <li>
+               <h3 id="Stream">
+<a href="ion/Writer/Stream">Stream</a><a class="permalink" href="ion/Writer#Stream">#</a>
+</h3>
+               <p>ION stream writer API.</p>
+
+               <p><em>interface</em> <a href="ion/Writer/Stream">ion\Writer\Stream</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></p>
+       </li>
+       
+       <li>
+               <h3 id="Writer">
+<a href="ion/Writer/Writer">Writer</a><a class="permalink" href="ion/Writer#Writer">#</a>
+</h3>
+               <p>Base implementation of common functionality of ION writers.</p>
+
+               <p><em>abstract</em> <em>class</em> <a href="ion/Writer/Writer">ion\Writer\Writer</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></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>