friendica/src/Database/DatabaseException.php

62 lines
1.8 KiB
PHP
Raw Normal View History

<?php
2022-01-02 04:49:50 -05:00
/**
2023-01-01 09:36:24 -05:00
* @copyright Copyright (C) 2010-2023, the Friendica project
2022-01-02 04:49:50 -05:00
*
* @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 <https://www.gnu.org/licenses/>.
*
*/
declare(strict_types=1);
namespace Friendica\Database;
use Exception;
use Throwable;
/**
* A database fatal exception, which shouldn't occur
*/
class DatabaseException extends Exception
{
protected $query;
/**
* Construct the exception. Note: The message is NOT binary safe.
*
* @link https://php.net/manual/en/exception.construct.php
*
2023-05-13 16:04:51 -04:00
* @param string $message The Database error message.
* @param int $code The Database error code.
* @param string $query The Database error query.
* @param Throwable|null $previous [optional] The previous throwable used for the exception chaining.
*/
public function __construct(string $message, int $code, string $query, Throwable $previous = null)
{
2023-05-13 16:04:51 -04:00
parent::__construct(sprintf('"%s" at "%s"', $message, $query) , $code, $previous);
2023-05-14 05:18:59 -04:00
$this->query = $query;
}
/**
2023-05-13 16:04:51 -04:00
* Returns the query, which caused the exception
*
* @return string
*/
2023-05-13 16:04:51 -04:00
public function getQuery(): string
{
2023-05-13 16:04:51 -04:00
return $this->query;
}
}