src/lib360/auth/IAuthenticator.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

/**
 *  This is Spoof.
 *  Copyright (C) 2011-2017  Spoof project.
 *
 *  Spoof 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.
 *
 *  Spoof 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 Spoof.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace spoof\lib360\auth;

use spoof\lib360\api\Request;

/**
 * Authentication interface
 *
 * Request authenticators must implement this interface
 */
interface IAuthenticator
{

    /**
     * Authenticate a request
     *
     * @param Request $request Request object
     *
     * @return boolean true on success, false otherwise
     */
    public function authenticate(Request $request);

}

?>