<?php
/**
 * Piwik - Open source web analytics
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 * @category Piwik
 * @package Piwik
 */

namespace Piwik;

/**
 * Interface for authentication modules
 *
 * @package Piwik
 * @subpackage Piwik_Auth
 */
interface Auth
{
    /**
     * Authentication module's name, e.g., "Login"
     *
     * @return string
     */
    public function getName();

    /**
     * Authenticates user
     *
     * @return AuthResult
     */
    public function authenticate();
}

/**
 * Authentication result
 *
 * @package Piwik
 * @subpackage Piwik_Auth
 * @see Zend_AuthResult, libs/Zend/Auth/Result.php
 * @link http://framework.zend.com/manual/en/zend.auth.html
 */
class AuthResult extends \Zend_Auth_Result
{
    /**
     * token_auth parameter used to authenticate in the API
     *
     * @var string
     */
    protected $_token_auth = null;

    const SUCCESS_SUPERUSER_AUTH_CODE = 42;

    /**
     * Constructor for AuthResult
     *
     * @param int $code
     * @param string $login identity
     * @param string $token_auth
     * @param array $messages
     */
    public function __construct($code, $login, $token_auth, array $messages = array())
    {
        // AuthResult::SUCCESS_SUPERUSER_AUTH_CODE, AuthResult::SUCCESS, AuthResult::FAILURE
        $this->_code = (int)$code;
        $this->_identity = $login;
        $this->_messages = $messages;
        $this->_token_auth = $token_auth;
    }

    /**
     * Returns the token_auth to authenticate the current user in the API
     *
     * @return string
     */
    public function getTokenAuth()
    {
        return $this->_token_auth;
    }
}