1 files changed, 73 insertions, 0 deletions
diff --git a/apps/user_ldap/lib/ILDAPUserPlugin.php b/apps/user_ldap/lib/ILDAPUserPlugin.php
new file mode 100644
index 00000000000..80437bef452
--- /dev/null
+++ b/apps/user_ldap/lib/ILDAPUserPlugin.php
@@ -0,0 +1,73 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\User_LDAP;
+
+interface ILDAPUserPlugin {
+	/**
+	 * Check if plugin implements actions
+	 * @return int
+	 *
+	 * Returns the supported actions as int to be
+	 * compared with OC_USER_BACKEND_CREATE_USER etc.
+	 */
+	public function respondToActions();
+
+	/**
+	 * Create a new user in LDAP Backend
+	 *
+	 * @param string $uid The UID of the user to create
+	 * @param string $password The password of the new user
+	 * @return bool|string
+	 */
+	public function createUser($uid, $password);
+
+	/**
+	 * Set password
+	 *
+	 * @param string $uid The username
+	 * @param string $password The new password
+	 * @return bool
+	 *
+	 * Change the password of a user
+	 */
+	public function setPassword($uid, $password);
+
+	/**
+	 * get the user's home directory
+	 * @param string $uid the username
+	 * @return boolean
+	 */
+	public function getHome($uid);
+
+	/**
+	 * get display name of the user
+	 * @param string $uid user ID of the user
+	 * @return string display name
+	 */
+	public function getDisplayName($uid);
+
+	/**
+	 * set display name of the user
+	 * @param string $uid user ID of the user
+	 * @param string $displayName new user's display name
+	 * @return string display name
+	 */
+	public function setDisplayName($uid, $displayName);
+
+	/**
+	 * checks whether the user is allowed to change their avatar in Nextcloud
+	 * @param string $uid the Nextcloud user name
+	 * @return boolean either the user can or cannot
+	 */
+	public function canChangeAvatar($uid);
+
+	/**
+	 * Count the number of users
+	 * @return int|false
+	 */
+	public function countUsers();
+}