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 name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/ext-ion/v0.1/">
  11                         <meta http-equiv="Content-Location" content="/ext-ion/v0.1/ion">
  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="/ext-ion/v0.1/favicon.ico">
  17         </head>
  18         <body>
  19                 <div class="page">
  20
  21 <div class="sidebar">
  22
  23         <div class="edit">
  24                 <a href="./ion">Edit</a>
  25         </div>
  26
  27
  28         <ul>
  29                 <li>&lsh; <a href="./">Home</a>
  30
  31                         <ul>
  32                                 <li>
  33
  34                                                         &circlearrowright; <strong><a href="./ion">ion</a></strong>
  35
  36
  37                                                         <ul>
  38
  39                                                                 <li>
  40                                                                         &rdsh; <a href="./ion/: Contributing">★ Contributing</a>
  41
  42                                                                 </li>
  43
  44                                                                 <li>
  45                                                                         &rdsh; <a href="./ion/: Security">★ Security</a>
  46
  47                                                                 </li>
  48
  49                                                                 <li>
  50                                                                         &rdsh; <a href="./ion/Catalog">Catalog</a>
  51
  52                                                                 </li>
  53
  54                                                                 <li>
  55                                                                         &rdsh; <a href="./ion/Decimal">Decimal</a>
  56
  57                                                                         <ul>
  58
  59                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context">Context</a>
  60                                                                                 <ul>
  61
  62                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
  63                                                                                         </li>
  64
  65                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
  66                                                                                         </li>
  67
  68                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
  69                                                                                         </li>
  70
  71                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
  72                                                                                         </li>
  73
  74                                                                                         <li>&rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
  75                                                                                         </li>
  76
  77                                                                                 </ul>
  78
  79                                                                                 </li>
  80
  81                                                                         </ul>
  82
  83                                                                 </li>
  84
  85                                                                 <li>
  86                                                                         &rdsh; <a href="./ion/Exception">Exception</a>
  87
  88                                                                 </li>
  89
  90                                                                 <li>
  91                                                                         &rdsh; <a href="./ion/LOB">LOB</a>
  92
  93                                                                 </li>
  94
  95                                                                 <li>
  96                                                                         &rdsh; <a href="./ion/Reader">Reader</a>
  97
  98                                                                         <ul>
  99
 100                                                                                 <li>&rdsh; <a href="./ion/Reader/Buffer">Buffer</a>
 101                                                                                 <ul>
 102
 103                                                                                         <li>&rdsh; <a href="./ion/Reader/Buffer/Reader">Reader</a>
 104                                                                                         </li>
 105
 106                                                                                 </ul>
 107
 108                                                                                 </li>
 109
 110                                                                                 <li>&rdsh; <a href="./ion/Reader/Options">Options</a>
 111                                                                                 </li>
 112
 113                                                                                 <li>&rdsh; <a href="./ion/Reader/Reader">Reader</a>
 114                                                                                 </li>
 115
 116                                                                                 <li>&rdsh; <a href="./ion/Reader/Stream">Stream</a>
 117                                                                                 <ul>
 118
 119                                                                                         <li>&rdsh; <a href="./ion/Reader/Stream/Reader">Reader</a>
 120                                                                                         </li>
 121
 122                                                                                 </ul>
 123
 124                                                                                 </li>
 125
 126                                                                         </ul>
 127
 128                                                                 </li>
 129
 130                                                                 <li>
 131                                                                         &rdsh; <a href="./ion/Serializer">Serializer</a>
 132
 133                                                                         <ul>
 134
 135                                                                                 <li>&rdsh; <a href="./ion/Serializer/PHP">PHP</a>
 136                                                                                 </li>
 137
 138                                                                         </ul>
 139
 140                                                                 </li>
 141
 142                                                                 <li>
 143                                                                         &rdsh; <a href="./ion/Symbol">Symbol</a>
 144
 145                                                                         <ul>
 146
 147                                                                                 <li>&rdsh; <a href="./ion/Symbol/Enum">Enum</a>
 148                                                                                 </li>
 149
 150                                                                                 <li>&rdsh; <a href="./ion/Symbol/ImportLocation">ImportLocation</a>
 151                                                                                 </li>
 152
 153                                                                                 <li>&rdsh; <a href="./ion/Symbol/PHP">PHP</a>
 154                                                                                 </li>
 155
 156                                                                                 <li>&rdsh; <a href="./ion/Symbol/System">System</a>
 157                                                                                 </li>
 158
 159                                                                                 <li>&rdsh; <a href="./ion/Symbol/Table">Table</a>
 160                                                                                 <ul>
 161
 162                                                                                         <li>&rdsh; <a href="./ion/Symbol/Table/Local">Local</a>
 163                                                                                         </li>
 164
 165                                                                                         <li>&rdsh; <a href="./ion/Symbol/Table/Shared">Shared</a>
 166                                                                                         </li>
 167
 168                                                                                 </ul>
 169
 170                                                                                 </li>
 171
 172                                                                         </ul>
 173
 174                                                                 </li>
 175
 176                                                                 <li>
 177                                                                         &rdsh; <a href="./ion/Timestamp">Timestamp</a>
 178
 179                                                                         <ul>
 180
 181                                                                                 <li>&rdsh; <a href="./ion/Timestamp/Format">Format</a>
 182                                                                                 </li>
 183
 184                                                                                 <li>&rdsh; <a href="./ion/Timestamp/Precision">Precision</a>
 185                                                                                 </li>
 186
 187                                                                         </ul>
 188
 189                                                                 </li>
 190
 191                                                                 <li>
 192                                                                         &rdsh; <a href="./ion/Type">Type</a>
 193
 194                                                                 </li>
 195
 196                                                                 <li>
 197                                                                         &rdsh; <a href="./ion/Unserializer">Unserializer</a>
 198
 199                                                                         <ul>
 200
 201                                                                                 <li>&rdsh; <a href="./ion/Unserializer/PHP">PHP</a>
 202                                                                                 </li>
 203
 204                                                                         </ul>
 205
 206                                                                 </li>
 207
 208                                                                 <li>
 209                                                                         &rdsh; <a href="./ion/Writer">Writer</a>
 210
 211                                                                         <ul>
 212
 213                                                                                 <li>&rdsh; <a href="./ion/Writer/Buffer">Buffer</a>
 214                                                                                 <ul>
 215
 216                                                                                         <li>&rdsh; <a href="./ion/Writer/Buffer/Writer">Writer</a>
 217                                                                                         </li>
 218
 219                                                                                 </ul>
 220
 221                                                                                 </li>
 222
 223                                                                                 <li>&rdsh; <a href="./ion/Writer/Options">Options</a>
 224                                                                                 </li>
 225
 226                                                                                 <li>&rdsh; <a href="./ion/Writer/Stream">Stream</a>
 227                                                                                 <ul>
 228
 229                                                                                         <li>&rdsh; <a href="./ion/Writer/Stream/Writer">Writer</a>
 230                                                                                         </li>
 231
 232                                                                                 </ul>
 233
 234                                                                                 </li>
 235
 236                                                                                 <li>&rdsh; <a href="./ion/Writer/Writer">Writer</a>
 237                                                                                 </li>
 238
 239                                                                         </ul>
 240
 241                                                                 </li>
 242
 243                                                                 <li>
 244                                                                         &rdsh; <a href="./ion/serialize">serialize</a>
 245
 246                                                                 </li>
 247
 248                                                                 <li>
 249                                                                         &rdsh; <a href="./ion/unserialize">unserialize</a>
 250
 251                                                                 </li>
 252
 253                                                         </ul>
 254
 255
 256                                 </li>
 257                         </ul>
 258
 259                 </li>
 260         </ul>
 261 </div>
 262                                         <meta charset="utf-8"><h1>
 263 <a class="permalink" href="ion#">#</a>pecl/ion</h1><h2 id="About:">About:<a class="permalink" href="ion#About:">#</a>
 264 </h2><p>PHP extension wrapping <a href="https://github.com/amzn/ion-c">amzn/ion-c</a>.
 265 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>
 266 </h2><p><a href="https://github.com/awesomized/ext-ion/blob/master/LICENSE">BSD-2-Clause</a>;
 267 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>
 268 </h2><h3 id="Dependencies:">Dependencies:<a class="permalink" href="ion#Dependencies:">#</a>
 269 </h3><h4 id="Required:">Required:<a class="permalink" href="ion#Required:">#</a>
 270 </h4><ul>
 271 <li>PHP-8.1
 272 <ul>
 273 <li>ext/date (standard)</li>
 274 <li>ext/spl (standard)</li>
 275 </ul>
 276 </li>
 277 </ul><h4 id="Optional:">Optional:<a class="permalink" href="ion#Optional:">#</a>
 278 </h4><ul>
 279 <li>
 280 <a href="https://github.com/amzn/ion-c">amzn/ion-c</a> (bundled as git submodule)</li>
 281 </ul><h3 id="Trinity:">Trinity:<a class="permalink" href="ion#Trinity:">#</a>
 282 </h3><pre><code><span style="color: inherit" class="html">
 283 phpize<br>./configure # --with-php-config=&lt;path/to/php-config&gt;<br>make # -j$(nproc)<br>sudo make install # INSTALL=install<br></span>
 284 </code></pre><h3 id="PECL">PECL<a class="permalink" href="ion#PECL">#</a>
 285 </h3><pre><code><span style="color: inherit" class="html">
 286 pecl install ion<br></span>
 287 </code></pre><h3 id="PHARext">PHARext<a class="permalink" href="ion#PHARext">#</a>
 288 </h3><p>Watch out for <a href="https://replicator.pharext.org?ion">PECL replicates</a>
 289 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>
 290 </h3><pre><code><span style="color: inherit" class="html">
 291 docker build -t php-ion<br>docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\PHP::asTable());'<br></span>
 292 </code></pre><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
 293 </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>
 294 </h2><p>Due to <em>private</em> internal state of ion-c's readers and writers,
 295 instances of the following PHP classes cannot be cloned:</p><ul>
 296 <li><a href="ion/Reader/Reader">ion\Reader\Reader</a></li>
 297 <li><a href="ion/Writer/Writer">ion\Writer\Writer</a></li>
 298 <li><a href="ion/Serializer/PHP">ion\Serializer\PHP</a></li>
 299 <li><a href="ion/Unserializer/PHP">ion\Unserializer\PHP</a></li>
 300 </ul><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
 301 </h2><p>This extension provides a stub file four your editor's auto-completion.</p><div>
 302                                         <p><strong>Download the Stub file:</strong></p>
 303                                         <ul style="list-style-type: '»'">
 304                                                 <li>
 305                                                                                                                 <a href="ion.stub.php">ion.stub.php</a><br>
 306                                                                                                                 <small>
 307                                                                 Last modified:
 308                                                                 2022-01-28 09:29:47 UTC                                                 </small>
 309                                                 </li>
 310                                         </ul>
 311                                 </div><h2 id="Functions:">Functions:<a class="permalink" href="ion#Functions:">#</a>
 312 </h2><ul>
 313
 314         <li>
 315                 <h3 id="serialize">
 316 <a href="ion/serialize">serialize</a><a class="permalink" href="ion#serialize">#</a>
 317 </h3>
 318                 <p>Serialize a PHP value as ION data.</p>
 319
 320                 <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>
 321         </li>
 322
 323         <li>
 324                 <h3 id="unserialize">
 325 <a href="ion/unserialize">unserialize</a><a class="permalink" href="ion#unserialize">#</a>
 326 </h3>
 327                 <p>Unserialize ION data (stream) as PHP value(s).</p>
 328
 329                 <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>
 330         </li>
 331
 332 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion#Namespaces.Interfaces.and.Classes:">#</a>
 333 </h2><ul>
 334
 335         <li>
 336                 <h3 id="Catalog">
 337 <a href="ion/Catalog">Catalog</a><a class="permalink" href="ion#Catalog">#</a>
 338 </h3>
 339                 <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>
 340
 341                 <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>
 342         </li>
 343
 344         <li>
 345                 <h3 id="Decimal">
 346 <a href="ion/Decimal">Decimal</a><a class="permalink" href="ion#Decimal">#</a>
 347 </h3>
 348                 <p>An arbitrary precision fixed point decimal.</p>
 349
 350                 <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>
 351         </li>
 352
 353         <li>
 354                 <h3 id="Exception">
 355 <a href="ion/Exception">Exception</a><a class="permalink" href="ion#Exception">#</a>
 356 </h3>
 357                 <p>Base exception for the ION extension.</p>
 358
 359                 <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>
 360         </li>
 361
 362         <li>
 363                 <h3 id="LOB">
 364 <a href="ion/LOB">LOB</a><a class="permalink" href="ion#LOB">#</a>
 365 </h3>
 366                 <p>A large object.</p>
 367
 368                 <p><em>class</em> <a href="ion/LOB">ion\LOB</a></p>
 369         </li>
 370
 371         <li>
 372                 <h3 id="Reader">
 373 <a href="ion/Reader">Reader</a><a class="permalink" href="ion#Reader">#</a>
 374 </h3>
 375                 <p>ION reader API.</p>
 376
 377                 <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>
 378         </li>
 379
 380         <li>
 381                 <h3 id="Serializer">
 382 <a href="ion/Serializer">Serializer</a><a class="permalink" href="ion#Serializer">#</a>
 383 </h3>
 384                 <p>Serializer <em>interface</em>, used to customize <a href="ion/serialize">ion\serialize</a>()'s behavior.</p>
 385
 386                 <p><em>interface</em> <a href="ion/Serializer">ion\Serializer</a></p>
 387         </li>
 388
 389         <li>
 390                 <h3 id="Symbol">
 391 <a href="ion/Symbol">Symbol</a><a class="permalink" href="ion#Symbol">#</a>
 392 </h3>
 393
 394                 <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>
 395         </li>
 396
 397         <li>
 398                 <h3 id="Timestamp">
 399 <a href="ion/Timestamp">Timestamp</a><a class="permalink" href="ion#Timestamp">#</a>
 400 </h3>
 401                 <p>An ION Timestamp.</p>
 402
 403                 <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>
 404         </li>
 405
 406         <li>
 407                 <h3 id="Type">
 408 <a href="ion/Type">Type</a><a class="permalink" href="ion#Type">#</a>
 409 </h3>
 410                 <p>ION data type.</p>
 411
 412                 <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>
 413         </li>
 414
 415         <li>
 416                 <h3 id="Unserializer">
 417 <a href="ion/Unserializer">Unserializer</a><a class="permalink" href="ion#Unserializer">#</a>
 418 </h3>
 419                 <p>Unserializer <em>interface</em>, used to customize <a href="ion/unserialize">ion\unserialize</a>()'s behavior.</p>
 420
 421                 <p><em>interface</em> <a href="ion/Unserializer">ion\Unserializer</a></p>
 422         </li>
 423
 424         <li>
 425                 <h3 id="Writer">
 426 <a href="ion/Writer">Writer</a><a class="permalink" href="ion#Writer">#</a>
 427 </h3>
 428                 <p>ION writer API.</p>
 429
 430                 <p><em>interface</em> <a href="ion/Writer">ion\Writer</a></p>
 431         </li>
 432
 433 </ul>
 434                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 435                         <script>
 436                                 var disqus_shortname = 'mdref';
 437                                 var disqus_identifier = 'ion';
 438                         </script>
 439
 440                         <footer>
 441
 442 <ul>
 443         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 444 </a></li>
 445         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 446         <li>
 447 </li>
 448 </ul>
 449
 450                         </footer>
 451
 452                         <script src="index.js"></script>
 453
 454                 </div>
 455         </body>
 456 </html>