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

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         ion -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion">
  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">
  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                                                         &circlearrowright; <strong><a href="./ion">ion</a></strong>
  34
  35
  36                                                         <ul>
  37
  38                                                                 <li>
  39                                                                         &rdsh; <a href="./ion/: Contributing">★ Contributing</a>
  40
  41                                                                 </li>
  42
  43                                                                 <li>
  44                                                                         &rdsh; <a href="./ion/: Security">★ Security</a>
  45
  46                                                                 </li>
  47
  48                                                                 <li>
  49                                                                         &rdsh; <a href="./ion/Catalog">Catalog</a>
  50
  51                                                                 </li>
  52
  53                                                                 <li>
  54                                                                         &rdsh; <a href="./ion/Decimal">Decimal</a>
  55
  56                                                                         <ul>
  57
  58                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context">Context</a>
  59                                                                                 <ul>
  60
  61                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
  62                                                                                         </li>
  63
  64                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
  65                                                                                         </li>
  66
  67                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
  68                                                                                         </li>
  69
  70                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
  71                                                                                         </li>
  72
  73                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
  74                                                                                         </li>
  75
  76                                                                                 </ul>
  77
  78                                                                                 </li>
  79
  80                                                                         </ul>
  81
  82                                                                 </li>
  83
  84                                                                 <li>
  85                                                                         &rdsh; <a href="./ion/Exception">Exception</a>
  86
  87                                                                 </li>
  88
  89                                                                 <li>
  90                                                                         &rdsh; <a href="./ion/LOB">LOB</a>
  91
  92                                                                 </li>
  93
  94                                                                 <li>
  95                                                                         &rdsh; <a href="./ion/Reader">Reader</a>
  96
  97                                                                         <ul>
  98
  99                                                                                 <li>&rdsh; <a href="./ion/Reader/Buffer">Buffer</a>
 100                                                                                 <ul>
 101
 102                                                                                         <li>&rdsh; <a href="./ion/Reader/Buffer/Reader">Reader</a>
 103                                                                                         </li>
 104
 105                                                                                 </ul>
 106
 107                                                                                 </li>
 108
 109                                                                                 <li>&rdsh; <a href="./ion/Reader/Options">Options</a>
 110                                                                                 </li>
 111
 112                                                                                 <li>&rdsh; <a href="./ion/Reader/Reader">Reader</a>
 113                                                                                 </li>
 114
 115                                                                                 <li>&rdsh; <a href="./ion/Reader/Stream">Stream</a>
 116                                                                                 <ul>
 117
 118                                                                                         <li>&rdsh; <a href="./ion/Reader/Stream/Reader">Reader</a>
 119                                                                                         </li>
 120
 121                                                                                 </ul>
 122
 123                                                                                 </li>
 124
 125                                                                         </ul>
 126
 127                                                                 </li>
 128
 129                                                                 <li>
 130                                                                         &rdsh; <a href="./ion/Serializer">Serializer</a>
 131
 132                                                                         <ul>
 133
 134                                                                                 <li>&rdsh; <a href="./ion/Serializer/PHP">PHP</a>
 135                                                                                 </li>
 136
 137                                                                         </ul>
 138
 139                                                                 </li>
 140
 141                                                                 <li>
 142                                                                         &rdsh; <a href="./ion/Symbol">Symbol</a>
 143
 144                                                                         <ul>
 145
 146                                                                                 <li>&rdsh; <a href="./ion/Symbol/Enum">Enum</a>
 147                                                                                 </li>
 148
 149                                                                                 <li>&rdsh; <a href="./ion/Symbol/ImportLocation">ImportLocation</a>
 150                                                                                 </li>
 151
 152                                                                                 <li>&rdsh; <a href="./ion/Symbol/PHP">PHP</a>
 153                                                                                 </li>
 154
 155                                                                                 <li>&rdsh; <a href="./ion/Symbol/System">System</a>
 156                                                                                 </li>
 157
 158                                                                                 <li>&rdsh; <a href="./ion/Symbol/Table">Table</a>
 159                                                                                 <ul>
 160
 161                                                                                         <li>&rdsh; <a href="./ion/Symbol/Table/Local">Local</a>
 162                                                                                         </li>
 163
 164                                                                                         <li>&rdsh; <a href="./ion/Symbol/Table/Shared">Shared</a>
 165                                                                                         </li>
 166
 167                                                                                 </ul>
 168
 169                                                                                 </li>
 170
 171                                                                         </ul>
 172
 173                                                                 </li>
 174
 175                                                                 <li>
 176                                                                         &rdsh; <a href="./ion/Timestamp">Timestamp</a>
 177
 178                                                                         <ul>
 179
 180                                                                                 <li>&rdsh; <a href="./ion/Timestamp/Format">Format</a>
 181                                                                                 </li>
 182
 183                                                                                 <li>&rdsh; <a href="./ion/Timestamp/Precision">Precision</a>
 184                                                                                 </li>
 185
 186                                                                         </ul>
 187
 188                                                                 </li>
 189
 190                                                                 <li>
 191                                                                         &rdsh; <a href="./ion/Type">Type</a>
 192
 193                                                                 </li>
 194
 195                                                                 <li>
 196                                                                         &rdsh; <a href="./ion/Unserializer">Unserializer</a>
 197
 198                                                                         <ul>
 199
 200                                                                                 <li>&rdsh; <a href="./ion/Unserializer/PHP">PHP</a>
 201                                                                                 </li>
 202
 203                                                                         </ul>
 204
 205                                                                 </li>
 206
 207                                                                 <li>
 208                                                                         &rdsh; <a href="./ion/Writer">Writer</a>
 209
 210                                                                         <ul>
 211
 212                                                                                 <li>&rdsh; <a href="./ion/Writer/Buffer">Buffer</a>
 213                                                                                 <ul>
 214
 215                                                                                         <li>&rdsh; <a href="./ion/Writer/Buffer/Writer">Writer</a>
 216                                                                                         </li>
 217
 218                                                                                 </ul>
 219
 220                                                                                 </li>
 221
 222                                                                                 <li>&rdsh; <a href="./ion/Writer/Options">Options</a>
 223                                                                                 </li>
 224
 225                                                                                 <li>&rdsh; <a href="./ion/Writer/Stream">Stream</a>
 226                                                                                 <ul>
 227
 228                                                                                         <li>&rdsh; <a href="./ion/Writer/Stream/Writer">Writer</a>
 229                                                                                         </li>
 230
 231                                                                                 </ul>
 232
 233                                                                                 </li>
 234
 235                                                                                 <li>&rdsh; <a href="./ion/Writer/Writer">Writer</a>
 236                                                                                 </li>
 237
 238                                                                         </ul>
 239
 240                                                                 </li>
 241
 242                                                                 <li>
 243                                                                         &rdsh; <a href="./ion/serialize">serialize</a>
 244
 245                                                                 </li>
 246
 247                                                                 <li>
 248                                                                         &rdsh; <a href="./ion/unserialize">unserialize</a>
 249
 250                                                                 </li>
 251
 252                                                         </ul>
 253
 254
 255                                 </li>
 256                         </ul>
 257
 258                 </li>
 259         </ul>
 260 </div>
 261                                         <meta charset="utf-8"><h1>
 262 <a class="permalink" href="ion#">#</a>pecl/ion</h1><h2 id="About:">About:<a class="permalink" href="ion#About:">#</a>
 263 </h2><p>PHP extension wrapping <a href="https://github.com/amzn/ion-c">amzn/ion-c</a>.
 264 See the <a href="https://amzn.github.io/ion-docs/">Amazon ION specification</a>.</p><h2 id="License:">License:<a class="permalink" href="ion#License:">#</a>
 265 </h2><p><a href="https://github.com/awesomized/ext-ion/blob/master/LICENSE">BSD-2-Clause</a>;
 266 see <a href="https://spdx.org/licenses/BSD-2-Clause.html">spdx.org</a>.</p><h2 id="Installation:">Installation:<a class="permalink" href="ion#Installation:">#</a>
 267 </h2><h3 id="Dependencies:">Dependencies:<a class="permalink" href="ion#Dependencies:">#</a>
 268 </h3><h4 id="Required:">Required:<a class="permalink" href="ion#Required:">#</a>
 269 </h4><ul>
 270 <li>PHP-8.1
 271 <ul>
 272 <li>ext/date (standard)</li>
 273 <li>ext/spl (standard)</li>
 274 </ul>
 275 </li>
 276 </ul><h4 id="Optional:">Optional:<a class="permalink" href="ion#Optional:">#</a>
 277 </h4><ul>
 278 <li>
 279 <a href="https://github.com/amzn/ion-c">amzn/ion-c</a> (bundled as git submodule)</li>
 280 </ul><h3 id="Trinity:">Trinity:<a class="permalink" href="ion#Trinity:">#</a>
 281 </h3><pre><code><span style="color: inherit" class="html">
 282 phpize<br>./configure # --with-php-config=&lt;path/to/php-config&gt;<br>make # -j$(nproc)<br>sudo make install # INSTALL=install<br></span>
 283 </code></pre><h3 id="PECL">PECL<a class="permalink" href="ion#PECL">#</a>
 284 </h3><pre><code><span style="color: inherit" class="html">
 285 pecl install ion<br></span>
 286 </code></pre><h3 id="PHARext">PHARext<a class="permalink" href="ion#PHARext">#</a>
 287 </h3><p>Watch out for <a href="https://replicator.pharext.org?ion">PECL replicates</a>
 288 and pharext packages attached to <a href="./releases">releases</a>.</p><h3 id="Try.with.Docker:">Try with Docker:<a class="permalink" href="ion#Try.with.Docker:">#</a>
 289 </h3><pre><code><span style="color: inherit" class="html">
 290 docker build -t php-ion<br>docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\PHP::asTable());'<br></span>
 291 </code></pre><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
 292 </h2><p>See <a href="https://github.com/awesomized/ext-ion/blob/master/ion.stub.php">ion.stub.php</a>.</p><h2 id="Known.Issues:">Known Issues:<a class="permalink" href="ion#Known.Issues:">#</a>
 293 </h2><p>Due to <em>private</em> internal state of ion-c's readers and writers,
 294 instances of the following PHP classes cannot be cloned:</p><ul>
 295 <li><a href="ion/Reader/Reader">ion\Reader\Reader</a></li>
 296 <li><a href="ion/Writer/Writer">ion\Writer\Writer</a></li>
 297 <li><a href="ion/Serializer/PHP">ion\Serializer\PHP</a></li>
 298 <li><a href="ion/Unserializer/PHP">ion\Unserializer\PHP</a></li>
 299 </ul><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
 300 </h2><p>This extension provides a stub file four your editor's auto-completion.</p><div>
 301                                         <p><strong>Download the Stub file:</strong></p>
 302                                         <ul style="list-style-type: '»'">
 303                                                 <li>
 304                                                                                                                 <a href="ion.stub.php">ion.stub.php</a><br>
 305                                                                                                                 <small>
 306                                                                 Last modified:
 307                                                                 2022-01-28 09:29:47 UTC                                                 </small>
 308                                                 </li>
 309                                         </ul>
 310                                 </div><h2 id="Functions:">Functions:<a class="permalink" href="ion#Functions:">#</a>
 311 </h2><ul class="sub-entries sub-functions">
 312
 313         <li>
 314                 <h3 id="serialize">
 315 <a href="ion/serialize">serialize</a><a class="permalink" href="ion#serialize">#</a>
 316 </h3>
 317                 <p>Serialize a PHP value as ION data.</p>
 318
 319                 <p><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/serialize">ion\serialize</a>(<code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <span class="var">$data</span>, [?<a href="ion/Serializer">ion\Serializer</a> <span class="var">$serializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
 320         </li>
 321
 322         <li>
 323                 <h3 id="unserialize">
 324 <a href="ion/unserialize">unserialize</a><a class="permalink" href="ion#unserialize">#</a>
 325 </h3>
 326                 <p>Unserialize ION data (stream) as PHP value(s).</p>
 327
 328                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <a href="ion/unserialize">ion\unserialize</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.resource">resource</a></code> <span class="var">$data</span>, [?<a href="ion/Unserializer">ion\Unserializer</a> <span class="var">$unserializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
 329         </li>
 330
 331 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion#Namespaces.Interfaces.and.Classes:">#</a>
 332 </h2><ul class="sub-entries sub-ns-classes">
 333
 334         <li>
 335                 <h3 id="Catalog">
 336 <a href="ion/Catalog">Catalog</a><a class="permalink" href="ion#Catalog">#</a>
 337 </h3>
 338                 <p>The Catalog holds a collection of <a href="ion/Symbol/Table">ion\Symbol\Table</a> instances queried from <a href="ion/Reader">ion\Reader</a> and <a href="ion/Writer">ion\Writer</a> instances.</p>
 339
 340                 <p><em>class</em> <a href="ion/Catalog">ion\Catalog</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.countable">Countable</a></code></p>
 341         </li>
 342
 343         <li>
 344                 <h3 id="Decimal">
 345 <a href="ion/Decimal">Decimal</a><a class="permalink" href="ion#Decimal">#</a>
 346 </h3>
 347                 <p>An arbitrary precision fixed point decimal.</p>
 348
 349                 <p><em>class</em> <a href="ion/Decimal">ion\Decimal</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.stringable">Stringable</a></code></p>
 350         </li>
 351
 352         <li>
 353                 <h3 id="Exception">
 354 <a href="ion/Exception">Exception</a><a class="permalink" href="ion#Exception">#</a>
 355 </h3>
 356                 <p>Base exception for the ION extension.</p>
 357
 358                 <p><em>class</em> <a href="ion/Exception">ion\Exception</a> <em>extends</em> <code><a href="https://php.net/manual/en/class.exception">Exception</a></code> <em>implements</em> <code><a href="https://php.net/manual/en/class.throwable">Throwable</a></code></p>
 359         </li>
 360
 361         <li>
 362                 <h3 id="LOB">
 363 <a href="ion/LOB">LOB</a><a class="permalink" href="ion#LOB">#</a>
 364 </h3>
 365                 <p>A large object.</p>
 366
 367                 <p><em>class</em> <a href="ion/LOB">ion\LOB</a></p>
 368         </li>
 369
 370         <li>
 371                 <h3 id="Reader">
 372 <a href="ion/Reader">Reader</a><a class="permalink" href="ion#Reader">#</a>
 373 </h3>
 374                 <p>ION reader API.</p>
 375
 376                 <p><em>interface</em> <a href="ion/Reader">ion\Reader</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.recursiveiterator">RecursiveIterator</a></code></p>
 377         </li>
 378
 379         <li>
 380                 <h3 id="Serializer">
 381 <a href="ion/Serializer">Serializer</a><a class="permalink" href="ion#Serializer">#</a>
 382 </h3>
 383                 <p>Serializer <em>interface</em>, used to customize <a href="ion/serialize">ion\serialize</a>()'s behavior.</p>
 384
 385                 <p><em>interface</em> <a href="ion/Serializer">ion\Serializer</a></p>
 386         </li>
 387
 388         <li>
 389                 <h3 id="Symbol">
 390 <a href="ion/Symbol">Symbol</a><a class="permalink" href="ion#Symbol">#</a>
 391 </h3>
 392
 393                 <p><em>class</em> <a href="ion/Symbol">ion\Symbol</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.stringable">Stringable</a></code></p>
 394         </li>
 395
 396         <li>
 397                 <h3 id="Timestamp">
 398 <a href="ion/Timestamp">Timestamp</a><a class="permalink" href="ion#Timestamp">#</a>
 399 </h3>
 400                 <p>An ION Timestamp.</p>
 401
 402                 <p><em>class</em> <a href="ion/Timestamp">ion\Timestamp</a> <em>extends</em> <code><a href="https://php.net/manual/en/class.datetime">DateTime</a></code> <em>implements</em> <code><a href="https://php.net/manual/en/class.datetimeinterface">DateTimeInterface</a></code>, <code><a href="https://php.net/manual/en/class.stringable">Stringable</a></code></p>
 403         </li>
 404
 405         <li>
 406                 <h3 id="Type">
 407 <a href="ion/Type">Type</a><a class="permalink" href="ion#Type">#</a>
 408 </h3>
 409                 <p>ION data type.</p>
 410
 411                 <p><code><a href="https://php.net/manual/en/language.types.enumerations">enum</a></code> <a href="ion/Type">ion\Type</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.backedenum">BackedEnum</a></code></p>
 412         </li>
 413
 414         <li>
 415                 <h3 id="Unserializer">
 416 <a href="ion/Unserializer">Unserializer</a><a class="permalink" href="ion#Unserializer">#</a>
 417 </h3>
 418                 <p>Unserializer <em>interface</em>, used to customize <a href="ion/unserialize">ion\unserialize</a>()'s behavior.</p>
 419
 420                 <p><em>interface</em> <a href="ion/Unserializer">ion\Unserializer</a></p>
 421         </li>
 422
 423         <li>
 424                 <h3 id="Writer">
 425 <a href="ion/Writer">Writer</a><a class="permalink" href="ion#Writer">#</a>
 426 </h3>
 427                 <p>ION writer API.</p>
 428
 429                 <p><em>interface</em> <a href="ion/Writer">ion\Writer</a></p>
 430         </li>
 431
 432 </ul>
 433                         <div class="comments">
 434                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 435         <script>
 436                 function giscus_load(button) {
 437                         let script = document.createElement("script");
 438                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 439                                                 script.setAttribute("data-category", 'Comments on Docs');
 440                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 441                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 442                                                 script.setAttribute("data-mapping", 'og:title');
 443                                                 script.setAttribute("data-input-position", 'bottom');
 444                                                 script.setAttribute("data-reactions-enabled", false);
 445                                                 script.setAttribute("data-theme", 'light');
 446                                                 script.setAttribute("data-lang", 'en');
 447
 448                         script.src = "//giscus.app/client.js";
 449                         button.parentNode.replaceChild(script, button);
 450                 }
 451         </script>
 452         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 453
 454                         </div>
 455
 456                         <footer>
 457
 458 <ul>
 459         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 460 </a></li>
 461         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 462         <li>
 463 </li>
 464 </ul>
 465
 466                         </footer>
 467
 468                         <script src="index.js" defer></script>
 469
 470                 </div>
 471         </body>
 472 </html>