MaketRandevu/doc/code/php/class-User.html
alextselegidis@gmail.com 2dddb03f87 * Updated model unit tests.
* Fixed minor bugs (js).
* Generated code documentation.
2013-10-19 10:34:32 +00:00

405 lines
7.1 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class User</title>
<script type="text/javascript" src="resources/combined.js?955602237"></script>
<script type="text/javascript" src="elementlist.js?679583101"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Admins_Model.html">Admins_Model</a></li>
<li><a href="class-Appointments.html">Appointments</a></li>
<li><a href="class-Appointments_Model.html">Appointments_Model</a></li>
<li><a href="class-Backend.html">Backend</a></li>
<li><a href="class-Backend_api.html">Backend_api</a></li>
<li><a href="class-Customers_Model.html">Customers_Model</a></li>
<li><a href="class-Errors.html">Errors</a></li>
<li><a href="class-Google.html">Google</a></li>
<li><a href="class-Providers_Model.html">Providers_Model</a></li>
<li><a href="class-Roles_Model.html">Roles_Model</a></li>
<li><a href="class-Secretaries_Model.html">Secretaries_Model</a></li>
<li><a href="class-Services_Model.html">Services_Model</a></li>
<li><a href="class-Settings_Model.html">Settings_Model</a></li>
<li><a href="class-Test.html">Test</a></li>
<li class="active"><a href="class-User.html">User</a></li>
<li><a href="class-User_Model.html">User_Model</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class User</h1>
<dl class="tree">
<dd style="padding-left:0px">
CI_Controller
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>User</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-User.html#3-113" title="Go to source code">user.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-User.html#4-7" title="Go to source code">__construct</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="index" id="_index">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_index">#</a>
<code><a href="source-class-User.html#9-11" title="Go to source code">index</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="login" id="_login">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_login">#</a>
<code><a href="source-class-User.html#13-22" title="Go to source code">login</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="logout" id="_logout">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_logout">#</a>
<code><a href="source-class-User.html#24-33" title="Go to source code">logout</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="forgot_password" id="_forgot_password">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_forgot_password">#</a>
<code><a href="source-class-User.html#35-38" title="Go to source code">forgot_password</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="no_privileges" id="_no_privileges">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_no_privileges">#</a>
<code><a href="source-class-User.html#40-43" title="Go to source code">no_privileges</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="ajax_check_login" id="_ajax_check_login">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ajax_check_login">#</a>
<code><a href="source-class-User.html#45-75" title="Go to source code">ajax_check_login</a>( )</code>
<div class="description short">
<p>[AJAX] Check whether the user has entered the correct login credentials.</p>
</div>
<div class="description detailed hidden">
<p>[AJAX] Check whether the user has entered the correct login credentials.</p>
<p>The session data of a logged in user are the following: 'user_id'
'user_email' 'role_slug' 'dest_url'</p>
</div>
</div></td>
</tr>
<tr data-order="ajax_forgot_password" id="_ajax_forgot_password">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ajax_forgot_password">#</a>
<code><a href="source-class-User.html#77-112" title="Go to source code">ajax_forgot_password</a>( )</code>
<div class="description short">
<p>Regenerate a new password for the current user, only if the username and
email address given corresond to an existing user in db.</p>
</div>
<div class="description detailed hidden">
<p>Regenerate a new password for the current user, only if the username and
email address given corresond to an existing user in db.</p>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>