2013-02-26 23:49:37 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.3.1" / >
2013-05-10 10:59:11 +00:00
< title > The Red Matrix: include/auth.php File Reference< / title >
2013-02-26 23:49:37 +00:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
2013-05-15 04:25:58 +00:00
< td id = "projectlogo" > < img alt = "Logo" src = "rhash-64.png" / > < / td >
2013-02-26 23:49:37 +00:00
< td style = "padding-left: 0.5em;" >
2013-05-10 10:59:11 +00:00
< div id = "projectname" > The Red Matrix
2013-02-26 23:49:37 +00:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li > < a href = "namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "files.html" > < span > File  List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > File  Members< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
$(document).ready(function(){initNavTree('auth_8php.html','');});
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Classes< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Pages< / a > < / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#func-members" > Functions< / a > |
< a href = "#var-members" > Variables< / a > < / div >
< div class = "headertitle" >
< div class = "title" > auth.php File Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a2add3a1129ffa4d5515442a9d52a9b1a" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "auth_8php.html#a2add3a1129ffa4d5515442a9d52a9b1a" > nuke_session< / a > ()< / td > < / tr >
< tr class = "separator:a2add3a1129ffa4d5515442a9d52a9b1a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a07bae0e623e2daa9ee2cd5a8aa294dee" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "auth_8php.html#a07bae0e623e2daa9ee2cd5a8aa294dee" > account_verify_password< / a > ($email, $pass)< / td > < / tr >
< tr class = "separator:a07bae0e623e2daa9ee2cd5a8aa294dee" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "var-members" > < / a >
Variables< / h2 > < / td > < / tr >
2013-05-10 10:52:06 +00:00
< tr class = "memitem:a0950af7c2888ca1d4743fe5d0bff9ae5" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "redstrap_2php_2style_8php.html#a0c4684da834439885ae2285649d1aaea" > if< / a > ((isset($_SESSION))& & (< a class = "el" href = "boot_8php.html#a01353c9abebc3544ea080ac161729632" > x< / a > ($_SESSION,'authenticated'))& & ((!(< a class = "el" href = "boot_8php.html#a01353c9abebc3544ea080ac161729632" > x< / a > ($_POST,'auth-params')))||($_POST['auth-params']!== < br class = "typebreak" / >
2013-02-26 23:49:37 +00:00
'< a class = "el" href = "boot_8php.html#aefecf8599036df7f1b95d6820e0e2fa4" > login< / a > ')))  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "auth_8php.html#a0950af7c2888ca1d4743fe5d0bff9ae5" > else< / a > < / td > < / tr >
< tr class = "separator:a0950af7c2888ca1d4743fe5d0bff9ae5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "a07bae0e623e2daa9ee2cd5a8aa294dee" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > account_verify_password < / td >
< td > (< / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > < em > $email< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > < em > $pass< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Verify login credentials< / p >
< p > Returns account record on success, null on failure < / p >
< p > A plugin indicates successful login by setting 'authenticated' to non-zero value and returning a user record Plugins should never set 'authenticated' except to indicate success - as hooks may be chained and later plugins should not interfere with an earlier one that succeeded.< / p >
< p > Referenced by < a class = "el" href = "include_2api_8php.html#afe534f826e4282b72d66e8cadca7bb73" > api_login()< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a2add3a1129ffa4d5515442a9d52a9b1a" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > nuke_session < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Referenced by < a class = "el" href = "include_2api_8php.html#a2e94eab9d6c164bfef7a1b2ab87b339b" > api_account_logout()< / a > .< / p >
< / div >
< / div >
< h2 class = "groupheader" > Variable Documentation< / h2 >
< a class = "anchor" id = "a0950af7c2888ca1d4743fe5d0bff9ae5" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2013-05-10 10:52:06 +00:00
< td class = "memname" > < a class = "el" href = "redstrap_2php_2style_8php.html#a0c4684da834439885ae2285649d1aaea" > if< / a > ((isset($_SESSION))& & (< a class = "el" href = "boot_8php.html#a01353c9abebc3544ea080ac161729632" > x< / a > ($_SESSION,'authenticated'))& & ((!(< a class = "el" href = "boot_8php.html#a01353c9abebc3544ea080ac161729632" > x< / a > ($_POST,'auth-params')))||($_POST['auth-params']!== '< a class = "el" href = "boot_8php.html#aefecf8599036df7f1b95d6820e0e2fa4" > login< / a > '))) else< / td >
2013-02-26 23:49:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< b > Initial value:< / b > < div class = "fragment" > < div class = "line" > {< / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordflow" > if< / span > (isset($_SESSION)) {< / div >
< div class = "line" > < a class = "code" href = "auth_8php.html#a2add3a1129ffa4d5515442a9d52a9b1a" > nuke_session< / a > ();< / div >
< div class = "line" > }< / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keywordflow" > if< / span > ((< a class = "code" href = "boot_8php.html#a01353c9abebc3544ea080ac161729632" > x< / a > ($_POST,< span class = "stringliteral" > ' password' < / span > )) & & strlen($_POST[< span class = "stringliteral" > ' password' < / span > ]))< / div >
< div class = "line" > $encrypted = hash(< span class = "stringliteral" > ' whirlpool' < / span > ,trim($_POST[< span class = "stringliteral" > ' password' < / span > ]))< / div >
< / div > <!-- fragment -->
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
2013-02-27 03:01:56 +00:00
