git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/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 name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/ext-ion/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/ext-ion/v0.0/ion/Catalog">
  12                         <link rel="stylesheet" href="index.css">
  13
  14                 <link href="https://fonts.googleapis.com/css?family=Inconsolata&amp;subset=latin-ext" rel="stylesheet">
  15                 <script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
  16                 <link rel="shortcut icon" href="/ext-ion/v0.0/favicon.ico">
  17         </head>
  18         <body>
  19                 <div class="page">
  20
  21 <div class="sidebar">
  22
  23         <div class="edit">
  24                 <a href="./ion/Catalog">Edit</a>
  25         </div>
  26
  27
  28         <ul>
  29                 <li>&lsh; <a href="./">Home</a>
  30
  31                         <ul>
  32                                 <li>
  33
  34                                         &uarr; <a href="./ion">
  35                                                         ion
  36                                                 </a>
  37                                                 <ul>
  38                                                         <li>
  39
  40                                                         &circlearrowright; <strong><a href="./ion/Catalog">Catalog</a></strong>
  41
  42
  43                                                         <ul>
  44
  45                                                                 <li>
  46                                                                         &rdsh; <a href="./ion/Catalog/__construct">Catalog::__construct</a>
  47
  48                                                                 </li>
  49
  50                                                                 <li>
  51                                                                         &rdsh; <a href="./ion/Catalog/add">Catalog::add</a>
  52
  53                                                                 </li>
  54
  55                                                                 <li>
  56                                                                         &rdsh; <a href="./ion/Catalog/find">Catalog::find</a>
  57
  58                                                                 </li>
  59
  60                                                                 <li>
  61                                                                         &rdsh; <a href="./ion/Catalog/findBest">Catalog::findBest</a>
  62
  63                                                                 </li>
  64
  65                                                                 <li>
  66                                                                         &rdsh; <a href="./ion/Catalog/remove">Catalog::remove</a>
  67
  68                                                                 </li>
  69
  70                                                         </ul>
  71
  72
  73                                                 </ul>
  74
  75                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
  76
  77                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
  78
  79                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
  80
  81                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
  82
  83                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
  84
  85                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
  86
  87                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
  88
  89                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
  90
  91                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
  92
  93                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
  94
  95                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
  96
  97                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
  98
  99                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 102
 103                                 </li>
 104                         </ul>
 105
 106                 </li>
 107         </ul>
 108 </div>
 109                                         <meta charset="utf-8"><h1>
 110 <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>
 111 </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>
 112 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Catalog#Properties:">#</a>
 113 </h2><ul>
 114 <li>
 115 <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> (
 116 )<br>
 117 Internal cache.</li>
 118 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Catalog#Functions:">#</a>
 119 </h2><ul>
 120
 121         <li>
 122                 <h3 id="Catalog::__construct">
 123 <a href="ion/Catalog/__construct">Catalog::__construct</a><a class="permalink" href="ion/Catalog#Catalog::__construct">#</a>
 124 </h3>
 125                 <p>Create a new Catalog.</p>
 126
 127                 <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>
 128         </li>
 129
 130         <li>
 131                 <h3 id="Catalog::add">
 132 <a href="ion/Catalog/add">Catalog::add</a><a class="permalink" href="ion/Catalog#Catalog::add">#</a>
 133 </h3>
 134                 <p>Add a shared symbol table to the catalog.</p>
 135
 136                 <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>
 137         </li>
 138
 139         <li>
 140                 <h3 id="Catalog::find">
 141 <a href="ion/Catalog/find">Catalog::find</a><a class="permalink" href="ion/Catalog#Catalog::find">#</a>
 142 </h3>
 143                 <p>Find a shared symbol table within the catalog.</p>
 144
 145                 <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>
 146         </li>
 147
 148         <li>
 149                 <h3 id="Catalog::findBest">
 150 <a href="ion/Catalog/findBest">Catalog::findBest</a><a class="permalink" href="ion/Catalog#Catalog::findBest">#</a>
 151 </h3>
 152                 <p>Find a "best match" for a shared symbol table within the catalog.</p>
 153
 154                 <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>
 155         </li>
 156
 157         <li>
 158                 <h3 id="Catalog::remove">
 159 <a href="ion/Catalog/remove">Catalog::remove</a><a class="permalink" href="ion/Catalog#Catalog::remove">#</a>
 160 </h3>
 161                 <p>Remove a shared symbol table from the catalog.</p>
 162
 163                 <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>
 164         </li>
 165
 166 </ul>
 167                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 168                         <script>
 169                                 var disqus_shortname = 'mdref';
 170                                 var disqus_identifier = 'ion/Catalog';
 171                         </script>
 172
 173                         <footer>
 174
 175 <ul>
 176         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 177 </a></li>
 178         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 179         <li>
 180 </li>
 181 </ul>
 182
 183                         </footer>
 184
 185                         <script src="index.js"></script>
 186
 187                 </div>
 188         </body>
 189 </html>