Files
espocrm/application/Espo/Core/Exceptions/Forbidden.php
2023-01-11 13:37:21 +02:00

72 lines
2.3 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Exceptions;
use Espo\Core\Utils\Log;
use Throwable;
use Exception;
/**
* A forbidden exception. Main purpose is for the 403 Forbidden HTTP error.
*/
class Forbidden extends Exception implements HasBody, HasLogLevel
{
/** @var int */
protected $code = 403;
private ?string $body = null;
final public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
}
/**
* Create with a body (supposed to be sent to the frontend).
*/
public static function createWithBody(string $message, string $body): self
{
$exception = new static($message);
$exception->body = $body;
return $exception;
}
public function getBody(): ?string
{
return $this->body;
}
public function getLogLevel(): string
{
return Log::LEVEL_WARNING;
}
}