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