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                                         <meta charset="utf-8"><h1>
 135 <a class="permalink" href="ion/Symbol#">#</a><em>class</em> <a href="ion/Symbol">ion\Symbol</a> <br>&nbsp;<em>implements</em> <code><a href="https://php.net/manual/en/class.stringable">Stringable</a></code>
 136 </h1><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><h2 id="Constants:">Constants:<a class="permalink" href="ion/Symbol#Constants:">#</a>
 137 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Symbol#Properties:">#</a>
 138 </h2><ul>
 139 <li>
 140 <em>public</em> ?<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var" id="$value">$value<a class="permalink" href="ion/Symbol#%24value">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 141 The symbol's text representation.</li>
 142 <li>
 143 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$sid">$sid<a class="permalink" href="ion/Symbol#%24sid">#</a></span> = -1<br>
 144 The symbols <span class="constant">ID</span>, referencing its location within a shared symbol table.</li>
 145 <li>
 146 <em>public</em> ?<a href="ion/Symbol/ImportLocation">ion\Symbol\ImportLocation</a> <span class="var" id="$importLocation">$importLocation<a class="permalink" href="ion/Symbol#%24importLocation">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 147 The import location referencing a shared symbol table.</li>
 148 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Symbol#Functions:">#</a>
 149 </h2><ul>
 150
 151         <li>
 152                 <h3 id="Symbol::__construct">
 153 <a href="ion/Symbol/__construct">Symbol::__construct</a><a class="permalink" href="ion/Symbol#Symbol::__construct">#</a>
 154 </h3>
 155                 <p>Create an ION symbol.</p>
 156
 157                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Symbol/__construct">ion\Symbol::__construct</a>([?<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>, [<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$sid</span> = -1, [?<a href="ion/Symbol/ImportLocation">ion\Symbol\ImportLocation</a> <span class="var">$importLocation</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>]]])</p>
 158         </li>
 159
 160         <li>
 161                 <h3 id="Symbol::equals">
 162 <a href="ion/Symbol/equals">Symbol::equals</a><a class="permalink" href="ion/Symbol#Symbol::equals">#</a>
 163 </h3>
 164                 <p>Compare two symbols for equality.</p>
 165
 166                 <p><code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <a href="ion/Symbol/equals">ion\Symbol::equals</a>(<a href="ion/Symbol">ion\Symbol</a> <span class="var">$symbol</span>)</p>
 167         </li>
 168
 169         <li>
 170                 <h3 id="Symbol::toString">
 171 <a href="ion/Symbol/toString">Symbol::toString</a><a class="permalink" href="ion/Symbol#Symbol::toString">#</a>
 172 </h3>
 173
 174                 <p><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/Symbol/toString">ion\Symbol::toString</a>()</p>
 175         </li>
 176
 177 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Symbol#Namespaces.Interfaces.and.Classes:">#</a>
 178 </h2><ul>
 179
 180         <li>
 181                 <h3 id="Enum">
 182 <a href="ion/Symbol/Enum">Enum</a><a class="permalink" href="ion/Symbol#Enum">#</a>
 183 </h3>
 184                 <p>Base <em>interface</em> of built-in shared symbol tables.</p>
 185
 186                 <p><em>interface</em> <a href="ion/Symbol/Enum">ion\Symbol\Enum</a></p>
 187         </li>
 188
 189         <li>
 190                 <h3 id="ImportLocation">
 191 <a href="ion/Symbol/ImportLocation">ImportLocation</a><a class="permalink" href="ion/Symbol#ImportLocation">#</a>
 192 </h3>
 193                 <p>The import location (referring to a shared table= of a symbol.</p>
 194
 195                 <p><em>class</em> <a href="ion/Symbol/ImportLocation">ion\Symbol\ImportLocation</a></p>
 196         </li>
 197
 198         <li>
 199                 <h3 id="PHP">
 200 <a href="ion/Symbol/PHP">PHP</a><a class="permalink" href="ion/Symbol#PHP">#</a>
 201 </h3>
 202                 <p>The built-in PHP symbols.</p>
 203
 204                 <p><code><a href="https://php.net/manual/en/language.types.enumerations">enum</a></code> <a href="ion/Symbol/PHP">ion\Symbol\PHP</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.backedenum">BackedEnum</a></code>, <a href="ion/Symbol/Enum">ion\Symbol\Enum</a></p>
 205         </li>
 206
 207         <li>
 208                 <h3 id="System">
 209 <a href="ion/Symbol/System">System</a><a class="permalink" href="ion/Symbol#System">#</a>
 210 </h3>
 211                 <p>The built-in ION system symbols.</p>
 212
 213                 <p><code><a href="https://php.net/manual/en/language.types.enumerations">enum</a></code> <a href="ion/Symbol/System">ion\Symbol\System</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.backedenum">BackedEnum</a></code>, <a href="ion/Symbol/Enum">ion\Symbol\Enum</a></p>
 214         </li>
 215
 216         <li>
 217                 <h3 id="Table">
 218 <a href="ion/Symbol/Table">Table</a><a class="permalink" href="ion/Symbol#Table">#</a>
 219 </h3>
 220                 <p>Base <em>interface</em> of an ION symbol table.</p>
 221
 222                 <p><em>interface</em> <a href="ion/Symbol/Table">ion\Symbol\Table</a></p>
 223         </li>
 224
 225 </ul>
 226                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 227                         <script>
 228                                 var disqus_shortname = 'mdref';
 229                                 var disqus_identifier = 'ion/Symbol';
 230                         </script>
 231
 232                         <footer>
 233
 234 <ul>
 235         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 236 </a></li>
 237         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 238         <li>
 239 </li>
 240 </ul>
 241
 242                         </footer>
 243
 244                         <script src="index.js"></script>
 245
 246                 </div>
 247         </body>
 248 </html>