Initial commit

application/Espo/Controllers/Preferences.php

@@ -0,0 +1,123 @@
+<?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\Controllers;
+
+use Espo\Core\Api\Request;
+use Espo\Core\Exceptions\BadRequest;
+
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Exceptions\NotFound;
+use Espo\Tools\App\PreferencesService as Service;
+
+use stdClass;
+
+class Preferences
+{
+    private Service $service;
+
+    public function __construct(Service $service)
+    {
+        $this->service = $service;
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    public function getActionRead(Request $request): stdClass
+    {
+        $userId = $request->getRouteParam('id');
+
+        if (!$userId) {
+            throw new BadRequest();
+        }
+
+        return $this->service->read($userId)->getValueMap();
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    public function deleteActionDelete(Request $request): stdClass
+    {
+        $userId = $request->getRouteParam('id');
+
+        if (!$userId) {
+            throw new BadRequest();
+        }
+
+        $this->service->resetToDefaults($userId);
+
+        return $this->service
+            ->read($userId)
+            ->getValueMap();
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    public function putActionUpdate(Request $request): stdClass
+    {
+        $userId = $request->getRouteParam('id');
+
+        if (!$userId) {
+            throw new BadRequest();
+        }
+
+        $data = $request->getParsedBody();
+
+        return $this->service
+            ->update($userId, $data)
+            ->getValueMap();
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    public function postActionResetDashboard(Request $request): stdClass
+    {
+        $data = $request->getParsedBody();
+
+        $userId = $data->id ?? null;
+
+        if (!$userId) {
+            throw new BadRequest();
+        }
+
+        return $this->service->resetDashboard($userId);
+    }
+}