Skip to content

Commit c05f5a6

Browse files
kenjiskenjis
authored
docs: replace tabs with spaces
1 parent 194a484 commit c05f5a6

File tree

5 files changed

+252
-252
lines changed

5 files changed

+252
-252
lines changed

‎user_guide_src/source/database/results.rst

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,8 @@ be aware of the tradeoffs associated with it.
176176
$csv = $file->openFile('w');
177177

178178
while ($row = $query->getUnbufferedRow('array'))
179-
{
180-
$csv->fputcsv($row);
179+
{
180+
$csv->fputcsv($row);
181181
}
182182

183183
$db->resultMode = MYSQLI_STORE_RESULT; // return to default mode
@@ -364,9 +364,9 @@ Class Reference
364364
365365
.. php:method:: getResult([$type = 'object'])
366366
367-
:param string $type: Type of requested results - array, object, or class name
368-
:returns: Array containing the fetched rows
369-
:rtype: array
367+
:param string $type: Type of requested results - array, object, or class name
368+
:returns: Array containing the fetched rows
369+
:rtype: array
370370

371371
A wrapper for the ``getResultArray()``, ``getResultObject()``
372372
and ``getCustomResultObject()`` methods.
@@ -375,8 +375,8 @@ Class Reference
375375

376376
.. php:method:: getResultArray()
377377
378-
:returns: Array containing the fetched rows
379-
:rtype: array
378+
:returns: Array containing the fetched rows
379+
:rtype: array
380380

381381
Returns the query results as an array of rows, where each
382382
row is itself an associative array.
@@ -385,8 +385,8 @@ Class Reference
385385

386386
.. php:method:: getResultObject()
387387
388-
:returns: Array containing the fetched rows
389-
:rtype: array
388+
:returns: Array containing the fetched rows
389+
:rtype: array
390390

391391
Returns the query results as an array of rows, where each
392392
row is an object of type ``stdClass``.
@@ -395,19 +395,19 @@ Class Reference
395395

396396
.. php:method:: getCustomResultObject($class_name)
397397
398-
:param string $class_name: Class name for the resulting rows
399-
:returns: Array containing the fetched rows
400-
:rtype: array
398+
:param string $class_name: Class name for the resulting rows
399+
:returns: Array containing the fetched rows
400+
:rtype: array
401401

402402
Returns the query results as an array of rows, where each
403403
row is an instance of the specified class.
404404

405405
.. php:method:: getRow([$n = 0[, $type = 'object']])
406406
407-
:param int $n: Index of the query results row to be returned
408-
:param string $type: Type of the requested result - array, object, or class name
409-
:returns: The requested row or null if it doesn't exist
410-
:rtype: mixed
407+
:param int $n: Index of the query results row to be returned
408+
:param string $type: Type of the requested result - array, object, or class name
409+
:returns: The requested row or null if it doesn't exist
410+
:rtype: mixed
411411

412412
A wrapper for the ``getRowArray()``, ``getRowObject()`` and
413413
``getCustomRowObject()`` methods.
@@ -416,9 +416,9 @@ Class Reference
416416

417417
.. php:method:: getUnbufferedRow([$type = 'object'])
418418
419-
:param string $type: Type of the requested result - array, object, or class name
420-
:returns: Next row from the result set or null if it doesn't exist
421-
:rtype: mixed
419+
:param string $type: Type of the requested result - array, object, or class name
420+
:returns: Next row from the result set or null if it doesn't exist
421+
:rtype: mixed
422422

423423
Fetches the next result row and returns it in the
424424
requested form.
@@ -427,19 +427,19 @@ Class Reference
427427

428428
.. php:method:: getRowArray([$n = 0])
429429
430-
:param int $n: Index of the query results row to be returned
431-
:returns: The requested row or null if it doesn't exist
432-
:rtype: array
430+
:param int $n: Index of the query results row to be returned
431+
:returns: The requested row or null if it doesn't exist
432+
:rtype: array
433433

434434
Returns the requested result row as an associative array.
435435

436436
Usage: see `Result Rows`_.
437437

438438
.. php:method:: getRowObject([$n = 0])
439439
440-
:param int $n: Index of the query results row to be returned
441-
:returns: The requested row or null if it doesn't exist
442-
:rtype: stdClass
440+
:param int $n: Index of the query results row to be returned
441+
:returns: The requested row or null if it doesn't exist
442+
:rtype: stdClass
443443

444444
Returns the requested result row as an object of type
445445
``stdClass``.
@@ -448,99 +448,99 @@ Class Reference
448448

449449
.. php:method:: getCustomRowObject($n, $type)
450450
451-
:param int $n: Index of the results row to return
452-
:param string $class_name: Class name for the resulting row
453-
:returns: The requested row or null if it doesn't exist
454-
:rtype: $type
451+
:param int $n: Index of the results row to return
452+
:param string $class_name: Class name for the resulting row
453+
:returns: The requested row or null if it doesn't exist
454+
:rtype: $type
455455

456456
Returns the requested result row as an instance of the
457457
requested class.
458458

459459
.. php:method:: dataSeek([$n = 0])
460460
461-
:param int $n: Index of the results row to be returned next
462-
:returns: true on success, false on failure
463-
:rtype: bool
461+
:param int $n: Index of the results row to be returned next
462+
:returns: true on success, false on failure
463+
:rtype: bool
464464

465465
Moves the internal results row pointer to the desired offset.
466466

467467
Usage: see `Result Helper Methods`_.
468468

469469
.. php:method:: setRow($key[, $value = null])
470470
471-
:param mixed $key: Column name or array of key/value pairs
472-
:param mixed $value: Value to assign to the column, $key is a single field name
473-
:rtype: void
471+
:param mixed $key: Column name or array of key/value pairs
472+
:param mixed $value: Value to assign to the column, $key is a single field name
473+
:rtype: void
474474

475475
Assigns a value to a particular column.
476476

477477
.. php:method:: getNextRow([$type = 'object'])
478478
479-
:param string $type: Type of the requested result - array, object, or class name
480-
:returns: Next row of result set, or null if it doesn't exist
481-
:rtype: mixed
479+
:param string $type: Type of the requested result - array, object, or class name
480+
:returns: Next row of result set, or null if it doesn't exist
481+
:rtype: mixed
482482

483483
Returns the next row from the result set.
484484

485485
.. php:method:: getPreviousRow([$type = 'object'])
486486
487-
:param string $type: Type of the requested result - array, object, or class name
488-
:returns: Previous row of result set, or null if it doesn't exist
489-
:rtype: mixed
487+
:param string $type: Type of the requested result - array, object, or class name
488+
:returns: Previous row of result set, or null if it doesn't exist
489+
:rtype: mixed
490490

491491
Returns the previous row from the result set.
492492

493493
.. php:method:: getFirstRow([$type = 'object'])
494494
495-
:param string $type: Type of the requested result - array, object, or class name
496-
:returns: First row of result set, or null if it doesn't exist
497-
:rtype: mixed
495+
:param string $type: Type of the requested result - array, object, or class name
496+
:returns: First row of result set, or null if it doesn't exist
497+
:rtype: mixed
498498

499499
Returns the first row from the result set.
500500

501501
.. php:method:: getLastRow([$type = 'object'])
502502
503-
:param string $type: Type of the requested result - array, object, or class name
504-
:returns: Last row of result set, or null if it doesn't exist
505-
:rtype: mixed
503+
:param string $type: Type of the requested result - array, object, or class name
504+
:returns: Last row of result set, or null if it doesn't exist
505+
:rtype: mixed
506506

507507
Returns the last row from the result set.
508508

509509
.. php:method:: getFieldCount()
510510
511-
:returns: Number of fields in the result set
512-
:rtype: int
511+
:returns: Number of fields in the result set
512+
:rtype: int
513513

514514
Returns the number of fields in the result set.
515515

516516
Usage: see `Result Helper Methods`_.
517517

518518
.. php:method:: getFieldNames()
519519
520-
:returns: Array of column names
521-
:rtype: array
520+
:returns: Array of column names
521+
:rtype: array
522522

523523
Returns an array containing the field names in the
524524
result set.
525525

526526
.. php:method:: getFieldData()
527527
528-
:returns: Array containing field meta-data
529-
:rtype: array
528+
:returns: Array containing field meta-data
529+
:rtype: array
530530

531531
Generates an array of ``stdClass`` objects containing
532532
field meta-data.
533533

534534
.. php:method:: getNumRows()
535535
536-
:returns: Number of rows in result set
537-
:rtype: int
536+
:returns: Number of rows in result set
537+
:rtype: int
538538

539539
Returns number of rows returned by the query
540540

541541
.. php:method:: freeResult()
542542
543-
:rtype: void
543+
:rtype: void
544544

545545
Frees a result set.
546546

0 commit comments

Comments
 (0)