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

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