IdP.php

<?php

namespace Shibalike;

use Shibalike\Attr\IStore;

/**
 * Component for marking user as authenticated. For use in a "login" script.
 *
 * Usage:
 * <code>
 * $idp = new Shibalike\IdP(...);
 * if (isset($_GET['logout'])) {
 *     $idp->logout();
 * }
 *
 * // try authentication somehow (e.g. using Zend_Auth)
 * if ($authenticatedSuccessfully) {
 *     $userAttrs = $idp->fetchAttrs();
 *     if ($userAttrs) {
 *         $idp->markAsAuthenticated($username);
 *         $idp->redirect();
 *     } else {
 *         // user is not in attr store!
 *     }
 * } else {
 *     // user failed authenticate!
 * }
 * </code>
 */
class IdP extends Junction {

    /**
     * @param IStateManager $stateMgr
     * @param IStore $store
     * @param Config $config
     */
    public function __construct(IStateManager $stateMgr, IStore $store, Config $config)
    {
        $this->_store = $store;
        parent::__construct($stateMgr, $config);
    }

    /**
     * Fetch user attributes from the attribute store
     *
     * @param string $username
     * @return array|null
     */
    public function fetchAttrs($username)
    {
        return $this->_store->fetchAttrs($username);
    }

    /**
     * Mark the user as authenticated and store her in the state manager
     * 
     * @param string $username
     * @param array $attrs if not provided, fetchAttrs will be called
     * @return bool was the user state set successfully?
     */
    public function markAsAuthenticated($username, array $attrs = null)
    {
        if (!$attrs) {
            $attrs = $this->fetchAttrs($username);
        }
        $authResult = new AuthResult($username, $attrs);
        return $this->_stateMgr->set('authResult', $authResult);
    }
    
    /**
     * Get the default URL to redirect to
     *
     * @return string
     */
    public function getRedirectUrl()
    {
        return $this->_config->idpUrl;
    }
    
    /**
     * Get the AuthRequest object from the state manager (if exists).
     * 
     * @return AuthRequest|null
     */
    public function getAuthRequest()
    {
        return $this->_stateMgr->get('authRequest');
    }
    
    /**
     * Close an open state manager/session and redirect the user
     *
     * @param string $url
     * @param bool $exitAfter exit after redirecting?
     */
    public function redirect($url = null, $exitAfter = true)
    {
        if (empty($url)) {
            $authRequest = $this->_stateMgr->get('authRequest');
            /* @var AuthRequest $authRequest */
            if ($authRequest) {
                $url = $authRequest->getReturnUrl();
                $this->_stateMgr->set('authRequest');
            }
        }
        parent::redirect($url, $exitAfter);
    }

    /**
     * @var IStore
     */
    protected $_store;
}