Skip to content

Commit

Permalink
Normalize method signatures for ResultStatement::fetch() and `Resul…
Browse files Browse the repository at this point in the history 
…tStatement::fetchAll()`
  • Loading branch information
@phansys
phansys committed Oct 1, 2016
1 parent ec8fc16 commit 1008ae4
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 41 deletions.
4 changes: 2 additions & 2 deletions lib/Doctrine/DBAL/Cache/ArrayStatement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public function getIterator()
/**
* {@inheritdoc}
*/
public function fetch($fetchMode = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
if (isset($this->data[$this->num])) {
$row = $this->data[$this->num++];
Expand All @@ -122,7 +122,7 @@ public function fetch($fetchMode = null)
/**
* {@inheritdoc}
*/
public function fetchAll($fetchMode = null)
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
$rows = array();
while ($row = $this->fetch($fetchMode)) {
Expand Down
4 changes: 2 additions & 2 deletions lib/Doctrine/DBAL/Cache/ResultCacheStatement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public function getIterator()
/**
* {@inheritdoc}
*/
public function fetch($fetchMode = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
if ($this->data === null) {
$this->data = array();
Expand Down Expand Up @@ -179,7 +179,7 @@ public function fetch($fetchMode = null)
/**
* {@inheritdoc}
*/
public function fetchAll($fetchMode = null)
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
$rows = array();
while ($row = $this->fetch($fetchMode)) {
Expand Down
4 changes: 2 additions & 2 deletions lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ public function getIterator()
/**
* {@inheritdoc}
*/
public function fetch($fetchMode = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
$fetchMode = $fetchMode ?: $this->_defaultFetchMode;

Expand All @@ -276,7 +276,7 @@ public function fetch($fetchMode = null)
/**
* {@inheritdoc}
*/
public function fetchAll($fetchMode = null)
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
$fetchMode = $fetchMode ?: $this->_defaultFetchMode;

Expand Down
14 changes: 7 additions & 7 deletions lib/Doctrine/DBAL/Driver/PDOStatement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,18 +97,18 @@ public function execute($params = null)
/**
* {@inheritdoc}
*/
public function fetch($fetchMode = null, $cursorOrientation = null, $cursorOffset = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
try {
if ($fetchMode === null && $cursorOrientation === null && $cursorOffset === null) {
if ($fetchMode === null && \PDO::FETCH_ORI_NEXT === $cursorOrientation && 0 === $cursorOffset) {
return parent::fetch();
}

if ($cursorOrientation === null && $cursorOffset === null) {
if (\PDO::FETCH_ORI_NEXT === $cursorOrientation && 0 === $cursorOffset) {
return parent::fetch($fetchMode);
}

if ($cursorOffset === null) {
if (0 === $cursorOffset) {
return parent::fetch($fetchMode, $cursorOrientation);
}

Expand All @@ -124,15 +124,15 @@ public function fetch($fetchMode = null, $cursorOrientation = null, $cursorOffse
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
try {
if ($fetchMode === null && $fetchArgument === null && $ctorArgs === null) {
if ($fetchMode === null && null === $fetchArgument && null === $ctorArgs) {
return parent::fetchAll();
}

if ($fetchArgument === null && $ctorArgs === null) {
if (0 === $fetchArgument && null === $ctorArgs) {
return parent::fetchAll($fetchMode);
}

if ($ctorArgs === null) {
if (null === $ctorArgs) {
return parent::fetchAll($fetchMode, $fetchArgument);
}

Expand Down
42 changes: 33 additions & 9 deletions lib/Doctrine/DBAL/Driver/ResultStatement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,29 +58,53 @@ public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null);
/**
* Returns the next row of a result set.
*
* @param integer|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the PDO::FETCH_* constants,
* defaulting to PDO::FETCH_BOTH.
* * @param int|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the \PDO::FETCH_* constants,
* defaulting to \PDO::FETCH_BOTH.
* @param int $cursorOrientation For a ResultStatement object representing a scrollable cursor,
* this value determines which row will be returned to the caller.
* This value must be one of the \PDO::FETCH_ORI_* constants,
* defaulting to \PDO::FETCH_ORI_NEXT. To request a scrollable
* cursor for your ResultStatement object, you must set the \PDO::ATTR_CURSOR
* attribute to \PDO::CURSOR_SCROLL when you prepare the SQL statement with
* \PDO::prepare().
* @param int $cursorOffset For a ResultStatement object representing a scrollable cursor for which the
* cursorOrientation parameter is set to \PDO::FETCH_ORI_ABS, this value
* specifies the absolute number of the row in the result set that shall be
* fetched.
* For a ResultStatement object representing a scrollable cursor for which the
* cursorOrientation parameter is set to \PDO::FETCH_ORI_REL, this value
* specifies the row to fetch relative to the cursor position before
* ResultStatement::fetch() was called.
*
* @return mixed The return value of this method on success depends on the fetch mode. In all cases, FALSE is
* returned on failure.
*
* @see PDO::FETCH_* constants.
*/
public function fetch($fetchMode = null);
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0);

/**
* Returns an array containing all of the result set rows.
*
* @param integer|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the PDO::FETCH_* constants,
* defaulting to PDO::FETCH_BOTH.
* @param int|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the \PDO::FETCH_* constants,
* defaulting to \PDO::FETCH_BOTH.
* @param int|null $fetchArgument This argument has a different meaning depending on the value of the $fetchMode parameter:
* * \PDO::FETCH_COLUMN: Returns the indicated 0-indexed column.
* * \PDO::FETCH_CLASS: Returns instances of the specified class, mapping the columns of each
* row to named properties in the class.
* * \PDO::FETCH_FUNC: Returns the results of calling the specified function, using each row's
* columns as parameters in the call.
* @param array|null $ctorArgs Controls how the next row will be returned to the caller.
* The value must be one of the \PDO::FETCH_* constants,
* defaulting to \PDO::FETCH_BOTH.
*
* @return array
*
* @see PDO::FETCH_* constants.
* @see \PDO::FETCH_* constants.
*/
public function fetchAll($fetchMode = null);
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null);

/**
* Returns a single column from the next row of a result set or FALSE if there are no more rows.
Expand Down
8 changes: 4 additions & 4 deletions lib/Doctrine/DBAL/Portability/Statement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ public function getIterator()
/**
* {@inheritdoc}
*/
public function fetch($fetchMode = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
$fetchMode = $fetchMode ?: $this->defaultFetchMode;

Expand All @@ -159,12 +159,12 @@ public function fetch($fetchMode = null)
/**
* {@inheritdoc}
*/
public function fetchAll($fetchMode = null, $columnIndex = 0)
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
$fetchMode = $fetchMode ?: $this->defaultFetchMode;

if ($columnIndex != 0) {
$rows = $this->stmt->fetchAll($fetchMode, $columnIndex);
if ($fetchArgument) {
$rows = $this->stmt->fetchAll($fetchMode, $fetchArgument);
} else {
$rows = $this->stmt->fetchAll($fetchMode);
}
Expand Down
20 changes: 5 additions & 15 deletions lib/Doctrine/DBAL/Statement.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,29 +252,19 @@ public function getIterator()
}

/**
* Fetches the next row from a result set.
*
* @param integer|null $fetchMode
*
* @return mixed The return value of this function on success depends on the fetch type.
* In all cases, FALSE is returned on failure.
* {@inheritdoc}
*/
public function fetch($fetchMode = null)
public function fetch($fetchMode = null, $cursorOrientation = \PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
{
return $this->stmt->fetch($fetchMode);
}

/**
* Returns an array containing all of the result set rows.
*
* @param integer|null $fetchMode
* @param mixed $fetchArgument
*
* @return array An array containing all of the remaining rows in the result set.
* {@inheritdoc}
*/
public function fetchAll($fetchMode = null, $fetchArgument = 0)
public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
{
if ($fetchArgument !== 0) {
if ($fetchArgument) {
return $this->stmt->fetchAll($fetchMode, $fetchArgument);
}

Expand Down

0 comments on commit 1008ae4

Please sign in to comment.