Files
sysPass/lib/SP/Domain/Auth/Ports/LdapActionsService.php
2024-03-08 06:25:16 +01:00

70 lines
1.8 KiB
PHP

<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2024, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Domain\Auth\Ports;
use SP\Providers\Auth\Ldap\AttributeCollection;
use SP\Providers\Auth\Ldap\LdapException;
use SP\Providers\Auth\Ldap\LdapParams;
use SP\Providers\Auth\Ldap\LdapResults;
/**
* Class LdapActions
*
* @package SP\Providers\Auth\Ldap
*/
interface LdapActionsService
{
/**
* Obtener el RDN del grupo.
*
* @param string $groupFilter
*
* @return array Groups' DN
* @throws LdapException
*/
public function searchGroupsDn(string $groupFilter): array;
/**
* @param string $filter
*
* @return AttributeCollection
* @throws LdapException
*/
public function getAttributes(string $filter): AttributeCollection;
/**
* Get LDAP search results
*
* @throws LdapException
*/
public function getObjects(
string $filter,
array $attributes = [],
?string $searchBase = null
): LdapResults;
public function mutate(LdapParams $ldapParams): LdapActionsService;
}