php-src/ext/pdo/pdo_stmt.stub.php
Nikita Popov ff19ec2df3 Introduce InternalIterator
Userland classes that implement Traversable must do so either
through Iterator or IteratorAggregate. The same requirement does
not exist for internal classes: They can implement the internal
get_iterator mechanism, without exposing either the Iterator or
IteratorAggregate APIs. This makes them usable in get_iterator(),
but incompatible with any Iterator based APIs.

A lot of internal classes do this, because exposing the userland
APIs is simply a lot of work. This patch alleviates this issue by
providing a generic InternalIterator class, which acts as an
adapater between get_iterator and Iterator, and can be easily
used by many internal classes. At the same time, we extend the
requirement that Traversable implies Iterator or IteratorAggregate
to internal classes as well.

Closes GH-5216.
2020-06-24 15:31:41 +02:00

86 lines
2.2 KiB
PHP

<?php
/** @generate-function-entries */
class PDOStatement implements IteratorAggregate
{
/**
* @param mixed $driverdata
* @return bool
*/
public function bindColumn(int|string $column, &$param, int $type = 0, int $maxlen = 0, $driverdata = null) {}
/**
* @param mixed $driver_options
* @return bool
*/
public function bindParam(int|string $parameter, &$param, int $type = PDO::PARAM_STR, int $maxlen = 0, $driverdata = null) {}
/**
* @param int|string $parameter
* @param mixed $value
* @return bool
*/
public function bindValue($parameter, $value, int $type = PDO::PARAM_STR) {}
/** @return bool */
public function closeCursor() {}
/** @return int|false */
public function columnCount() {}
/** @return false|null */
public function debugDumpParams() {}
/** @return string|false|null */
public function errorCode() {}
/** @return array|false */
public function errorInfo() {}
/** @return bool */
public function execute(?array $input_parameters = null) {}
/** @return mixed */
public function fetch(int $fetch_style = PDO::FETCH_BOTH, int $cursor_orientation = PDO::FETCH_ORI_NEXT, int $cursor_offset = 0) {}
/**
* @param mixed $fetch_argument
* @return array|false
*/
public function fetchAll(int $fetch_style = PDO::FETCH_BOTH, $fetch_argument = UNKNOWN, array $ctor_args = []) {}
/** @return mixed */
public function fetchColumn(int $column_number = 0) {}
/** @return mixed */
public function fetchObject(?string $class_name = "stdClass", ?array $ctor_args = null) {}
/** @return mixed */
public function getAttribute(int $attribute) {}
/** @return array|false */
public function getColumnMeta(int $column) {}
/** @return bool */
public function nextRowset() {}
/** @return int|false */
public function rowCount() {}
/**
* @param mixed $value
* @return bool
*/
public function setAttribute(int $attribute, $value) {}
/** @return bool */
public function setFetchMode(int $mode, $param1 = UNKNOWN, $param2 = UNKNOWN) {}
public function getIterator(): Iterator {}
}
final class PDORow
{
}