362 lines
20 KiB
HTML
362 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
<meta charset="utf-8"/>
|
|
<title> SYSTEM - PHP Framework » \SYSTEM\TOKEN\token_reset_password
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
|
|
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
<![endif]-->
|
|
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
|
|
<script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
|
|
<script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
|
|
<script src="../js/bootstrap.js" type="text/javascript"></script>
|
|
<script src="../js/template.js" type="text/javascript"></script>
|
|
<script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico"/>
|
|
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
|
|
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
|
|
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
|
|
</head>
|
|
<body>
|
|
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container">
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
<span class="icon-bar"></span> <span class="icon-bar"></span>
|
|
<span class="icon-bar"></span> </a>
|
|
<a class="brand" href="../index.html">SYSTEM - PHP Framework</a>
|
|
|
|
<div class="nav-collapse">
|
|
<ul class="nav">
|
|
<li class="dropdown">
|
|
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
|
API Documentation <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a>Namespaces</a></li>
|
|
<li><a href="../namespaces/SYSTEM.html">SYSTEM</a></li>
|
|
<li><a href="../namespaces/LIB.html">LIB</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="charts-menu">
|
|
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
|
Charts <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="../graph_class.html">
|
|
<i class="icon-list-alt"></i> Class hierarchy diagram
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="reports-menu">
|
|
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
|
Reports <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="../errors.html">
|
|
<i class="icon-list-alt"></i> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="go_to_top">
|
|
<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="___" class="container">
|
|
<noscript>
|
|
<div class="alert alert-warning">
|
|
Javascript is disabled; several features are only available if Javascript is enabled.
|
|
</div>
|
|
</noscript>
|
|
|
|
|
|
<style>
|
|
.deprecated h2 {
|
|
text-decoration: line-through;
|
|
}
|
|
</style>
|
|
<div class="row">
|
|
<div class="span4">
|
|
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
|
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
|
|
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
|
</div>
|
|
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
|
<button class="btn public active" title="Show public elements">Public</button>
|
|
<button class="btn protected" title="Show protected elements">Protected</button>
|
|
<button class="btn private" title="Show private elements">Private</button>
|
|
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
|
</div>
|
|
|
|
<ul class="side-nav nav nav-list">
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-method"></i> Methods
|
|
<ul>
|
|
<li class="method public">
|
|
<a href="#method_confirm" title="confirm :: Token confirm processing for the token_handler.">
|
|
<span class="description">Token confirm processing for the token_handler.</span><pre>confirm</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_expire" title="expire :: Expiredate when the Token expires (1h)">
|
|
<span class="description">Expiredate when the Token expires (1h)</span><pre>expire</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_text_fail" title="text_fail :: Callback text_fail on fail">
|
|
<span class="description">Callback text_fail on fail</span><pre>text_fail</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_text_success" title="text_success :: Callback text_success on success">
|
|
<span class="description">Callback text_success on success</span><pre>text_success</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_token" title="token :: Generate the Token">
|
|
<span class="description">Generate the Token</span><pre>token</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>token_reset_password</h1>
|
|
<small style="display: block; text-align: right">
|
|
Implements <a href="../classes/SYSTEM.TOKEN.token_handler.html">\SYSTEM\TOKEN\token_handler</a>
|
|
</small>
|
|
<p class="short_description">Reset Password Token handler Class provided by System to provide a reset-password mechanism.</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\TOKEN</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_confirm"></a>
|
|
<div class="element clickable method public method_confirm" data-toggle="collapse" data-target=".method_confirm .collapse">
|
|
<h2>Token confirm processing for the token_handler.</h2>
|
|
<pre>confirm( $token_data) : boolean</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Changes the password of an account if successful</p></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$token_data</h4>
|
|
<code></code><p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_expire"></a>
|
|
<div class="element clickable method public method_expire" data-toggle="collapse" data-target=".method_expire .collapse">
|
|
<h2>Expiredate when the Token expires (1h)</h2>
|
|
<pre>expire() : integer</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>integer</code><p><p>Returns unixtimestamp when the token expires.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_text_fail"></a>
|
|
<div class="element clickable method public method_text_fail" data-toggle="collapse" data-target=".method_text_fail .collapse">
|
|
<h2>Callback text_fail on fail</h2>
|
|
<pre>text_fail(array $token_data) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$token_data</h4>
|
|
<code>array</code><p><p>Token Data</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns token fail string.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_text_success"></a>
|
|
<div class="element clickable method public method_text_success" data-toggle="collapse" data-target=".method_text_success .collapse">
|
|
<h2>Callback text_success on success</h2>
|
|
<pre>text_success(array $token_data) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$token_data</h4>
|
|
<code>array</code><p><p>Token Data</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns token success string.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_token"></a>
|
|
<div class="element clickable method public method_token" data-toggle="collapse" data-target=".method_token .collapse">
|
|
<h2>Generate the Token</h2>
|
|
<pre>token() : string</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns token string.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\TOKEN\token_reset_password"></a>
|
|
<ul class="breadcrumb">
|
|
<li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
|
|
|
|
|
|
<li><span class="divider">\</span><a href="../namespaces/SYSTEM.TOKEN.html">TOKEN</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.TOKEN.token_reset_password.html">token_reset_password</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="span12">
|
|
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
|
|
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
|
|
generated on Tue, 25 Jul 2017 11:33:08 +0200.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|