basic API docs
[awesomized/ext-ion] / docs / html / ion / Symbol / Table.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 Table -
7 mdref
8 </title>
9 <meta name="viewport" content="width=1200, initial-scale=0.5">
10 <base href="/">
11 <meta http-equiv="Content-Location" content="/ion/Symbol/Table">
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="/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/Table">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 &uarr; <a href="./ion/Symbol">
41 Symbol
42 </a>
43 <ul>
44 <li>
45
46 &circlearrowright; <strong><a href="./ion/Symbol/Table">Table</a></strong>
47
48
49 <ul>
50
51 <li>
52 &rdsh; <a href="./ion/Symbol/Table/Local">Local</a>
53
54 </li>
55
56 <li>
57 &rdsh; <a href="./ion/Symbol/Table/PHP">PHP</a>
58
59 </li>
60
61 <li>
62 &rdsh; <a href="./ion/Symbol/Table/Shared">Shared</a>
63
64 </li>
65
66 <li>
67 &rdsh; <a href="./ion/Symbol/Table/System">System</a>
68
69 </li>
70
71 <li>
72 &rdsh; <a href="./ion/Symbol/Table/add">Table::add</a>
73
74 </li>
75
76 <li>
77 &rdsh; <a href="./ion/Symbol/Table/find">Table::find</a>
78
79 </li>
80
81 <li>
82 &rdsh; <a href="./ion/Symbol/Table/findLocal">Table::findLocal</a>
83
84 </li>
85
86 <li>
87 &rdsh; <a href="./ion/Symbol/Table/getMaxId">Table::getMaxId</a>
88
89 </li>
90
91 </ul>
92
93
94 </ul>
95
96 <li>&ldsh; <a href="./ion/Symbol/Enum">Enum</a></li>
97
98 <li>&ldsh; <a href="./ion/Symbol/ImportLocation">ImportLocation</a></li>
99
100 <li>&ldsh; <a href="./ion/Symbol/__construct">Symbol::__construct</a></li>
101
102 <li>&ldsh; <a href="./ion/Symbol/equals">Symbol::equals</a></li>
103
104 <li>&ldsh; <a href="./ion/Symbol/toString">Symbol::toString</a></li>
105
106 </ul>
107
108 </li>
109 </ul>
110
111 </li>
112 </ul>
113 </div>
114
115 <h1>interface ion\Symbol\Table</h1>
116 <p>Base interface of an ION symbol table.</p>
117 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
118 <p>None.</p>
119 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
120 <p>None.</p>
121
122
123
124 <h2 id="Functions:">Functions:</h2>
125 <ul>
126
127 <li>
128 <h3><a href="ion/Symbol/Table/add">Table::add</a></h3>
129 <p>Add a symbol to the table.</p>
130
131 <p>int ion\Symbol\Table::add(ion\Symbol|string $symbol)</p>
132 </li>
133
134 <li>
135 <h3><a href="ion/Symbol/Table/find">Table::find</a></h3>
136 <p>Find a symbol within the symbol table, including imports.</p>
137
138 <p>?ion\Symbol ion\Symbol\Table::find(string|int $id)</p>
139 </li>
140
141 <li>
142 <h3><a href="ion/Symbol/Table/findLocal">Table::findLocal</a></h3>
143 <p>Find a symbol within <strong>only this</strong> symbol table, ignoring imports.</p>
144
145 <p>?ion\Symbol ion\Symbol\Table::findLocal(string|int $id)</p>
146 </li>
147
148 <li>
149 <h3><a href="ion/Symbol/Table/getMaxId">Table::getMaxId</a></h3>
150 <p>Get the maximum symbol ID within the symbol table.</p>
151
152 <p>int ion\Symbol\Table::getMaxId()</p>
153 </li>
154
155 </ul>
156
157
158 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
159 <ul>
160
161 <li>
162 <h3><a href="ion/Symbol/Table/Local">Local</a></h3>
163 <p>A local symbol table.</p>
164
165 <p>class ion\Symbol\Table\Local implements ion\Symbol\Table</p>
166 </li>
167
168 <li>
169 <h3><a href="ion/Symbol/Table/PHP">PHP</a></h3>
170 <p>The built-in PHP symbols.</p>
171
172 <p>enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum</p>
173 </li>
174
175 <li>
176 <h3><a href="ion/Symbol/Table/Shared">Shared</a></h3>
177 <p>A shared symbol table.</p>
178
179 <p>class ion\Symbol\Table\Shared implements ion\Symbol\Table</p>
180 </li>
181
182 <li>
183 <h3><a href="ion/Symbol/Table/System">System</a></h3>
184 <p>The built-in ION system symbols.</p>
185
186 <p>enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum</p>
187 </li>
188
189 </ul>
190
191 <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
192 <script>
193 var disqus_shortname = 'mdref';
194 var disqus_identifier = 'ion/Symbol/Table';
195 </script>
196
197 <footer>
198
199 <ul>
200 <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
201 </a></li>
202 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
203 <li>
204 </li>
205 </ul>
206
207 </footer>
208
209 <script src="index.js"></script>
210
211 </div>
212 </body>
213 </html>