<?xml version="1.0" encoding="UTF-8"?>
<interface xmlns="http://xml.phpdox.net/src" full="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="UserCredentialAuthenticationInterface" abstract="false" final="false" start="20" end="188">
<file path="/home/rhossis/NetBeansProjects/cymapgt/core/application/authentication/UserCredential/src/abstractclass" file="UserCredentialAuthenticationInterface.php" realpath="/home/rhossis/NetBeansProjects/cymapgt/core/application/authentication/UserCredential/src/abstractclass/UserCredentialAuthenticationInterface.php" size="5567" time="2014-10-01T07:56:09+03:00" unixtime="1412139369" sha1="7ab2e4dff3206293cc998c4e8940e7f6837d1819" relative="abstractclass/UserCredentialAuthenticationInterface.php"/>
<docblock>
<description compact="UserCredentialAuthenticationInterface Interface that will be used by the Login Services"/>
<category/>
<package value="cymapgt.core.application.authentication.UserCredential"/>
<copyright value="Copyright (c) 2014 Cymap"/>
<author value="Cyril Ogana <cogana@gmail.com>"/>
<abstract>The objectives of the user credential class are:
- Specify methods that log in services must use</abstract>
</docblock>
<method name="setUsePassword" start="31" end="31" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setUsePassword() - Specify whether the method uses password (set e.g. user log in, lDAP, 2 FACTOR (step 1) Cyril Ogana <cogana@gmail.com> - 2014-02-13"/>
<param description="- if true, is using password" type="object" variable="$flag">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
</param>
<access value="public"/>
</docblock>
<parameter name="flag" byreference="false" type="{unknown}"/>
</method>
<method name="getUsePassword" start="42" end="42" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getUsePassword() - Return the use password flag">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<return type="object">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
</return>
<access value="public"/>
</docblock>
</method>
<method name="setPassword" start="53" end="53" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setPassword() - Set the user password, and hash it">Cyril Ogana <cogana@gmail.com>- 2014-02-13</description>
<param description="- the user password in raw text" type="object" variable="$password">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
</param>
<access value="public"/>
</docblock>
<parameter name="password" byreference="false" type="{unknown}"/>
</method>
<method name="getPassword" start="66" end="66" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getPassword() - Return the hashed user password">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<param description="if true, return unhashed" variable="$unhashed" type="object">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\-" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="-"/>
</param>
<return description="- the hashed password" type="mixed"/>
<access value="public"/>
</docblock>
<parameter name="unhashed" byreference="false" type="{unknown}" default="false"/>
</method>
<method name="setMultiFactor" start="77" end="77" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setMultiFactor($flag) - Set whether this service uses multi factor auth">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<param description="- if true, is a multi factor auth service" type="object" variable="$flag">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
</param>
<access value="public"/>
</docblock>
<parameter name="flag" byreference="false" type="{unknown}"/>
</method>
<method name="setMultiFactorHandler" start="90" end="90" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setMultiFactorHandler - Provide namespace of the multi factor handler service, which has to implement the interface cymapgt\core\application\authentication\abstractclass\UserCredentialAuthenticationMultiFactorInterface">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<param description="- The namespace of the multi factor handler service" type="string" variable="$handler"/>
<access value="public"/>
</docblock>
<parameter name="handler" byreference="false" type="{unknown}"/>
</method>
<method name="getMultiFactorHandler" start="102" end="102" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getMultiFactorHandler - Return an instance of the multi factor handler service to use ofr this authentication session">Cyril Ogana <cogana@gmail.com > - 2014-02-13</description>
<return type="object"/>
<access value="public"/>
</docblock>
</method>
<method name="setMultiFactorStages" start="114" end="114" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setMultiFactorStages - in an array, configure the steps of the multifactor login, passing numeric stage names, types and handler calls">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<param description="- The stages of the log in session" type="object" variable="$stages">
<type full="cymapgt\core\application\authentication\UserCredential\abstractclass\Array" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="Array"/>
</param>
<access value="public"/>
</docblock>
<parameter name="stages" byreference="false" type="array"/>
</method>
<method name="getMultiFactorStages" start="125" end="125" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getMultiFactorStages - return the multi factor stages array">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<return type="array"/>
<access value="public"/>
</docblock>
</method>
<method name="initialize" start="134" end="134" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function initialize() - initialize the service, bootstrap before any processing">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<access value="public"/>
</docblock>
</method>
<method name="authenticate" start="143" end="143" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function authenticate() - authenticate the user after initialization">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<access value="public"/>
</docblock>
</method>
<method name="setCurrentUsername" start="154" end="154" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setCurrentUsername($username) - set the current username">Cyril Ogana <cogana@gmail.com> - 2014-02-13</description>
<param description="- The current username" type="string" variable="$username"/>
<access value="public"/>
</docblock>
<parameter name="username" byreference="false" type="{unknown}"/>
</method>
<method name="getCurrentUsername" start="165" end="165" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getCurrentUsername() - get the current username">Cyril Ogana <cogana@gmail.com> - 2014-02-14</description>
<return description="- Return the current username" type="string"/>
<access value="public"/>
</docblock>
</method>
<method name="setCurrentPassword" start="176" end="176" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function setCurrentPassword() - set the current password">Cyril Ogana <cogana@gmail.com> - 2014-02-14</description>
<param description="- The current password hash" type="mixed" variable="$password"/>
<access value="public"/>
</docblock>
<parameter name="password" byreference="false" type="{unknown}"/>
</method>
<method name="getCurrentPassword" start="187" end="187" abstract="false" final="false" static="false" visibility="public">
<docblock>
<description compact="function getCurrentPassword() - return the current password (hashed)">Cyril Ogana <cogana@gmail.com> - 2014-02-14</description>
<return description="- The hashed password" type="mixed"/>
<access value="public"/>
</docblock>
</method>
<implementor full="cymapgt\core\application\authentication\UserCredential\services\UserCredentialPasswordLoginService" namespace="cymapgt\core\application\authentication\UserCredential\services" name="UserCredentialPasswordLoginService"/>
</interface>
|
Download
