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

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Writer -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion\Writer">
  10                 <meta name="viewport" content="width=1200, initial-scale=0.5">
  11                                         <base href="/ext-ion/v0.2/">
  12                         <meta http-equiv="Content-Location" content="/ext-ion/v0.2/ion/Writer">
  13                         <link rel="stylesheet" href="index.css">
  14
  15                 <link rel="shortcut icon" href="/ext-ion/v0.2/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/Writer">Writer</a></strong>
  40
  41
  42                                                         <ul>
  43
  44                                                                 <li>
  45                                                                         &rdsh; <a href="./ion/Writer/Buffer">Buffer</a>
  46
  47                                                                         <ul>
  48
  49                                                                                 <li>&rdsh; <a href="./ion/Writer/Buffer/Writer">Writer</a>
  50                                                                                 </li>
  51
  52                                                                         </ul>
  53
  54                                                                 </li>
  55
  56                                                                 <li>
  57                                                                         &rdsh; <a href="./ion/Writer/Options">Options</a>
  58
  59                                                                 </li>
  60
  61                                                                 <li>
  62                                                                         &rdsh; <a href="./ion/Writer/Stream">Stream</a>
  63
  64                                                                         <ul>
  65
  66                                                                                 <li>&rdsh; <a href="./ion/Writer/Stream/Writer">Writer</a>
  67                                                                                 </li>
  68
  69                                                                         </ul>
  70
  71                                                                 </li>
  72
  73                                                                 <li>
  74                                                                         &rdsh; <a href="./ion/Writer/Writer">Writer</a>
  75
  76                                                                 </li>
  77
  78                                                                 <li>
  79                                                                         &rdsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a>
  80
  81                                                                 </li>
  82
  83                                                                 <li>
  84                                                                         &rdsh; <a href="./ion/Writer/finish">Writer::finish</a>
  85
  86                                                                 </li>
  87
  88                                                                 <li>
  89                                                                         &rdsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a>
  90
  91                                                                 </li>
  92
  93                                                                 <li>
  94                                                                         &rdsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a>
  95
  96                                                                 </li>
  97
  98                                                                 <li>
  99                                                                         &rdsh; <a href="./ion/Writer/flush">Writer::flush</a>
 100
 101                                                                 </li>
 102
 103                                                                 <li>
 104                                                                         &rdsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a>
 105
 106                                                                 </li>
 107
 108                                                                 <li>
 109                                                                         &rdsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a>
 110
 111                                                                 </li>
 112
 113                                                                 <li>
 114                                                                         &rdsh; <a href="./ion/Writer/startLob">Writer::startLob</a>
 115
 116                                                                 </li>
 117
 118                                                                 <li>
 119                                                                         &rdsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a>
 120
 121                                                                 </li>
 122
 123                                                                 <li>
 124                                                                         &rdsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a>
 125
 126                                                                 </li>
 127
 128                                                                 <li>
 129                                                                         &rdsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a>
 130
 131                                                                 </li>
 132
 133                                                                 <li>
 134                                                                         &rdsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a>
 135
 136                                                                 </li>
 137
 138                                                                 <li>
 139                                                                         &rdsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a>
 140
 141                                                                 </li>
 142
 143                                                                 <li>
 144                                                                         &rdsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a>
 145
 146                                                                 </li>
 147
 148                                                                 <li>
 149                                                                         &rdsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a>
 150
 151                                                                 </li>
 152
 153                                                                 <li>
 154                                                                         &rdsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a>
 155
 156                                                                 </li>
 157
 158                                                                 <li>
 159                                                                         &rdsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a>
 160
 161                                                                 </li>
 162
 163                                                                 <li>
 164                                                                         &rdsh; <a href="./ion/Writer/writeString">Writer::writeString</a>
 165
 166                                                                 </li>
 167
 168                                                                 <li>
 169                                                                         &rdsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a>
 170
 171                                                                 </li>
 172
 173                                                                 <li>
 174                                                                         &rdsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a>
 175
 176                                                                 </li>
 177
 178                                                                 <li>
 179                                                                         &rdsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a>
 180
 181                                                                 </li>
 182
 183                                                         </ul>
 184
 185
 186                                                 </ul>
 187
 188                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
 189
 190                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
 191
 192                                                 <li>&ldsh; <a href="./ion/: Tutorial">★ Tutorial</a></li>
 193
 194                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 195
 196                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
 197
 198                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 199
 200                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 201
 202                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
 203
 204                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 205
 206                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
 207
 208                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 209
 210                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 211
 212                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 213
 214                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 215
 216                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 217
 218                                 </li>
 219                         </ul>
 220
 221                 </li>
 222         </ul>
 223 </div>
 224                                         <meta charset="utf-8"><h1>
 225 <a class="permalink" href="ion/Writer#">#</a><em>interface</em> <a href="ion/Writer">ion\Writer</a>
 226 </h1><p>ION writer API.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Writer#Constants:">#</a>
 227 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Writer#Properties:">#</a>
 228 </h2><p>None.</p><h2 id="Functions:">Functions:<a class="permalink" href="ion/Writer#Functions:">#</a>
 229 </h2><ul class="sub-entries sub-functions">
 230
 231         <li>
 232                 <h3 id="Writer::appendLob">
 233 <a href="ion/Writer/appendLob">Writer::appendLob</a><a class="permalink" href="ion/Writer#Writer::appendLob">#</a>
 234 </h3>
 235
 236                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/appendLob">ion\Writer::appendLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$data</span>)</p>
 237         </li>
 238
 239         <li>
 240                 <h3 id="Writer::finish">
 241 <a href="ion/Writer/finish">Writer::finish</a><a class="permalink" href="ion/Writer#Writer::finish">#</a>
 242 </h3>
 243
 244                 <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/finish">ion\Writer::finish</a>()</p>
 245         </li>
 246
 247         <li>
 248                 <h3 id="Writer::finishContainer">
 249 <a href="ion/Writer/finishContainer">Writer::finishContainer</a><a class="permalink" href="ion/Writer#Writer::finishContainer">#</a>
 250 </h3>
 251
 252                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/finishContainer">ion\Writer::finishContainer</a>()</p>
 253         </li>
 254
 255         <li>
 256                 <h3 id="Writer::finishLob">
 257 <a href="ion/Writer/finishLob">Writer::finishLob</a><a class="permalink" href="ion/Writer#Writer::finishLob">#</a>
 258 </h3>
 259
 260                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/finishLob">ion\Writer::finishLob</a>()</p>
 261         </li>
 262
 263         <li>
 264                 <h3 id="Writer::flush">
 265 <a href="ion/Writer/flush">Writer::flush</a><a class="permalink" href="ion/Writer#Writer::flush">#</a>
 266 </h3>
 267
 268                 <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/flush">ion\Writer::flush</a>()</p>
 269         </li>
 270
 271         <li>
 272                 <h3 id="Writer::getDepth">
 273 <a href="ion/Writer/getDepth">Writer::getDepth</a><a class="permalink" href="ion/Writer#Writer::getDepth">#</a>
 274 </h3>
 275
 276                 <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Writer/getDepth">ion\Writer::getDepth</a>()</p>
 277         </li>
 278
 279         <li>
 280                 <h3 id="Writer::startContainer">
 281 <a href="ion/Writer/startContainer">Writer::startContainer</a><a class="permalink" href="ion/Writer#Writer::startContainer">#</a>
 282 </h3>
 283
 284                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/startContainer">ion\Writer::startContainer</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
 285         </li>
 286
 287         <li>
 288                 <h3 id="Writer::startLob">
 289 <a href="ion/Writer/startLob">Writer::startLob</a><a class="permalink" href="ion/Writer#Writer::startLob">#</a>
 290 </h3>
 291
 292                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/startLob">ion\Writer::startLob</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
 293         </li>
 294
 295         <li>
 296                 <h3 id="Writer::writeAnnotation">
 297 <a href="ion/Writer/writeAnnotation">Writer::writeAnnotation</a><a class="permalink" href="ion/Writer#Writer::writeAnnotation">#</a>
 298 </h3>
 299
 300                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeAnnotation">ion\Writer::writeAnnotation</a>([<a href="ion/Symbol">ion\Symbol</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code>   ?&gt;...<span class="var">$annotation</span>])</p>
 301         </li>
 302
 303         <li>
 304                 <h3 id="Writer::writeBLob">
 305 <a href="ion/Writer/writeBLob">Writer::writeBLob</a><a class="permalink" href="ion/Writer#Writer::writeBLob">#</a>
 306 </h3>
 307
 308                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeBLob">ion\Writer::writeBLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 309         </li>
 310
 311         <li>
 312                 <h3 id="Writer::writeBool">
 313 <a href="ion/Writer/writeBool">Writer::writeBool</a><a class="permalink" href="ion/Writer#Writer::writeBool">#</a>
 314 </h3>
 315
 316                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeBool">ion\Writer::writeBool</a>(<code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$value</span>)</p>
 317         </li>
 318
 319         <li>
 320                 <h3 id="Writer::writeCLob">
 321 <a href="ion/Writer/writeCLob">Writer::writeCLob</a><a class="permalink" href="ion/Writer#Writer::writeCLob">#</a>
 322 </h3>
 323
 324                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeCLob">ion\Writer::writeCLob</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 325         </li>
 326
 327         <li>
 328                 <h3 id="Writer::writeDecimal">
 329 <a href="ion/Writer/writeDecimal">Writer::writeDecimal</a><a class="permalink" href="ion/Writer#Writer::writeDecimal">#</a>
 330 </h3>
 331
 332                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeDecimal">ion\Writer::writeDecimal</a>(<a href="ion/Decimal">ion\Decimal</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 333         </li>
 334
 335         <li>
 336                 <h3 id="Writer::writeFieldName">
 337 <a href="ion/Writer/writeFieldName">Writer::writeFieldName</a><a class="permalink" href="ion/Writer#Writer::writeFieldName">#</a>
 338 </h3>
 339
 340                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeFieldName">ion\Writer::writeFieldName</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$name</span>)</p>
 341         </li>
 342
 343         <li>
 344                 <h3 id="Writer::writeFloat">
 345 <a href="ion/Writer/writeFloat">Writer::writeFloat</a><a class="permalink" href="ion/Writer#Writer::writeFloat">#</a>
 346 </h3>
 347
 348                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeFloat">ion\Writer::writeFloat</a>(<code><a href="https://php.net/manual/en/language.types.float">float</a></code> <span class="var">$value</span>)</p>
 349         </li>
 350
 351         <li>
 352                 <h3 id="Writer::writeInt">
 353 <a href="ion/Writer/writeInt">Writer::writeInt</a><a class="permalink" href="ion/Writer#Writer::writeInt">#</a>
 354 </h3>
 355
 356                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeInt">ion\Writer::writeInt</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.integer">int</a></code> <span class="var">$value</span>)</p>
 357         </li>
 358
 359         <li>
 360                 <h3 id="Writer::writeNull">
 361 <a href="ion/Writer/writeNull">Writer::writeNull</a><a class="permalink" href="ion/Writer#Writer::writeNull">#</a>
 362 </h3>
 363
 364                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeNull">ion\Writer::writeNull</a>()</p>
 365         </li>
 366
 367         <li>
 368                 <h3 id="Writer::writeString">
 369 <a href="ion/Writer/writeString">Writer::writeString</a><a class="permalink" href="ion/Writer#Writer::writeString">#</a>
 370 </h3>
 371
 372                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeString">ion\Writer::writeString</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 373         </li>
 374
 375         <li>
 376                 <h3 id="Writer::writeSymbol">
 377 <a href="ion/Writer/writeSymbol">Writer::writeSymbol</a><a class="permalink" href="ion/Writer#Writer::writeSymbol">#</a>
 378 </h3>
 379
 380                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeSymbol">ion\Writer::writeSymbol</a>(<a href="ion/Symbol">ion\Symbol</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 381         </li>
 382
 383         <li>
 384                 <h3 id="Writer::writeTimestamp">
 385 <a href="ion/Writer/writeTimestamp">Writer::writeTimestamp</a><a class="permalink" href="ion/Writer#Writer::writeTimestamp">#</a>
 386 </h3>
 387
 388                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeTimestamp">ion\Writer::writeTimestamp</a>(<a href="ion/Timestamp">ion\Timestamp</a>|<code><a href="https://php.net/manual/en/language.types.string">string</a></code> <span class="var">$value</span>)</p>
 389         </li>
 390
 391         <li>
 392                 <h3 id="Writer::writeTypedNull">
 393 <a href="ion/Writer/writeTypedNull">Writer::writeTypedNull</a><a class="permalink" href="ion/Writer#Writer::writeTypedNull">#</a>
 394 </h3>
 395
 396                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Writer/writeTypedNull">ion\Writer::writeTypedNull</a>(<a href="ion/Type">ion\Type</a> <span class="var">$type</span>)</p>
 397         </li>
 398
 399 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Writer#Namespaces.Interfaces.and.Classes:">#</a>
 400 </h2><ul class="sub-entries sub-ns-classes">
 401
 402         <li>
 403                 <h3 id="Buffer">
 404 <a href="ion/Writer/Buffer">Buffer</a><a class="permalink" href="ion/Writer#Buffer">#</a>
 405 </h3>
 406                 <p>ION buffer writer API.</p>
 407
 408                 <p><em>interface</em> <a href="ion/Writer/Buffer">ion\Writer\Buffer</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></p>
 409         </li>
 410
 411         <li>
 412                 <h3 id="Options">
 413 <a href="ion/Writer/Options">Options</a><a class="permalink" href="ion/Writer#Options">#</a>
 414 </h3>
 415                 <p>ION writer options.</p>
 416
 417                 <p><em>class</em> <a href="ion/Writer/Options">ion\Writer\Options</a></p>
 418         </li>
 419
 420         <li>
 421                 <h3 id="Stream">
 422 <a href="ion/Writer/Stream">Stream</a><a class="permalink" href="ion/Writer#Stream">#</a>
 423 </h3>
 424                 <p>ION stream writer API.</p>
 425
 426                 <p><em>interface</em> <a href="ion/Writer/Stream">ion\Writer\Stream</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></p>
 427         </li>
 428
 429         <li>
 430                 <h3 id="Writer">
 431 <a href="ion/Writer/Writer">Writer</a><a class="permalink" href="ion/Writer#Writer">#</a>
 432 </h3>
 433                 <p>Base implementation of common functionality of ION writers.</p>
 434
 435                 <p><em>abstract</em> <em>class</em> <a href="ion/Writer/Writer">ion\Writer\Writer</a> <em>implements</em> <a href="ion/Writer">ion\Writer</a></p>
 436         </li>
 437
 438 </ul>
 439                         <div class="comments">
 440                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 441         <script>
 442                 function giscus_load(button) {
 443                         let script = document.createElement("script");
 444                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 445                                                 script.setAttribute("data-category", 'Comments on Docs');
 446                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 447                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 448                                                 script.setAttribute("data-mapping", 'og:title');
 449                                                 script.setAttribute("data-input-position", 'bottom');
 450                                                 script.setAttribute("data-reactions-enabled", false);
 451                                                 script.setAttribute("data-theme", 'light');
 452                                                 script.setAttribute("data-lang", 'en');
 453
 454                         script.src = "//giscus.app/client.js";
 455                         button.parentNode.replaceChild(script, button);
 456                 }
 457         </script>
 458         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 459
 460                         </div>
 461
 462                         <footer>
 463
 464 <ul>
 465         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 466 </a></li>
 467         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 468         <li>
 469 </li>
 470 </ul>
 471
 472                         </footer>
 473
 474                         <script src="index.js" defer></script>
 475
 476                 </div>
 477         </body>
 478 </html>