prepare 0.2.0
[awesomized/ext-ion] / docs / v0.2 / ion / Catalog.html
diff --git a/docs/v0.2/ion/Catalog.html b/docs/v0.2/ion/Catalog.html
new file mode 100644 (file)
index 0000000..a25cc71
--- /dev/null
@@ -0,0 +1,207 @@
+<!doctype html>
+<html>
+       <head>
+               <meta charset="utf-8">
+               <title>
+                                                       Catalog -
+                                               mdref
+               </title>
+               <meta property="og:title" content="ion\Catalog">
+               <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/Catalog">
+                       <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/Catalog">Catalog</a></strong>
+
+                                                       
+                                                       <ul>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Catalog/__construct">Catalog::__construct</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Catalog/add">Catalog::add</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Catalog/find">Catalog::find</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Catalog/findBest">Catalog::findBest</a>
+                                                                       
+                                                               </li>
+                                                               
+                                                               <li>
+                                                                       &rdsh; <a href="./ion/Catalog/remove">Catalog::remove</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/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/Writer">Writer</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/Catalog#">#</a><em>class</em> <a href="ion/Catalog">ion\Catalog</a> <br>&nbsp;<em>implements</em> <code><a href="https://php.net/manual/en/class.countable">Countable</a></code>
+</h1><p>The Catalog holds a collection of <a href="ion/Symbol/Table">ion\Symbol\Table</a> instances queried from <a href="ion/Reader">ion\Reader</a> and <a href="ion/Writer">ion\Writer</a> instances.</p><p>See also <a href="https://amzn.github.io/ion-docs/docs/symbols.html#the-catalog">the ION spec's symbol guide chapter on catalog.</a>.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Catalog#Constants:">#</a>
+</h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Catalog#Properties:">#</a>
+</h2><ul>
+<li>
+<em>private</em> <code><a href="https://php.net/manual/en/language.types.array">array</a></code> <span class="var" id="$symbolTables">$symbolTables<a class="permalink" href="ion/Catalog#%24symbolTables">#</a></span> = <code><a href="https://php.net/manual/en/language.types.array">array</a></code> (
+)<br>
+Internal cache.</li>
+</ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Catalog#Functions:">#</a>
+</h2><ul class="sub-entries sub-functions">
+       
+       <li>
+               <h3 id="Catalog::__construct">
+<a href="ion/Catalog/__construct">Catalog::__construct</a><a class="permalink" href="ion/Catalog#Catalog::__construct">#</a>
+</h3>
+               <p>Create a new Catalog.</p>
+
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Catalog/__construct">ion\Catalog::__construct</a>()</p>
+       </li>
+       
+       <li>
+               <h3 id="Catalog::add">
+<a href="ion/Catalog/add">Catalog::add</a><a class="permalink" href="ion/Catalog#Catalog::add">#</a>
+</h3>
+               <p>Add a shared symbol table to the catalog.</p>
+
+               <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Catalog/add">ion\Catalog::add</a>(<a href="ion/Symbol/Table">ion\Symbol\Table</a> <span class="var">$table</span>)</p>
+       </li>
+       
+       <li>
+               <h3 id="Catalog::find">
+<a href="ion/Catalog/find">Catalog::find</a><a class="permalink" href="ion/Catalog#Catalog::find">#</a>
+</h3>
+               <p>Find a shared symbol table within the catalog.</p>
+
+               <p>?<a href="ion/Symbol/Table">ion\Symbol\Table</a> <a href="ion/Catalog/find">ion\Catalog::find</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$name</span>, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$version</span> = 0])</p>
+       </li>
+       
+       <li>
+               <h3 id="Catalog::findBest">
+<a href="ion/Catalog/findBest">Catalog::findBest</a><a class="permalink" href="ion/Catalog#Catalog::findBest">#</a>
+</h3>
+               <p>Find a "best match" for a shared symbol table within the catalog.</p>
+
+               <p>?<a href="ion/Symbol/Table">ion\Symbol\Table</a> <a href="ion/Catalog/findBest">ion\Catalog::findBest</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$name</span>, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$version</span> = 0])</p>
+       </li>
+       
+       <li>
+               <h3 id="Catalog::remove">
+<a href="ion/Catalog/remove">Catalog::remove</a><a class="permalink" href="ion/Catalog#Catalog::remove">#</a>
+</h3>
+               <p>Remove a shared symbol table from the catalog.</p>
+
+               <p><code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <a href="ion/Catalog/remove">ion\Catalog::remove</a>(<a href="ion/Symbol/Table">ion\Symbol\Table</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$table</span>)</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>