diff options
Diffstat (limited to 'lib/public/LDAP/ILDAPProvider.php')
| -rw-r--r-- | lib/public/LDAP/ILDAPProvider.php | 50 |
1 files changed, 17 insertions, 33 deletions
diff --git a/lib/public/LDAP/ILDAPProvider.php b/lib/public/LDAP/ILDAPProvider.php index 0baee4254e0..7e1f27eb368 100644 --- a/lib/public/LDAP/ILDAPProvider.php +++ b/lib/public/LDAP/ILDAPProvider.php @@ -1,31 +1,9 @@ <?php + /** - * @copyright Copyright (c) 2016, Roger Szabo (roger.szabo@web.de) - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Roger Szabo <roger.szabo@web.de> - * @author root <root@localhost.localdomain> - * @author Vinicius Cubas Brand <vinicius@eita.org.br> - * - * @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: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCP\LDAP; /** @@ -69,8 +47,8 @@ interface ILDAPProvider { /** * Sanitize a DN received from the LDAP server. - * @param array $dn the DN in question - * @return array the sanitized DN + * @param array|string $dn the DN in question + * @return array|string the sanitized DN * @since 11.0.0 */ public function sanitizeDN($dn); @@ -78,7 +56,7 @@ interface ILDAPProvider { /** * Return a new LDAP connection resource for the specified user. * @param string $uid user id - * @return resource of the LDAP connection + * @return \LDAP\Connection|resource * @since 11.0.0 */ public function getLDAPConnection($uid); @@ -86,7 +64,7 @@ interface ILDAPProvider { /** * Return a new LDAP connection resource for the specified group. * @param string $gid group id - * @return resource of the LDAP connection + * @return \LDAP\Connection|resource * @since 13.0.0 */ public function getGroupLDAPConnection($gid); @@ -150,7 +128,7 @@ interface ILDAPProvider { public function getLDAPEmailField($uid); /** - * Get the LDAP attribute name for the type of association betweeen users and groups + * Get the LDAP attribute name for the type of association between users and groups * @param string $gid group id * @return string the configuration, one of: 'memberUid', 'uniqueMember', 'member', 'gidNumber', '' * @throws \Exception if group id was not found in LDAP @@ -160,11 +138,17 @@ interface ILDAPProvider { /** * Get an LDAP attribute for a nextcloud user - * @param string $uid the nextcloud user id to get the attribute for - * @param string $attribute the name of the attribute to read - * @return string|null + * * @throws \Exception if user id was not found in LDAP * @since 21.0.0 */ public function getUserAttribute(string $uid, string $attribute): ?string; + + /** + * Get a multi-value LDAP attribute for a nextcloud user + * + * @throws \Exception if user id was not found in LDAP + * @since 22.0.0 + */ + public function getMultiValueUserAttribute(string $uid, string $attribute): array; } |