mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-30 03:42:44 +03:00
Code Issues Projects Releases Packages Wiki Activity
easyappointments/doc/code/js/CustomersHelper.html

1323 lines
18 KiB
HTML
Raw Normal View History

* Updated model unit tests. * Fixed minor bugs (js). * Generated code documentation.
2013-10-19 13:34:32 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: CustomersHelper</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: CustomersHelper</h1>
<section>
<header>
<h2>
CustomersHelper
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="CustomersHelper"><span class="type-signature"></span>new CustomersHelper<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This class contains the methods that are used in the backend customers page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="bindEventHandlers"><span class="type-signature"></span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Binds the default event handlers of the backend customers page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(id)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Delete a customer record from database.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">numeric</span>
</td>
<td class="description last">Record id to be deleted.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line242">line 242</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="display"><span class="type-signature"></span>display<span class="signature">(customer)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Display a customer record into the form.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>customer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contains the customer record data.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line321">line 321</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="displayAppointment"><span class="type-signature"></span>displayAppointment<span class="signature">(appointment)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Display appointment details on customers backend page.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>appointment</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Appointment data</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line451">line 451</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(key, selectId, display)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Filter customer records.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">This key string is used to filter the customer records.</td>
</tr>
<tr>
<td class="name"><code>selectId</code></td>
<td class="type">
<span class="param-type">numeric</span>
</td>
<td class="description last">(OPTIONAL = undefined) If set then after the filter
operation the record with the given id will be selected (but not displayed).</td>
</tr>
<tr>
<td class="name"><code>display</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL = false) If true then the selected record will
be displayed on the form.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line359">line 359</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getFilterHtml"><span class="type-signature"></span>getFilterHtml<span class="signature">(customer)</span><span class="type-signature"> &rarr; {string}</span></h4>
</dt>
<dd>
<div class="description">
Get the filter results row html code.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>customer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contains the customer data.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line399">line 399</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the record html code.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="resetForm"><span class="type-signature"></span>resetForm<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Bring the customer form back to its initial state.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line298">line 298</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(customer)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Save a customer record to the database (via ajax post).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>customer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contains the customer data.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line219">line 219</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="select"><span class="type-signature"></span>select<span class="signature">(id, display)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Select a specific record from the current filter results. If the customer id does not exist
in the list then no record will be selected.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">numeric</span>
</td>
<td class="description last">The record id to be selected from the filter results.</td>
</tr>
<tr>
<td class="name"><code>display</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL = false) If true then the method will display the record
on the form.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line423">line 423</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">(customer)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Validate customer data before save (insert or update).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>customer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Contains the customer data.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_customers.js.html">backend_customers.js</a>, <a href="backend_customers.js.html#line264">line 264</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="AdminsHelper.html">AdminsHelper</a></li><li><a href="CategoriesHelper.html">CategoriesHelper</a></li><li><a href="CustomersHelper.html">CustomersHelper</a></li><li><a href="ProvidersHelper.html">ProvidersHelper</a></li><li><a href="SecretariesHelper.html">SecretariesHelper</a></li><li><a href="ServicesHelper.html">ServicesHelper</a></li><li><a href="SystemSettings.html">SystemSettings</a></li><li><a href="UserSettings.html">UserSettings</a></li><li><a href="WorkingPlan.html">WorkingPlan</a></li></ul><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="BackendCustomers.html">BackendCustomers</a></li><li><a href="BackendServices.html">BackendServices</a></li><li><a href="BackendSettings.html">BackendSettings</a></li><li><a href="BackendUsers.html">BackendUsers</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#enableCancel">enableCancel</a></li><li><a href="global.html#enableSubmit">enableSubmit</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Sat Oct 19 2013 11:58:42 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink