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="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/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="/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
 110 <h1>class ion\Catalog implements Countable</h1>
 111 <p>The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.</p>
 112 <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>
 113 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 114 <p>None.</p>
 115 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 116 <ul>
 117 <li>private array $symbolTables = array (
 118 )<br />
 119 Internal cache.</li>
 120 </ul>
 121
 122
 123
 124 <h2 id="Functions:">Functions:</h2>
 125 <ul>
 126
 127         <li>
 128                 <h3><a href="ion/Catalog/__construct">Catalog::__construct</a></h3>
 129                 <p>Create a new Catalog.</p>
 130
 131                 <p>void ion\Catalog::__construct()</p>
 132         </li>
 133
 134         <li>
 135                 <h3><a href="ion/Catalog/add">Catalog::add</a></h3>
 136                 <p>Add a shared symbol table to the catalog.</p>
 137
 138                 <p>void ion\Catalog::add(ion\Symbol\Table $table)</p>
 139         </li>
 140
 141         <li>
 142                 <h3><a href="ion/Catalog/find">Catalog::find</a></h3>
 143                 <p>Find a shared symbol table within the catalog.</p>
 144
 145                 <p>?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0])</p>
 146         </li>
 147
 148         <li>
 149                 <h3><a href="ion/Catalog/findBest">Catalog::findBest</a></h3>
 150                 <p>Find a &quot;best match&quot; for a shared symbol table within the catalog.</p>
 151
 152                 <p>?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0])</p>
 153         </li>
 154
 155         <li>
 156                 <h3><a href="ion/Catalog/remove">Catalog::remove</a></h3>
 157                 <p>Remove a shared symbol table from the catalog.</p>
 158
 159                 <p>bool ion\Catalog::remove(ion\Symbol\Table|string $table)</p>
 160         </li>
 161
 162 </ul>
 163
 164
 165                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 166                         <script>
 167                                 var disqus_shortname = 'mdref';
 168                                 var disqus_identifier = 'ion/Catalog';
 169                         </script>
 170
 171                         <footer>
 172
 173 <ul>
 174         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 175 </a></li>
 176         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 177         <li>
 178 </li>
 179 </ul>
 180
 181                         </footer>
 182
 183                         <script src="index.js"></script>
 184
 185                 </div>
 186         </body>
 187 </html>