Yuri Kuznetsov
59 lines
2.0 KiB
PHP
59 lines
2.0 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM 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.
|
|
*
|
|
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
|
************************************************************************/
|
|
|
|
namespace Espo\Core\Authentication\Login;
|
|
|
|
use Espo\Entities\{
|
|
User,
|
|
AuthToken,
|
|
};
|
|
|
|
use Espo\Core\Api\Request;
|
|
|
|
/**
|
|
* Performs credentials checking. For the basic authorization a username & password are used.
|
|
* For other authorization methods credentials must be fetched from the request.
|
|
*/
|
|
interface Login
|
|
{
|
|
/**
|
|
* Check credentials.
|
|
*
|
|
* @return User if credentials are correct. NULL otherwise.
|
|
*/
|
|
public function login(
|
|
?string $username,
|
|
?string $password,
|
|
?AuthToken $authToken = null,
|
|
?Request $request = null,
|
|
array $params = [],
|
|
array &$resultData = []
|
|
) : ?User;
|
|
}
|