diff options
Diffstat (limited to 'core/Controller/HoverCardController.php')
| -rw-r--r-- | core/Controller/HoverCardController.php | 43 |
1 files changed, 14 insertions, 29 deletions
diff --git a/core/Controller/HoverCardController.php b/core/Controller/HoverCardController.php index 9a76ee4a09a..236a81760ac 100644 --- a/core/Controller/HoverCardController.php +++ b/core/Controller/HoverCardController.php @@ -2,33 +2,18 @@ declare(strict_types=1); /** - * @copyright 2021 Joas Schilling <coding@schilljs.com> - * - * @author Joas Schilling <coding@schilljs.com> - * @author Kate Döen <kate.doeen@nextcloud.com> - * - * @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 <http://www.gnu.org/licenses/>. - * + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OC\Core\Controller; use OC\Contacts\ContactsMenu\Manager; -use OCA\Core\ResponseDefinitions; +use OC\Core\ResponseDefinitions; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\ApiRoute; +use OCP\AppFramework\Http\Attribute\NoAdminRequired; use OCP\AppFramework\Http\DataResponse; +use OCP\AppFramework\OCSController; use OCP\IRequest; use OCP\IUserSession; use OCP\Share\IShare; @@ -36,7 +21,7 @@ use OCP\Share\IShare; /** * @psalm-import-type CoreContactsAction from ResponseDefinitions */ -class HoverCardController extends \OCP\AppFramework\OCSController { +class HoverCardController extends OCSController { public function __construct( IRequest $request, private IUserSession $userSession, @@ -46,16 +31,16 @@ class HoverCardController extends \OCP\AppFramework\OCSController { } /** - * @NoAdminRequired - * - * Get the user details for a hovercard + * Get the account details for a hovercard * * @param string $userId ID of the user - * @return DataResponse<Http::STATUS_OK, array{userId: string, displayName: string, actions: CoreContactsAction[]}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}> + * @return DataResponse<Http::STATUS_OK, array{userId: string, displayName: string, actions: list<CoreContactsAction>}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, list<empty>, array{}> * - * 200: User details returned - * 404: User not found + * 200: Account details returned + * 404: Account not found */ + #[NoAdminRequired] + #[ApiRoute(verb: 'GET', url: '/v1/{userId}', root: '/hovercard')] public function getUser(string $userId): DataResponse { $contact = $this->manager->findOne($this->userSession->getUser(), IShare::TYPE_USER, $userId); @@ -70,7 +55,7 @@ class HoverCardController extends \OCP\AppFramework\OCSController { array_unshift($actions, $data['topAction']); } - /** @var CoreContactsAction[] $actions */ + /** @var list<CoreContactsAction> $actions */ return new DataResponse([ 'userId' => $userId, 'displayName' => $contact->getFullName(), |