diff options
Diffstat (limited to 'lib/public/DB/IResult.php')
| -rw-r--r-- | lib/public/DB/IResult.php | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/lib/public/DB/IResult.php b/lib/public/DB/IResult.php index 10c788ebbf6..347919ab336 100644 --- a/lib/public/DB/IResult.php +++ b/lib/public/DB/IResult.php @@ -2,36 +2,30 @@ 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/>. +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCP\DB; use PDO; /** + * This interface represents the result of a database query. + * + * Usage: + * + * ```php + * $qb = $this->db->getQueryBuilder(); + * $qb->select(...); + * $result = $query->executeQuery(); + * ``` + * + * This interface must not be implemented in your application. + * * @since 21.0.0 */ interface IResult { - /** * @return true * @@ -66,7 +60,7 @@ interface IResult { public function fetchColumn(); /** - * @param int $columnIndex + * Returns the first value of the next row of the result or FALSE if there are no more rows. * * @return false|mixed * |