projects / awesomized / ext-ion / blob
? search:


371862384ef19107115515cac6d8d53a3985e4f4
[awesomized/ext-ion] / docs / v0.1 / 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 property="og:title" content="ion\Symbol">
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/Symbol">
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/Symbol">Symbol</a></strong>
40
41
42 <ul>
43
44 <li>
45 &rdsh; <a href="./ion/Symbol/Enum">Enum</a>
46
47 </li>
48
49 <li>
50 &rdsh; <a href="./ion/Symbol/ImportLocation">ImportLocation</a>
51
52 </li>
53
54 <li>
55 &rdsh; <a href="./ion/Symbol/PHP">PHP</a>
56
57 </li>
58
59 <li>
60 &rdsh; <a href="./ion/Symbol/System">System</a>
61
62 </li>
63
64 <li>
65 &rdsh; <a href="./ion/Symbol/Table">Table</a>
66
67 <ul>
68
69 <li>&rdsh; <a href="./ion/Symbol/Table/Local">Local</a>
70 </li>
71
72 <li>&rdsh; <a href="./ion/Symbol/Table/Shared">Shared</a>
73 </li>
74
75 </ul>
76
77 </li>
78
79 <li>
80 &rdsh; <a href="./ion/Symbol/__construct">Symbol::__construct</a>
81
82 </li>
83
84 <li>
85 &rdsh; <a href="./ion/Symbol/equals">Symbol::equals</a>
86
87 </li>
88
89 <li>
90 &rdsh; <a href="./ion/Symbol/toString">Symbol::toString</a>
91
92 </li>
93
94 </ul>
95
96
97 </ul>
98
99 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
100
101 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
102
103 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
104
105 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
106
107 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
108
109 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
110
111 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
112
113 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
114
115 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
116
117 <li>&ldsh; <a href="./ion/Type">Type</a></li>
118
119 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
120
121 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
122
123 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
124
125 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
126
127 </li>
128 </ul>
129
130 </li>
131 </ul>
132 </div>
133 <meta charset="utf-8"><h1>
134 <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>
135 </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>
136 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Symbol#Properties:">#</a>
137 </h2><ul>
138 <li>
139 <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>
140 The symbol's text representation.</li>
141 <li>
142 <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>
143 The symbols <span class="constant">ID</span>, referencing its location within a shared symbol table.</li>
144 <li>
145 <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>
146 The import location referencing a shared symbol table.</li>
147 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Symbol#Functions:">#</a>
148 </h2><ul class="sub-entries sub-functions">
149
150 <li>
151 <h3 id="Symbol::__construct">
152 <a href="ion/Symbol/__construct">Symbol::__construct</a><a class="permalink" href="ion/Symbol#Symbol::__construct">#</a>
153 </h3>
154 <p>Create an ION symbol.</p>
155
156 <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>
157 </li>
158
159 <li>
160 <h3 id="Symbol::equals">
161 <a href="ion/Symbol/equals">Symbol::equals</a><a class="permalink" href="ion/Symbol#Symbol::equals">#</a>
162 </h3>
163 <p>Compare two symbols for equality.</p>
164
165 <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>
166 </li>
167
168 <li>
169 <h3 id="Symbol::toString">
170 <a href="ion/Symbol/toString">Symbol::toString</a><a class="permalink" href="ion/Symbol#Symbol::toString">#</a>
171 </h3>
172
173 <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>
174 </li>
175
176 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Symbol#Namespaces.Interfaces.and.Classes:">#</a>
177 </h2><ul class="sub-entries sub-ns-classes">
178
179 <li>
180 <h3 id="Enum">
181 <a href="ion/Symbol/Enum">Enum</a><a class="permalink" href="ion/Symbol#Enum">#</a>
182 </h3>
183 <p>Base <em>interface</em> of built-in shared symbol tables.</p>
184
185 <p><em>interface</em> <a href="ion/Symbol/Enum">ion\Symbol\Enum</a></p>
186 </li>
187
188 <li>
189 <h3 id="ImportLocation">
190 <a href="ion/Symbol/ImportLocation">ImportLocation</a><a class="permalink" href="ion/Symbol#ImportLocation">#</a>
191 </h3>
192 <p>The import location (referring to a shared table) of a symbol.</p>
193
194 <p><em>class</em> <a href="ion/Symbol/ImportLocation">ion\Symbol\ImportLocation</a></p>
195 </li>
196
197 <li>
198 <h3 id="PHP">
199 <a href="ion/Symbol/PHP">PHP</a><a class="permalink" href="ion/Symbol#PHP">#</a>
200 </h3>
201 <p>The built-in PHP symbols.</p>
202
203 <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>
204 </li>
205
206 <li>
207 <h3 id="System">
208 <a href="ion/Symbol/System">System</a><a class="permalink" href="ion/Symbol#System">#</a>
209 </h3>
210 <p>The built-in ION system symbols.</p>
211
212 <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>
213 </li>
214
215 <li>
216 <h3 id="Table">
217 <a href="ion/Symbol/Table">Table</a><a class="permalink" href="ion/Symbol#Table">#</a>
218 </h3>
219 <p>Base <em>interface</em> of an ION symbol table.</p>
220
221 <p><em>interface</em> <a href="ion/Symbol/Table">ion\Symbol\Table</a></p>
222 </li>
223
224 </ul>
225 <div class="comments">
226 <style>.giscus-frame {min-height: 16em;}</style>
227 <script>
228 function giscus_load(button) {
229 let script = document.createElement("script");
230 script.setAttribute("data-repo", 'awesomized/ext-ion');
231 script.setAttribute("data-category", 'Comments on Docs');
232 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
233 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
234 script.setAttribute("data-mapping", 'og:title');
235 script.setAttribute("data-input-position", 'bottom');
236 script.setAttribute("data-reactions-enabled", false);
237 script.setAttribute("data-theme", 'light');
238 script.setAttribute("data-lang", 'en');
239
240 script.src = "//giscus.app/client.js";
241 button.parentNode.replaceChild(script, button);
242 }
243 </script>
244 <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
245
246 </div>
247
248 <footer>
249
250 <ul>
251 <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
252 </a></li>
253 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
254 <li>
255 </li>
256 </ul>
257
258 </footer>
259
260 <script src="index.js" defer></script>
261
262 </div>
263 </body>
264 </html>
PHP extension for Amazon ION