git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/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="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/v0.0/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="/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/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/: Contributing">★ Contributing</a></li>
 225
 226                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
 227
 228                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 229
 230                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
 231
 232                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 233
 234                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 235
 236                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 237
 238                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
 239
 240                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 241
 242                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 243
 244                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 245
 246                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
 247
 248                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 249
 250                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 251
 252                                 </li>
 253                         </ul>
 254
 255                 </li>
 256         </ul>
 257 </div>
 258
 259 <h1>interface ion\Reader implements Iterator, RecursiveIterator, Traversable</h1>
 260 <p>ION reader API.</p>
 261 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 262 <p>None.</p>
 263 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 264 <p>None.</p>
 265
 266
 267
 268 <h2 id="Functions:">Functions:</h2>
 269 <ul>
 270
 271         <li>
 272                 <h3><a href="ion/Reader/countAnnotations">Reader::countAnnotations</a></h3>
 273
 274                 <p>int ion\Reader::countAnnotations()</p>
 275         </li>
 276
 277         <li>
 278                 <h3><a href="ion/Reader/getAnnotation">Reader::getAnnotation</a></h3>
 279
 280                 <p>string ion\Reader::getAnnotation(int $index)</p>
 281         </li>
 282
 283         <li>
 284                 <h3><a href="ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></h3>
 285
 286                 <p>ion\Symbol ion\Reader::getAnnotationSymbol(int $index)</p>
 287         </li>
 288
 289         <li>
 290                 <h3><a href="ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></h3>
 291
 292                 <p>array ion\Reader::getAnnotationSymbols()</p>
 293         </li>
 294
 295         <li>
 296                 <h3><a href="ion/Reader/getAnnotations">Reader::getAnnotations</a></h3>
 297
 298                 <p>array ion\Reader::getAnnotations()</p>
 299         </li>
 300
 301         <li>
 302                 <h3><a href="ion/Reader/getDepth">Reader::getDepth</a></h3>
 303
 304                 <p>int ion\Reader::getDepth()</p>
 305         </li>
 306
 307         <li>
 308                 <h3><a href="ion/Reader/getFieldName">Reader::getFieldName</a></h3>
 309
 310                 <p>string ion\Reader::getFieldName()</p>
 311         </li>
 312
 313         <li>
 314                 <h3><a href="ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></h3>
 315
 316                 <p>ion\Symbol ion\Reader::getFieldNameSymbol()</p>
 317         </li>
 318
 319         <li>
 320                 <h3><a href="ion/Reader/getPosition">Reader::getPosition</a></h3>
 321
 322                 <p>int ion\Reader::getPosition()</p>
 323         </li>
 324
 325         <li>
 326                 <h3><a href="ion/Reader/getType">Reader::getType</a></h3>
 327
 328                 <p>ion\Type ion\Reader::getType()</p>
 329         </li>
 330
 331         <li>
 332                 <h3><a href="ion/Reader/getValueLength">Reader::getValueLength</a></h3>
 333
 334                 <p>int ion\Reader::getValueLength()</p>
 335         </li>
 336
 337         <li>
 338                 <h3><a href="ion/Reader/getValueOffset">Reader::getValueOffset</a></h3>
 339
 340                 <p>int ion\Reader::getValueOffset()</p>
 341         </li>
 342
 343         <li>
 344                 <h3><a href="ion/Reader/hasAnnotation">Reader::hasAnnotation</a></h3>
 345
 346                 <p>bool ion\Reader::hasAnnotation(string $annotation)</p>
 347         </li>
 348
 349         <li>
 350                 <h3><a href="ion/Reader/hasAnnotations">Reader::hasAnnotations</a></h3>
 351
 352                 <p>bool ion\Reader::hasAnnotations()</p>
 353         </li>
 354
 355         <li>
 356                 <h3><a href="ion/Reader/isInStruct">Reader::isInStruct</a></h3>
 357
 358                 <p>bool ion\Reader::isInStruct()</p>
 359         </li>
 360
 361         <li>
 362                 <h3><a href="ion/Reader/isNull">Reader::isNull</a></h3>
 363
 364                 <p>bool ion\Reader::isNull()</p>
 365         </li>
 366
 367         <li>
 368                 <h3><a href="ion/Reader/readBool">Reader::readBool</a></h3>
 369
 370                 <p>bool ion\Reader::readBool()</p>
 371         </li>
 372
 373         <li>
 374                 <h3><a href="ion/Reader/readDecimal">Reader::readDecimal</a></h3>
 375
 376                 <p>ion\Decimal ion\Reader::readDecimal()</p>
 377         </li>
 378
 379         <li>
 380                 <h3><a href="ion/Reader/readFloat">Reader::readFloat</a></h3>
 381
 382                 <p>float ion\Reader::readFloat()</p>
 383         </li>
 384
 385         <li>
 386                 <h3><a href="ion/Reader/readInt">Reader::readInt</a></h3>
 387
 388                 <p>string|int ion\Reader::readInt()</p>
 389         </li>
 390
 391         <li>
 392                 <h3><a href="ion/Reader/readLob">Reader::readLob</a></h3>
 393
 394                 <p>string ion\Reader::readLob()</p>
 395         </li>
 396
 397         <li>
 398                 <h3><a href="ion/Reader/readLobPart">Reader::readLobPart</a></h3>
 399
 400                 <p>bool ion\Reader::readLobPart( &amp;$string, [int $length = 4096])</p>
 401         </li>
 402
 403         <li>
 404                 <h3><a href="ion/Reader/readNull">Reader::readNull</a></h3>
 405
 406                 <p>ion\Type ion\Reader::readNull()</p>
 407         </li>
 408
 409         <li>
 410                 <h3><a href="ion/Reader/readString">Reader::readString</a></h3>
 411
 412                 <p>string ion\Reader::readString()</p>
 413         </li>
 414
 415         <li>
 416                 <h3><a href="ion/Reader/readStringPart">Reader::readStringPart</a></h3>
 417
 418                 <p>bool ion\Reader::readStringPart( &amp;$string, [int $length = 4096])</p>
 419         </li>
 420
 421         <li>
 422                 <h3><a href="ion/Reader/readSymbol">Reader::readSymbol</a></h3>
 423
 424                 <p>ion\Symbol ion\Reader::readSymbol()</p>
 425         </li>
 426
 427         <li>
 428                 <h3><a href="ion/Reader/readTimestamp">Reader::readTimestamp</a></h3>
 429
 430                 <p>ion\Timestamp ion\Reader::readTimestamp()</p>
 431         </li>
 432
 433         <li>
 434                 <h3><a href="ion/Reader/seek">Reader::seek</a></h3>
 435
 436                 <p>void ion\Reader::seek(int $offset, [int $length = -1])</p>
 437         </li>
 438
 439 </ul>
 440
 441
 442 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
 443 <ul>
 444
 445         <li>
 446                 <h3><a href="ion/Reader/Buffer">Buffer</a></h3>
 447                 <p>ION string buffer reader API.</p>
 448
 449                 <p>interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
 450         </li>
 451
 452         <li>
 453                 <h3><a href="ion/Reader/Options">Options</a></h3>
 454                 <p>Reader options.</p>
 455
 456                 <p>class ion\Reader\Options</p>
 457         </li>
 458
 459         <li>
 460                 <h3><a href="ion/Reader/Reader">Reader</a></h3>
 461                 <p>Base implementation of ION readers.</p>
 462
 463                 <p>abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
 464         </li>
 465
 466         <li>
 467                 <h3><a href="ion/Reader/Stream">Stream</a></h3>
 468                 <p>ION stream reader API.</p>
 469
 470                 <p>interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader</p>
 471         </li>
 472
 473 </ul>
 474
 475                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 476                         <script>
 477                                 var disqus_shortname = 'mdref';
 478                                 var disqus_identifier = 'ion/Reader';
 479                         </script>
 480
 481                         <footer>
 482
 483 <ul>
 484         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 485 </a></li>
 486         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 487         <li>
 488 </li>
 489 </ul>
 490
 491                         </footer>
 492
 493                         <script src="index.js"></script>
 494
 495                 </div>
 496         </body>
 497 </html>