OpenId/Provider/User.php

0001 <?php
0002
0003 /**
0004  * Zend Framework
0005  *
0006  * LICENSE
0007  *
0008  * This source file is subject to the new BSD license that is bundled
0009  * with this package in the file LICENSE.txt.
0010  * It is also available through the world-wide-web at this URL:
0011  * http://framework.zend.com/license/new-bsd
0012  * If you did not receive a copy of the license and are unable to
0013  * obtain it through the world-wide-web, please send an email
0014  * to license@zend.com so we can send you a copy immediately.
0015  *
0016  * @category   Zend
0017  * @package    Zend_OpenId
0018  * @subpackage Zend_OpenId_Provider
0019  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0020  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0021  * @version    $Id$
0022  */
0023
0024 /**
0025  * Abstract class to get/store information about logged in user in Web Browser
0026  *
0027  * @category   Zend
0028  * @package    Zend_OpenId
0029  * @subpackage Zend_OpenId_Provider
0030  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0031  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0032  */
0033 abstract class Zend_OpenId_Provider_User
0034 {
0035
0036     /**
0037      * Stores information about logged in user
0038      *
0039      * @param string $id user identity URL
0040      * @return bool
0041      */
0042     abstract public function setLoggedInUser($id);
0043
0044     /**
0045      * Returns identity URL of logged in user or false
0046      *
0047      * @return mixed
0048      */
0049     abstract public function getLoggedInUser();
0050
0051     /**
0052      * Performs logout. Clears information about logged in user.
0053      *
0054      * @return bool
0055      */
0056     abstract public function delLoggedInUser();
0057 }