<?php
/**
 * Authserver, an OAuth2-based single-signon authentication provider written in PHP.
 *
 * Copyright (C) $today.date  Lars Vierbergen
 *
 * his 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/>.
 */
namespace vierbergenlars\AuthserverExternalAccountBundle\ExternalAccount;

use Symfony\Component\Security\Core\User\UserInterface;
use vierbergenlars\AuthserverExternalAccountBundle\Entity\ExternalUser;
use vierbergenlars\AuthserverExternalAccountBundle\ValueObject\Button;

interface ExternalAccountProviderInterface
{

    /**
     *
     * @return string
     */
    public function getName();

    /**
     *
     * @return string
     */
    public function getServiceName();

    /**
     *
     * @return string
     */
    public function getIcon();

    /**
     *
     * @return Button
     */
    public function getLoginButton();

    /**
     *
     * @return Button
     */
    public function getConnectButton();

    /**
     *
     * @return boolean
     */
    public function hasConnect();

    /**
     *
     * @return boolean
     */
    public function hasDisconnect();

    /**
     *
     * @param ExternalUser $externalUser
     */
    public function disconnect(ExternalUser $externalUser);

    /**
     *
     * @param mixed $externalProviderData
     * @return boolean
     */
    public function supports($externalProviderData);
}