Initial commit

application/Espo/Core/Exceptions/Conflict.php

@@ -0,0 +1,71 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * 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/>.
+ *
+ * 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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Exceptions;
+
+use Espo\Core\Exceptions\Error\Body;
+use Exception;
+use Throwable;
+
+/**
+ * A conflict exception. Main purpose is for the 409 Conflict HTTP error.
+ * If uncaught within an API request, the message will be printed to the X-Status-Reason header.
+ */
+class Conflict extends Exception implements HasBody
+{
+    /** @var int */
+    protected $code = 409;
+    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).
+     * Body object is supported since v8.1.
+     */
+    public static function createWithBody(string $reason, string|Body $body): self
+    {
+        if ($body instanceof Body) {
+            $body = $body->encode();
+        }
+
+        $exception = new static($reason);
+        $exception->body = $body;
+
+        return $exception;
+    }
+
+    public function getBody(): ?string
+    {
+        return $this->body;
+    }
+}