git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.1/ion/Catalog.html

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Catalog -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion\Catalog">
  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/Catalog">
  13                         <link rel="stylesheet" href="index.css">
  14
  15                 <link rel="shortcut icon" href="/ext-ion/v0.1/favicon.ico">
  16         </head>
  17         <body>
  18                 <div class="page">
  19
  20 <div class="sidebar">
  21
  22         <div class="edit">
  23                 <a href="https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit</a>
  24         </div>
  25
  26
  27         <ul>
  28                 <li>&lsh; <a href="./">Home</a>
  29
  30                         <ul>
  31                                 <li>
  32
  33                                         &uarr; <a href="./ion">
  34                                                         ion
  35                                                 </a>
  36                                                 <ul>
  37                                                         <li>
  38
  39                                                         &circlearrowright; <strong><a href="./ion/Catalog">Catalog</a></strong>
  40
  41
  42                                                         <ul>
  43
  44                                                                 <li>
  45                                                                         &rdsh; <a href="./ion/Catalog/__construct">Catalog::__construct</a>
  46
  47                                                                 </li>
  48
  49                                                                 <li>
  50                                                                         &rdsh; <a href="./ion/Catalog/add">Catalog::add</a>
  51
  52                                                                 </li>
  53
  54                                                                 <li>
  55                                                                         &rdsh; <a href="./ion/Catalog/find">Catalog::find</a>
  56
  57                                                                 </li>
  58
  59                                                                 <li>
  60                                                                         &rdsh; <a href="./ion/Catalog/findBest">Catalog::findBest</a>
  61
  62                                                                 </li>
  63
  64                                                                 <li>
  65                                                                         &rdsh; <a href="./ion/Catalog/remove">Catalog::remove</a>
  66
  67                                                                 </li>
  68
  69                                                         </ul>
  70
  71
  72                                                 </ul>
  73
  74                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
  75
  76                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
  77
  78                                                 <li>&ldsh; <a href="./ion/: Tutorial">★ Tutorial</a></li>
  79
  80                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
  81
  82                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
  83
  84                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
  85
  86                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
  87
  88                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
  89
  90                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
  91
  92                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
  93
  94                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
  95
  96                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
  97
  98                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
  99
 100                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 101
 102                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 103
 104                                 </li>
 105                         </ul>
 106
 107                 </li>
 108         </ul>
 109 </div>
 110                                         <meta charset="utf-8"><h1>
 111 <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>
 112 </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>
 113 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Catalog#Properties:">#</a>
 114 </h2><ul>
 115 <li>
 116 <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> (
 117 )<br>
 118 Internal cache.</li>
 119 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Catalog#Functions:">#</a>
 120 </h2><ul class="sub-entries sub-functions">
 121
 122         <li>
 123                 <h3 id="Catalog::__construct">
 124 <a href="ion/Catalog/__construct">Catalog::__construct</a><a class="permalink" href="ion/Catalog#Catalog::__construct">#</a>
 125 </h3>
 126                 <p>Create a new Catalog.</p>
 127
 128                 <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>
 129         </li>
 130
 131         <li>
 132                 <h3 id="Catalog::add">
 133 <a href="ion/Catalog/add">Catalog::add</a><a class="permalink" href="ion/Catalog#Catalog::add">#</a>
 134 </h3>
 135                 <p>Add a shared symbol table to the catalog.</p>
 136
 137                 <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>
 138         </li>
 139
 140         <li>
 141                 <h3 id="Catalog::find">
 142 <a href="ion/Catalog/find">Catalog::find</a><a class="permalink" href="ion/Catalog#Catalog::find">#</a>
 143 </h3>
 144                 <p>Find a shared symbol table within the catalog.</p>
 145
 146                 <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>
 147         </li>
 148
 149         <li>
 150                 <h3 id="Catalog::findBest">
 151 <a href="ion/Catalog/findBest">Catalog::findBest</a><a class="permalink" href="ion/Catalog#Catalog::findBest">#</a>
 152 </h3>
 153                 <p>Find a "best match" for a shared symbol table within the catalog.</p>
 154
 155                 <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>
 156         </li>
 157
 158         <li>
 159                 <h3 id="Catalog::remove">
 160 <a href="ion/Catalog/remove">Catalog::remove</a><a class="permalink" href="ion/Catalog#Catalog::remove">#</a>
 161 </h3>
 162                 <p>Remove a shared symbol table from the catalog.</p>
 163
 164                 <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>
 165         </li>
 166
 167 </ul>
 168                         <div class="comments">
 169                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 170         <script>
 171                 function giscus_load(button) {
 172                         let script = document.createElement("script");
 173                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 174                                                 script.setAttribute("data-category", 'Comments on Docs');
 175                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 176                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 177                                                 script.setAttribute("data-mapping", 'og:title');
 178                                                 script.setAttribute("data-input-position", 'bottom');
 179                                                 script.setAttribute("data-reactions-enabled", false);
 180                                                 script.setAttribute("data-theme", 'light');
 181                                                 script.setAttribute("data-lang", 'en');
 182
 183                         script.src = "//giscus.app/client.js";
 184                         button.parentNode.replaceChild(script, button);
 185                 }
 186         </script>
 187         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 188
 189                         </div>
 190
 191                         <footer>
 192
 193 <ul>
 194         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 195 </a></li>
 196         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 197         <li>
 198 </li>
 199 </ul>
 200
 201                         </footer>
 202
 203                         <script src="index.js" defer></script>
 204
 205                 </div>
 206         </body>
 207 </html>