easyappointments/doc/code/php/class-Appointments.html
alextselegidis@gmail.com d2eb0b6400 - Φόρτωση των καταχωρημένων ραντεβού στο ημερολόγιο (backend)
- Προβολή λεπτομερειών ραντεβού
- Δημιουργία διαλόγου επεξεργασίας (δεν ολοκληρώθηκε ακόμα)
- Παραγωγή code docs (js + php)
2013-06-13 16:25:34 +00:00

266 lines
5.4 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 Appointments</title>
<script type="text/javascript" src="resources/combined.js?955602237"></script>
<script type="text/javascript" src="elementlist.js?815896003"></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">
</div>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><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-Customers_Model.html">Customers_Model</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-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>
</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 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 Appointments</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>Appointments</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Appointments.html#3-397" title="Go to source code">appointments.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<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-Appointments.html#4-141" title="Go to source code">index</a>( <span>string <var>$appointment_hash</var> = <span class="php-quote">''</span></span> )</code>
<div class="description short">
<p>Default callback method of the application.</p>
</div>
<div class="description detailed hidden">
<p>Default callback method of the application.</p>
<p>This method creates the appointment book wizard. If an appointment hash is
provided then it means that the customer followed the appointment manage link
that was send with the book success email.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$appointment_hash</var></dt>
<dd><code>string</code><br>$appointment_hash The db appointment hash of an existing record.</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="cancel" id="_cancel">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_cancel">#</a>
<code><a href="source-class-Appointments.html#143-207" title="Go to source code">cancel</a>( <span>string <var>$appointment_hash</var></span> )</code>
<div class="description short">
<p>Cancel an existing appointment.</p>
</div>
<div class="description detailed hidden">
<p>Cancel an existing appointment.</p>
<p>This method removes an appointment from the company's schedule. In order for
the appointment to be deleted, the hash string must be provided. The customer
can only cancel the appointment if the edit time period is not over yet.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$appointment_hash</var></dt>
<dd><code>string</code><br>$appointment_hash This is used to distinguish the appointment record.</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="ajax_get_available_hours" id="_ajax_get_available_hours">
<td class="attributes"><code>
public
Returns
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ajax_get_available_hours">#</a>
<code><a href="source-class-Appointments.html#209-396" title="Go to source code">ajax_get_available_hours</a>( )</code>
<div class="description short">
<p>[AJAX] Get the available appointment hours for the given date.</p>
</div>
<div class="description detailed hidden">
<p>[AJAX] Get the available appointment hours for the given date.</p>
<p>This method answers to an AJAX request. It calculates the available hours for
the given service, provider and date.</p>
<h4>Returns</h4>
<div class="list">
<code>Returns</code><br>a json object with the available hours.<br />
</div>
</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>