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="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/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="/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
 224 <h1>interface ion\Writer</h1>
 225 <p>ION writer API.</p>
 226 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 227 <p>None.</p>
 228 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 229 <p>None.</p>
 230
 231
 232
 233 <h2 id="Functions:">Functions:</h2>
 234 <ul>
 235
 236         <li>
 237                 <h3><a href="ion/Writer/appendLob">Writer::appendLob</a></h3>
 238
 239                 <p>void ion\Writer::appendLob(string $data)</p>
 240         </li>
 241
 242         <li>
 243                 <h3><a href="ion/Writer/finish">Writer::finish</a></h3>
 244
 245                 <p>int ion\Writer::finish()</p>
 246         </li>
 247
 248         <li>
 249                 <h3><a href="ion/Writer/finishContainer">Writer::finishContainer</a></h3>
 250
 251                 <p>void ion\Writer::finishContainer()</p>
 252         </li>
 253
 254         <li>
 255                 <h3><a href="ion/Writer/finishLob">Writer::finishLob</a></h3>
 256
 257                 <p>void ion\Writer::finishLob()</p>
 258         </li>
 259
 260         <li>
 261                 <h3><a href="ion/Writer/flush">Writer::flush</a></h3>
 262
 263                 <p>int ion\Writer::flush()</p>
 264         </li>
 265
 266         <li>
 267                 <h3><a href="ion/Writer/getDepth">Writer::getDepth</a></h3>
 268
 269                 <p>int ion\Writer::getDepth()</p>
 270         </li>
 271
 272         <li>
 273                 <h3><a href="ion/Writer/startContainer">Writer::startContainer</a></h3>
 274
 275                 <p>void ion\Writer::startContainer(ion\Type $type)</p>
 276         </li>
 277
 278         <li>
 279                 <h3><a href="ion/Writer/startLob">Writer::startLob</a></h3>
 280
 281                 <p>void ion\Writer::startLob(ion\Type $type)</p>
 282         </li>
 283
 284         <li>
 285                 <h3><a href="ion/Writer/writeAnnotation">Writer::writeAnnotation</a></h3>
 286
 287                 <p>void ion\Writer::writeAnnotation([ion\Symbol|string  ?&gt;...$annotation])</p>
 288         </li>
 289
 290         <li>
 291                 <h3><a href="ion/Writer/writeBLob">Writer::writeBLob</a></h3>
 292
 293                 <p>void ion\Writer::writeBLob(string $value)</p>
 294         </li>
 295
 296         <li>
 297                 <h3><a href="ion/Writer/writeBool">Writer::writeBool</a></h3>
 298
 299                 <p>void ion\Writer::writeBool(bool $value)</p>
 300         </li>
 301
 302         <li>
 303                 <h3><a href="ion/Writer/writeCLob">Writer::writeCLob</a></h3>
 304
 305                 <p>void ion\Writer::writeCLob(string $value)</p>
 306         </li>
 307
 308         <li>
 309                 <h3><a href="ion/Writer/writeDecimal">Writer::writeDecimal</a></h3>
 310
 311                 <p>void ion\Writer::writeDecimal(ion\Decimal|string $value)</p>
 312         </li>
 313
 314         <li>
 315                 <h3><a href="ion/Writer/writeFieldName">Writer::writeFieldName</a></h3>
 316
 317                 <p>void ion\Writer::writeFieldName(string $name)</p>
 318         </li>
 319
 320         <li>
 321                 <h3><a href="ion/Writer/writeFloat">Writer::writeFloat</a></h3>
 322
 323                 <p>void ion\Writer::writeFloat(float $value)</p>
 324         </li>
 325
 326         <li>
 327                 <h3><a href="ion/Writer/writeInt">Writer::writeInt</a></h3>
 328
 329                 <p>void ion\Writer::writeInt(string|int $value)</p>
 330         </li>
 331
 332         <li>
 333                 <h3><a href="ion/Writer/writeNull">Writer::writeNull</a></h3>
 334
 335                 <p>void ion\Writer::writeNull()</p>
 336         </li>
 337
 338         <li>
 339                 <h3><a href="ion/Writer/writeString">Writer::writeString</a></h3>
 340
 341                 <p>void ion\Writer::writeString(string $value)</p>
 342         </li>
 343
 344         <li>
 345                 <h3><a href="ion/Writer/writeSymbol">Writer::writeSymbol</a></h3>
 346
 347                 <p>void ion\Writer::writeSymbol(ion\Symbol|string $value)</p>
 348         </li>
 349
 350         <li>
 351                 <h3><a href="ion/Writer/writeTimestamp">Writer::writeTimestamp</a></h3>
 352
 353                 <p>void ion\Writer::writeTimestamp(ion\Timestamp|string $value)</p>
 354         </li>
 355
 356         <li>
 357                 <h3><a href="ion/Writer/writeTypedNull">Writer::writeTypedNull</a></h3>
 358
 359                 <p>void ion\Writer::writeTypedNull(ion\Type $type)</p>
 360         </li>
 361
 362 </ul>
 363
 364
 365 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
 366 <ul>
 367
 368         <li>
 369                 <h3><a href="ion/Writer/Buffer">Buffer</a></h3>
 370                 <p>ION buffer writer API.</p>
 371
 372                 <p>interface ion\Writer\Buffer implements ion\Writer</p>
 373         </li>
 374
 375         <li>
 376                 <h3><a href="ion/Writer/Options">Options</a></h3>
 377                 <p>ION writer options.</p>
 378
 379                 <p>class ion\Writer\Options</p>
 380         </li>
 381
 382         <li>
 383                 <h3><a href="ion/Writer/Stream">Stream</a></h3>
 384                 <p>ION stream writer API.</p>
 385
 386                 <p>interface ion\Writer\Stream implements ion\Writer</p>
 387         </li>
 388
 389         <li>
 390                 <h3><a href="ion/Writer/Writer">Writer</a></h3>
 391                 <p>Base implementation of common functionality of ION writers.</p>
 392
 393                 <p>abstract class ion\Writer\Writer implements ion\Writer</p>
 394         </li>
 395
 396 </ul>
 397
 398                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 399                         <script>
 400                                 var disqus_shortname = 'mdref';
 401                                 var disqus_identifier = 'ion/Writer';
 402                         </script>
 403
 404                         <footer>
 405
 406 <ul>
 407         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 408 </a></li>
 409         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 410         <li>
 411 </li>
 412 </ul>
 413
 414                         </footer>
 415
 416                         <script src="index.js"></script>
 417
 418                 </div>
 419         </body>
 420 </html>