From 309354852f12ae88d5eef05d311d6ebcba8ee762 Mon Sep 17 00:00:00 2001 From: Christopher Ng Date: Thu, 14 Oct 2021 08:19:40 +0000 Subject: Profile backend Signed-off-by: Christopher Ng --- lib/public/Accounts/IAccountManager.php | 26 +++++ .../Bootstrap/IRegistrationContext.php | 13 +++ lib/public/Profile/ILinkAction.php | 115 +++++++++++++++++++++ .../Profile/ParameterDoesNotExistException.php | 40 +++++++ 4 files changed, 194 insertions(+) create mode 100644 lib/public/Profile/ILinkAction.php create mode 100644 lib/public/Profile/ParameterDoesNotExistException.php (limited to 'lib/public') diff --git a/lib/public/Accounts/IAccountManager.php b/lib/public/Accounts/IAccountManager.php index 9418e07ec97..ae5f6b1e542 100644 --- a/lib/public/Accounts/IAccountManager.php +++ b/lib/public/Accounts/IAccountManager.php @@ -26,6 +26,7 @@ declare(strict_types=1); * along with this program. If not, see . * */ + namespace OCP\Accounts; use OCP\IUser; @@ -96,6 +97,31 @@ interface IAccountManager { public const PROPERTY_ADDRESS = 'address'; public const PROPERTY_TWITTER = 'twitter'; + /** + * @since 23.0.0 + */ + public const PROPERTY_ORGANISATION = 'organisation'; + + /** + * @since 23.0.0 + */ + public const PROPERTY_ROLE = 'role'; + + /** + * @since 23.0.0 + */ + public const PROPERTY_HEADLINE = 'headline'; + + /** + * @since 23.0.0 + */ + public const PROPERTY_BIOGRAPHY = 'biography'; + + /** + * @since 23.0.0 + */ + public const PROPERTY_PROFILE_ENABLED = 'profile_enabled'; + public const COLLECTION_EMAIL = 'additional_mail'; public const NOT_VERIFIED = '0'; diff --git a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php index d396c619923..f75cdb18cfb 100644 --- a/lib/public/AppFramework/Bootstrap/IRegistrationContext.php +++ b/lib/public/AppFramework/Bootstrap/IRegistrationContext.php @@ -26,6 +26,7 @@ declare(strict_types=1); * along with this program. If not, see . * */ + namespace OCP\AppFramework\Bootstrap; use OCP\AppFramework\IAppContainer; @@ -74,6 +75,7 @@ interface IRegistrationContext { * @since 20.0.0 */ public function registerDashboardWidget(string $widgetClass): void; + /** * Register a service * @@ -237,4 +239,15 @@ interface IRegistrationContext { * @since 23.0.0 */ public function registerCalendarProvider(string $class): void; + + /** + * Register an implementation of \OCP\Profile\ILinkAction that + * will handle the implementation of a profile action + * + * @param string $actionClass + * @psalm-param class-string<\OCP\Profile\ILinkAction> $actionClass + * @return void + * @since 23.0.0 + */ + public function registerProfileAction(string $actionClass): void; } diff --git a/lib/public/Profile/ILinkAction.php b/lib/public/Profile/ILinkAction.php new file mode 100644 index 00000000000..67e69a73d9c --- /dev/null +++ b/lib/public/Profile/ILinkAction.php @@ -0,0 +1,115 @@ + + * + * @author Christopher Ng + * + * @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 . + * + */ + +namespace OCP\Profile; + +use OCP\IUser; + +/** + * @since 23.0.0 + */ +interface ILinkAction { + + /** + * Preload the user specific value required by the action + * + * e.g. the email is loaded for the email action and the userId for the Talk action + * + * @since 23.0.0 + */ + public function preload(IUser $targetUser): void; + + /** + * Returns the app ID of the action + * + * e.g. 'spreed' + * + * @since 23.0.0 + */ + public function getAppId(): string; + + /** + * Returns the unique ID of the action + * + * *For account properties this is the constant defined in lib/public/Accounts/IAccountManager.php* + * + * e.g. 'email' + * + * @since 23.0.0 + */ + public function getId(): string; + + /** + * Returns the translated unique display ID of the action + * + * Should be something short and descriptive of the action + * as this is seen by the end-user when configuring actions + * + * e.g. 'Email' + * + * @since 23.0.0 + */ + public function getDisplayId(): string; + + /** + * Returns the translated title + * + * e.g. 'Mail user@domain.com' + * + * Use the L10N service to translate it + * + * @since 23.0.0 + */ + public function getTitle(): string; + + /** + * Returns the priority + * + * *Actions are sorted in ascending order* + * + * e.g. 60 + * + * @since 23.0.0 + */ + public function getPriority(): int; + + /** + * Returns the URL link to the 16*16 SVG icon + * + * @since 23.0.0 + */ + public function getIcon(): string; + + /** + * Returns the target of the action, + * if null is returned the action won't be registered + * + * e.g. 'mailto:user@domain.com' + * + * @since 23.0.0 + */ + public function getTarget(): ?string; +} diff --git a/lib/public/Profile/ParameterDoesNotExistException.php b/lib/public/Profile/ParameterDoesNotExistException.php new file mode 100644 index 00000000000..543a8edc17a --- /dev/null +++ b/lib/public/Profile/ParameterDoesNotExistException.php @@ -0,0 +1,40 @@ + + * + * @author Christopher Ng + * + * @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 . + * + */ + +namespace OCP\Profile; + +/** + * @since 23.0.0 + */ +class ParameterDoesNotExistException extends \Exception { + + /** + * @since 23.0.0 + */ + public function __construct($parameter) { + parent::__construct("Parameter $parameter does not exist."); + } +} -- cgit v1.2.3