[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/joomla/database/src/ -> DatabaseIterator.php (summary)

Part of the Joomla Framework Database Package

Copyright: Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 256 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

DatabaseIterator:: (10 methods):
  __construct()
  __destruct()
  count()
  current()
  key()
  next()
  rewind()
  valid()
  fetchObject()
  freeResult()


Class: DatabaseIterator  - X-Ref

Joomla Framework Database Driver Class

__construct(StatementInterface $statement, $column = null, $class = \stdClass::class)   X-Ref
Database iterator constructor.

param: StatementInterface  $statement  The statement holding the result set to iterate.
param: string              $column     An option column to use as the iterator key.
param: string              $class      The class of object that is returned.

__destruct()   X-Ref
Database iterator destructor.


count()   X-Ref
Get the number of rows in the result set for the executed SQL given by the cursor.

return: integer  The number of rows in the result set.

current()   X-Ref
The current element in the iterator.

return: object

key()   X-Ref
The key of the current element in the iterator.

return: scalar

next()   X-Ref
Moves forward to the next result from the SQL query.

return: void

rewind()   X-Ref
Rewinds the iterator.

This iterator cannot be rewound.

return: void

valid()   X-Ref
Checks if the current position of the iterator is valid.

return: boolean

fetchObject()   X-Ref
Method to fetch a row from the result set cursor as an object.

return: mixed  Either the next row from the result set or false if there are no more rows.

freeResult()   X-Ref
Method to free up the memory used for the result set.

return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer