nextcloud/lib/public/DB/IResult.php

84 lines
1.8 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
/*
* @copyright 2021 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2021 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\DB;
use PDO;
/**
* @since 21.0.0
*/
interface IResult {
/**
* @return true
*
* @since 21.0.0
*/
public function closeCursor(): bool;
/**
* @param int $fetchMode
*
* @return mixed
*
* @since 21.0.0
*/
public function fetch(int $fetchMode = PDO::FETCH_ASSOC);
/**
* @param int $fetchMode (one of PDO::FETCH_ASSOC, PDO::FETCH_NUM or PDO::FETCH_COLUMN (2, 3 or 7)
*
* @return mixed[]
*
* @since 21.0.0
*/
public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC): array;
/**
* @return mixed
*
* @since 21.0.0
* @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne
*/
public function fetchColumn();
/**
* Returns the first value of the next row of the result or FALSE if there are no more rows.
*
* @return false|mixed
*
* @since 21.0.0
*/
public function fetchOne();
/**
* @return int
*
* @since 21.0.0
*/
public function rowCount(): int;
}