Initial commit

application/Espo/Core/FieldValidation/Exceptions/ValidationError.php

@@ -0,0 +1,101 @@
+<?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\FieldValidation\Exceptions;
+
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Error\Body;
+use Espo\Core\Exceptions\HasLogMessage;
+use Espo\Core\FieldValidation\Failure;
+
+use LogicException;
+
+class ValidationError extends BadRequest implements HasLogMessage
+{
+    private ?Failure $failure = null;
+
+    /**
+     * 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 = parent::createWithBody($reason, $body);
+
+        if (!$exception instanceof self) {
+            throw new LogicException();
+        }
+
+        return $exception;
+    }
+
+    public static function create(Failure $failure): self
+    {
+        $exception = self::createWithBody(
+            'validationFailure',
+            Body::create()
+                ->withMessageTranslation('validationFailure', null, [
+                    'field' => $failure->getField(),
+                    'type' => $failure->getType(),
+                ])
+                ->encode()
+        );
+
+        $exception->failure = $failure;
+
+        return $exception;
+    }
+
+    public function getFailure(): Failure
+    {
+        if (!$this->failure) {
+            throw new LogicException();
+        }
+
+        return $this->failure;
+    }
+
+    public function getLogMessage(): string
+    {
+        if (!$this->failure) {
+            return "Field validation failure.";
+        }
+
+        $entityType = $this->failure->getEntityType();
+        $field = $this->failure->getField();
+        $type = $this->failure->getType();
+
+        return "Field validation failure; " .
+            "entityType: {$entityType}, field: {$field}, type: {$type}.";
+    }
+}