summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorPytal <24800714+Pytal@users.noreply.github.com>2021-10-18 23:03:58 -0700
committerGitHub <noreply@github.com>2021-10-18 23:03:58 -0700
commitf7b3d521f866a949f457f31f8f8480aebd3c9934 (patch)
tree0c4a6cd0e03b85c37b75f8baebc77aee17f0eae0 /lib/public
parent7cebde242c9f45d46f45bdd3b2a186bccd12434b (diff)
parent3be9d3ca8fca4fb743a4d2f2ffe44a45fa9ffa6e (diff)
downloadnextcloud-server-f7b3d521f866a949f457f31f8f8480aebd3c9934.tar.gz
nextcloud-server-f7b3d521f866a949f457f31f8f8480aebd3c9934.zip
Merge pull request #28751 from nextcloud/feat/28139/profile-page
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/Accounts/IAccountManager.php26
-rw-r--r--lib/public/AppFramework/Bootstrap/IRegistrationContext.php13
-rw-r--r--lib/public/L10N/IFactory.php9
-rw-r--r--lib/public/Profile/ILinkAction.php115
-rw-r--r--lib/public/Profile/ParameterDoesNotExistException.php40
5 files changed, 203 insertions, 0 deletions
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 <http://www.gnu.org/licenses/>.
*
*/
+
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 <http://www.gnu.org/licenses/>.
*
*/
+
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/L10N/IFactory.php b/lib/public/L10N/IFactory.php
index 69b7d2281ce..0c8c945caab 100644
--- a/lib/public/L10N/IFactory.php
+++ b/lib/public/L10N/IFactory.php
@@ -29,6 +29,7 @@ declare(strict_types=1);
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
+
namespace OCP\L10N;
use OCP\IUser;
@@ -152,6 +153,14 @@ interface IFactory {
public function getLanguageIterator(IUser $user = null): ILanguageIterator;
/**
+ * returns the common language and other languages in an
+ * associative array
+ *
+ * @since 23.0.0
+ */
+ public function getLanguages(): array;
+
+ /**
* Return the language to use when sending something to a user
*
* @param IUser|null $user
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 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2021 Christopher Ng <chrng8@gmail.com>
+ *
+ * @author Christopher Ng <chrng8@gmail.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/>.
+ *
+ */
+
+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 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2021 Christopher Ng <chrng8@gmail.com>
+ *
+ * @author Christopher Ng <chrng8@gmail.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/>.
+ *
+ */
+
+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.");
+ }
+}