ifl/iflrandevu
1
1
Fork 0
forked from mirrors/easyappointments
Code Issues 6 Pull requests Releases 3 Activity
iflrandevu/doc/code-docs/js/bookAppointment.html

720 lines
9.5 KiB
HTML
Raw Normal View History

- Προσθήκη αλγορίθμου υπολογισμού των ελεύθερων ωρών ενός πάροχου υπηρεσιών έτσι ώστε να μπορεί ο πελάτης να κλείσει ραντεβού μαζι του. - Δημιουργία script για παραγωγή documention του κώδικα - Μικρές διορθώσεις
2013-05-20 20:21:58 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: bookAppointment</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: bookAppointment</h1>
<section>
<header>
<h2>
bookAppointment
</h2>
<div class="class-description">Implelements the js part of the appointment booking page.</div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="bookAppointment"><span class="type-signature"></span>new bookAppointment<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This class implements the book appointment page functionality.
Once the initialize() method is called the page is fully functional
and can serve the appointment booking process.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="bindEventHandlers"><span class="type-signature">&lt;static> </span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method binds the necessary event handlers
for the book appointments page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="calcEndDatetime"><span class="type-signature">&lt;static> </span>calcEndDatetime<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
</dt>
<dd>
<div class="description">
This method calculates the end datetime of the current appointment.
End datetime is depending on the service and start datetime fieldss.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line288">line 288</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the end datetime in string format.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getAvailableHours"><span class="type-signature">&lt;static> </span>getAvailableHours<span class="signature">(selDate)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This function makes an ajax call and returns the available
hours for the selected service, provider and date.
</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>selDate</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The selected date of which the available
hours we need to receive.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="initialize"><span class="type-signature">&lt;static> </span>initialize<span class="signature">(bindEventHandlers)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method initializes the book appointment 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>bindEventHandlers</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL) Determines wether
the default event handlers will be binded to the dom elements.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="updateConfirmData"><span class="type-signature">&lt;static> </span>updateConfirmData<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Every time this function is executed, it updates the confirmation
page with the latest customer settigns and input for the appointment
booking.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line233">line 233</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="validateCustomerDataForm"><span class="type-signature">&lt;static> </span>validateCustomerDataForm<span class="signature">()</span><span class="type-signature"> &rarr; {bool}</span></h4>
</dt>
<dd>
<div class="description">
This function validates the customer's data input.
It only checks for empty fields by the time.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="book_appointment.js.html">frontend/book_appointment.js</a>, <a href="book_appointment.js.html#line214">line 214</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the validation result.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">bool</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="bookAppointment.html">bookAppointment</a></li></ul><h3>Namespaces</h3><ul><li><a href="functions..html">General javascript functions.</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 Mon May 20 2013 18:38:06 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink