PHP Classes
elePHPant
Icontem

File: docs/html/interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface.xhtml

Recommend this page to a friend!
  Classes of Cyril Ogana  >  PHP User Credentials  >  docs/html/interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface.xhtml  >  Download  
File: docs/html/interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface.xhtml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: PHP User Credentials
Implement password authentication policies
Author: By
Last change:
Date: 2 years ago
Size: 15,021 bytes
 

Contents

Class file image Download
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <title>phpDox - cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface</title>
    <link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  </head>
  <body>
    <nav class="topnav">
      <ul>
        <li>
          <div class="logo"><span>/**</span>phpDox</div>
        </li>
        <li class="separator">
          <a href="../index.xhtml">Overview</a>
        </li>
        <li class="separator">
          <a href="../namespaces.xhtml">Namespaces</a>
        </li>
        <li>
          <a href="../interfaces.xhtml">Interfaces</a>
        </li>
        <li>
          <a href="../classes.xhtml">Classes</a>
        </li>
        <li class="separator">
          <a href="../source/index.xhtml">Source</a>
        </li>
      </ul>
    </nav>
    <div id="mainstage">
      <div class="box">
        <ul class="breadcrumb">
          <li>
            <a href="../index.xhtml">Overview</a>
          </li>
          <li class="separator">
            <a href="../interfaces.xhtml">Interfaces</a>
          </li>
          <li class="separator">
            <a href="../interfaces.xhtml#cymapgt_core_application_authentication_UserCredential_abstractclass">cymapgt\core\application\authentication\UserCredential\abstractclass</a>
          </li>
          <li class="separator">UserCredentialAuthenticationInterface</li>
        </ul>
      </div>
      <nav class="box">
        <ul>
          <li>
            <a href="#introduction">Introduction</a>
          </li>
          <li>
            <a href="#synopsis">Synopsis</a>
          </li>
          <li>
            <a href="#violations">Violations</a>
          </li>
          <li>
            <a href="#methods">Methods</a>
          </li>
          <li>
            <a href="../source/abstractclass/UserCredentialAuthenticationInterface.php.xhtml#line20">Source</a>
          </li>
        </ul>
      </nav>
      <section>
        <h1 id="introduction"><small>cymapgt\core\application\authentication\UserCredential\abstractclass\</small>UserCredentialAuthenticationInterface</h1>
        <h4>UserCredentialAuthenticationInterface Interface that will be used by the Login Services</h4>
        <p/>
        <ul>
          <li>Author: Cyril Ogana &lt;cogana@gmail.com&gt;</li>
          <li>Copyright: Copyright (c) 2014 Cymap</li>
        </ul>
        <h2 id="synopsis">Synopsis</h2>
        <div class="synopsis">interface UserCredentialAuthenticationInterface
            {<br/><ul class="none"><li>// methods</li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setUsePassword.xhtml">setUsePassword</a>()
                    </li><li>public bool <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getUsePassword.xhtml">getUsePassword</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setPassword.xhtml">setPassword</a>()
                    </li><li>public mixed <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getPassword.xhtml">getPassword</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactor.xhtml">setMultiFactor</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactorHandler.xhtml">setMultiFactorHandler</a>()
                    </li><li>public  <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getMultiFactorHandler.xhtml">getMultiFactorHandler</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactorStages.xhtml">setMultiFactorStages</a>()
                    </li><li>public array <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getMultiFactorStages.xhtml">getMultiFactorStages</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/initialize.xhtml">initialize</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/authenticate.xhtml">authenticate</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setCurrentUsername.xhtml">setCurrentUsername</a>()
                    </li><li>public string <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getCurrentUsername.xhtml">getCurrentUsername</a>()
                    </li><li>public void <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setCurrentPassword.xhtml">setCurrentPassword</a>()
                    </li><li>public mixed <a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getCurrentPassword.xhtml">getCurrentPassword</a>()
                    </li></ul>

            }<br/></div>
        <h2 id="methods">Methods</h2>
        <div class="styled">
          <h4>public</h4>
          <ul>
            <li id="authenticate"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/authenticate.xhtml">authenticate()</a>
                — function authenticate() - authenticate the user after initialization</li>
            <li id="getCurrentPassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getCurrentPassword.xhtml">getCurrentPassword()</a>
                — function getCurrentPassword() - return the current password (hashed)</li>
            <li id="getCurrentUsername"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getCurrentUsername.xhtml">getCurrentUsername()</a>
                — function getCurrentUsername() - get the current username</li>
            <li id="getMultiFactorHandler"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getMultiFactorHandler.xhtml">getMultiFactorHandler()</a>
                — function getMultiFactorHandler - Return an instance of the multi factor handler service                                  to use ofr this authentication session</li>
            <li id="getMultiFactorStages"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getMultiFactorStages.xhtml">getMultiFactorStages()</a>
                — function getMultiFactorStages - return the multi factor stages array</li>
            <li id="getPassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getPassword.xhtml">getPassword()</a>
                — function getPassword()  - Return the hashed user password</li>
            <li id="getUsePassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/getUsePassword.xhtml">getUsePassword()</a>
                — function getUsePassword() - Return the use password flag</li>
            <li id="initialize"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/initialize.xhtml">initialize()</a>
                — function initialize() - initialize the service, bootstrap before any processing</li>
            <li id="setCurrentPassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setCurrentPassword.xhtml">setCurrentPassword()</a>
                — function setCurrentPassword() - set the current password</li>
            <li id="setCurrentUsername"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setCurrentUsername.xhtml">setCurrentUsername()</a>
                — function setCurrentUsername($username) - set the current username</li>
            <li id="setMultiFactor"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactor.xhtml">setMultiFactor()</a>
                — function setMultiFactor($flag) - Set whether this service uses multi factor auth</li>
            <li id="setMultiFactorHandler"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactorHandler.xhtml">setMultiFactorHandler()</a>
                — function setMultiFactorHandler - Provide namespace of the multi factor handler service,                                  which has to implement the interface                                  cymapgt\core\application\authentication\abstractclass\UserCredentialAuthenticationMultiFactorInterface</li>
            <li id="setMultiFactorStages"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setMultiFactorStages.xhtml">setMultiFactorStages()</a>
                — function setMultiFactorStages - in an array, configure the steps of the multifactor login, passing                                 numeric stage names, types and handler calls</li>
            <li id="setPassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setPassword.xhtml">setPassword()</a>
                — function setPassword() - Set the user password, and hash it</li>
            <li id="setUsePassword"><a title="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" href="../interfaces/cymapgt_core_application_authentication_UserCredential_abstractclass_UserCredentialAuthenticationInterface/setUsePassword.xhtml">setUsePassword()</a>
                — function setUsePassword() - Specify whether the method uses password                              (set e.g. user log in, lDAP, 2 FACTOR (step 1) Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</li>
          </ul>
        </div>
      </section>
    </div>
    <footer>
      <span>Generated using phpDox 0.7.0 - Copyright (C) 2010 - 2015 by Arne Blankerts</span>
    </footer>
  </body>
</html>