git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/ion/Symbol.html

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Symbol -
   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/Symbol">
  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/Symbol">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/Symbol">Symbol</a></strong>
  41
  42
  43                                                         <ul>
  44
  45                                                                 <li>
  46                                                                         &rdsh; <a href="./ion/Symbol/Enum">Enum</a>
  47
  48                                                                 </li>
  49
  50                                                                 <li>
  51                                                                         &rdsh; <a href="./ion/Symbol/ImportLocation">ImportLocation</a>
  52
  53                                                                 </li>
  54
  55                                                                 <li>
  56                                                                         &rdsh; <a href="./ion/Symbol/PHP">PHP</a>
  57
  58                                                                 </li>
  59
  60                                                                 <li>
  61                                                                         &rdsh; <a href="./ion/Symbol/System">System</a>
  62
  63                                                                 </li>
  64
  65                                                                 <li>
  66                                                                         &rdsh; <a href="./ion/Symbol/Table">Table</a>
  67
  68                                                                         <ul>
  69
  70                                                                                 <li>&rdsh; <a href="./ion/Symbol/Table/Local">Local</a>
  71                                                                                 </li>
  72
  73                                                                                 <li>&rdsh; <a href="./ion/Symbol/Table/Shared">Shared</a>
  74                                                                                 </li>
  75
  76                                                                         </ul>
  77
  78                                                                 </li>
  79
  80                                                                 <li>
  81                                                                         &rdsh; <a href="./ion/Symbol/__construct">Symbol::__construct</a>
  82
  83                                                                 </li>
  84
  85                                                                 <li>
  86                                                                         &rdsh; <a href="./ion/Symbol/equals">Symbol::equals</a>
  87
  88                                                                 </li>
  89
  90                                                                 <li>
  91                                                                         &rdsh; <a href="./ion/Symbol/toString">Symbol::toString</a>
  92
  93                                                                 </li>
  94
  95                                                         </ul>
  96
  97
  98                                                 </ul>
  99
 100                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
 101
 102                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
 103
 104                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 105
 106                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
 107
 108                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 109
 110                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 111
 112                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
 113
 114                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 115
 116                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 117
 118                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 119
 120                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 121
 122                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
 123
 124                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 125
 126                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 127
 128                                 </li>
 129                         </ul>
 130
 131                 </li>
 132         </ul>
 133 </div>
 134
 135 <h1>class ion\Symbol implements Stringable</h1>
 136 <p>See also <a href="https://amzn.github.io/ion-docs/docs/spec.html#symbol">ION spec's symbol definition</a>, and <a href="https://amzn.github.io/ion-docs/guides/symbols-guide.html">ION spec's symbol guide</a>.</p>
 137 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 138 <p>None.</p>
 139 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 140 <ul>
 141 <li>public ?string $value = NULL<br />
 142 The symbol's text representation.</li>
 143 <li>public int $sid = -1<br />
 144 The symbols ID, referencing its location within a shared symbol table.</li>
 145 <li>public ?ion\Symbol\ImportLocation $importLocation = NULL<br />
 146 The import location referencing a shared symbol table.</li>
 147 </ul>
 148
 149
 150
 151 <h2 id="Functions:">Functions:</h2>
 152 <ul>
 153
 154         <li>
 155                 <h3><a href="ion/Symbol/__construct">Symbol::__construct</a></h3>
 156                 <p>Create an ION symbol.</p>
 157
 158                 <p>void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]])</p>
 159         </li>
 160
 161         <li>
 162                 <h3><a href="ion/Symbol/equals">Symbol::equals</a></h3>
 163                 <p>Compare two symbols for equality.</p>
 164
 165                 <p>bool ion\Symbol::equals(ion\Symbol $symbol)</p>
 166         </li>
 167
 168         <li>
 169                 <h3><a href="ion/Symbol/toString">Symbol::toString</a></h3>
 170
 171                 <p>string ion\Symbol::toString()</p>
 172         </li>
 173
 174 </ul>
 175
 176
 177 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
 178 <ul>
 179
 180         <li>
 181                 <h3><a href="ion/Symbol/Enum">Enum</a></h3>
 182                 <p>Base interface of built-in shared symbol tables.</p>
 183
 184                 <p>interface ion\Symbol\Enum</p>
 185         </li>
 186
 187         <li>
 188                 <h3><a href="ion/Symbol/ImportLocation">ImportLocation</a></h3>
 189                 <p>The import location (referring to a shared table= of a symbol.</p>
 190
 191                 <p>class ion\Symbol\ImportLocation</p>
 192         </li>
 193
 194         <li>
 195                 <h3><a href="ion/Symbol/PHP">PHP</a></h3>
 196                 <p>The built-in PHP symbols.</p>
 197
 198                 <p>enum ion\Symbol\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum</p>
 199         </li>
 200
 201         <li>
 202                 <h3><a href="ion/Symbol/System">System</a></h3>
 203                 <p>The built-in ION system symbols.</p>
 204
 205                 <p>enum ion\Symbol\System implements BackedEnum, UnitEnum, ion\Symbol\Enum</p>
 206         </li>
 207
 208         <li>
 209                 <h3><a href="ion/Symbol/Table">Table</a></h3>
 210                 <p>Base interface of an ION symbol table.</p>
 211
 212                 <p>interface ion\Symbol\Table</p>
 213         </li>
 214
 215 </ul>
 216
 217                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 218                         <script>
 219                                 var disqus_shortname = 'mdref';
 220                                 var disqus_identifier = 'ion/Symbol';
 221                         </script>
 222
 223                         <footer>
 224
 225 <ul>
 226         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 227 </a></li>
 228         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 229         <li>
 230 </li>
 231 </ul>
 232
 233                         </footer>
 234
 235                         <script src="index.js"></script>
 236
 237                 </div>
 238         </body>
 239 </html>