[Sommaire] [Imprimer]

   1  <?php
   2  
   3  /*
   4   * This file is part of the symfony package.
   5   * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
   6   * (c) 2004-2006 Sean Kerr.
   7   * 
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  /**
  13   * sfSecurityUser interface provides advanced security manipulation methods.
  14   *
  15   * @package    symfony
  16   * @subpackage user
  17   * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
  18   * @author     Sean Kerr <skerr@mojavi.org>
  19   * @version    SVN: $Id: sfSecurityUser.class.php 2971 2006-12-08 12:14:14Z fabien $
  20   */
  21  interface sfSecurityUser
  22  {
  23    /**
  24     * Add a credential to this user.
  25     *
  26     * @param mixed Credential data.
  27     *
  28     * @return void
  29     */
  30    public function addCredential($credential);
  31  
  32    /**
  33     * Clear all credentials associated with this user.
  34     *
  35     * @return void
  36     */
  37    public function clearCredentials();
  38  
  39    /**
  40     * Indicates whether or not this user has a credential.
  41     *
  42     * @param mixed Credential data.
  43     *
  44     * @return bool true, if this user has the credential, otherwise false.
  45     */
  46    public function hasCredential($credential);
  47  
  48    /**
  49     * Indicates whether or not this user is authenticated.
  50     *
  51     * @return bool true, if this user is authenticated, otherwise false.
  52     */
  53    public function isAuthenticated();
  54  
  55    /**
  56     * Remove a credential from this user.
  57     *
  58     * @param mixed Credential data.
  59     *
  60     * @return void
  61     */
  62    public function removeCredential($credential);
  63  
  64    /**
  65     * Set the authenticated status of this user.
  66     *
  67     * @param bool A flag indicating the authenticated status of this user.
  68     *
  69     * @return void
  70     */
  71    public function setAuthenticated($authenticated);
  72  }