library/Zend/OpenId/Provider/User.php

   1 <?php
   2
   3 /**
   4  * Zend Framework
   5  *
   6  * LICENSE
   7  *
   8  * This source file is subject to the new BSD license that is bundled
   9  * with this package in the file LICENSE.txt.
  10  * It is also available through the world-wide-web at this URL:
  11  * http://framework.zend.com/license/new-bsd
  12  * If you did not receive a copy of the license and are unable to
  13  * obtain it through the world-wide-web, please send an email
  14  * to license@zend.com so we can send you a copy immediately.
  15  *
  16  * @category   Zend
  17  * @package    Zend_OpenId
  18  * @subpackage Zend_OpenId_Provider
  19  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  20  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  21  * @version    $Id$
  22  */
  23
  24 /**
  25  * Abstract class to get/store information about logged in user in Web Browser
  26  *
  27  * @category   Zend
  28  * @package    Zend_OpenId
  29  * @subpackage Zend_OpenId_Provider
  30  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  31  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  32  */
  33 abstract class Zend_OpenId_Provider_User
  34 {
  35
  36     /**
  37      * Stores information about logged in user
  38      *
  39      * @param string $id user identity URL
  40      * @return bool
  41      */
  42     abstract public function setLoggedInUser($id);
  43
  44     /**
  45      * Returns identity URL of logged in user or false
  46      *
  47      * @return mixed
  48      */
  49     abstract public function getLoggedInUser();
  50
  51     /**
  52      * Performs logout. Clears information about logged in user.
  53      *
  54      * @return bool
  55      */
  56     abstract public function delLoggedInUser();
  57 }