434 lines
12 KiB
HTML
434 lines
12 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<title>Class Appointments</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="resources/bootstrap.min.css?08b23951ef4599ca9cbf1f902d0e8290c9653ddd">
|
||
|
|
<link rel="stylesheet" href="resources/style.css?062e9e59e0b8c44fbaaded5b7ffc21f907b78669">
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
<div id="navigation" class="navbar navbar-fixed-top">
|
||
|
|
<div class="navbar-inner">
|
||
|
|
<div class="container">
|
||
|
|
<a href="index.html" class="brand">Overview</a>
|
||
|
|
<div class="nav-collapse">
|
||
|
|
<ul class="nav">
|
||
|
|
<li class="active">
|
||
|
|
<span>Class</span> </li>
|
||
|
|
|
||
|
|
<li class="divider-vertical"></li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="todo.html" title="Todo list"><span>Todo</span></a>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="left">
|
||
|
|
<div id="menu">
|
||
|
|
<form id="search" class="form-search">
|
||
|
|
<input type="hidden" name="cx" value="">
|
||
|
|
<input type="hidden" name="ie" value="UTF-8">
|
||
|
|
<input type="text" name="q" class="search-query" placeholder="Search">
|
||
|
|
</form>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="groups">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="elements">
|
||
|
|
<h3>Classes</h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="class-Admins_Model.html">Admins_Model</a></li>
|
||
|
|
<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-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-Google_Sync.html">Google_Sync</a></li>
|
||
|
|
<li><a href="class-Notifications.html">Notifications</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><a href="class-Unit_tests.html">Unit_tests</a></li>
|
||
|
|
<li><a href="class-Unit_tests_admins_model.html">Unit_tests_admins_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_appointments_model.html">Unit_tests_appointments_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_customers_model.html">Unit_tests_customers_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_providers_model.html">Unit_tests_providers_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_secretaries_model.html">Unit_tests_secretaries_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_services_model.html">Unit_tests_services_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_settings_model.html">Unit_tests_settings_model</a></li>
|
||
|
|
<li><a href="class-User.html">User</a></li>
|
||
|
|
<li><a href="class-User_Model.html">User_Model</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Interfaces</h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="class-Admins_Model.html">Admins_Model</a></li>
|
||
|
|
<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-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-Google_Sync.html">Google_Sync</a></li>
|
||
|
|
<li><a href="class-Notifications.html">Notifications</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><a href="class-Unit_tests.html">Unit_tests</a></li>
|
||
|
|
<li><a href="class-Unit_tests_admins_model.html">Unit_tests_admins_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_appointments_model.html">Unit_tests_appointments_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_customers_model.html">Unit_tests_customers_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_providers_model.html">Unit_tests_providers_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_secretaries_model.html">Unit_tests_secretaries_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_services_model.html">Unit_tests_services_model</a></li>
|
||
|
|
<li><a href="class-Unit_tests_settings_model.html">Unit_tests_settings_model</a></li>
|
||
|
|
<li><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">
|
||
|
|
<div id="content" class="class">
|
||
|
|
<h1>Class Appointments</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="tree well">
|
||
|
|
<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="alert alert-info">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<b>Located at</b> <a href="source-class-Appointments.html#3-670" title="Go to source code">appointments.php</a>
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Methods summary</h2>
|
||
|
|
<table class="summary table table-bordered table-striped methods" id="methods">
|
||
|
|
<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-Appointments.html#4-14" 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-Appointments.html#16-210" 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><p>The db appointment hash of an existing
|
||
|
|
record.</p></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#212-304" 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><p>This is used to distinguish the
|
||
|
|
appointment record.</p></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#306-404" 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 thegiven service, provider and date.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
Returns<br>a json object with the available hours.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="ajax_check_datetime_availability" id="_ajax_check_datetime_availability">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
boolean
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_ajax_check_datetime_availability">#</a>
|
||
|
|
<code><a href="source-class-Appointments.html#406-458" title="Go to source code">ajax_check_datetime_availability</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Check whether the provider is still available in the selected appointment date.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Check whether the provider is still available in the selected appointment date.</p>
|
||
|
|
|
||
|
|
<p>It might be times where two or more customers select the same appointment date and time.
|
||
|
|
This shouldn't be allowed to happen, so one of the two customers will eventually get the
|
||
|
|
prefered date and the other one will have to choose for another date. Use this method
|
||
|
|
just before the customer confirms the appointment details. If the selected date was taken
|
||
|
|
in the mean time, the customer must be prompted to select another time for his appointment.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
<div class="list">
|
||
|
|
boolean<br>Returns whether the selected datetime is still available.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="check_installation" id="_check_installation">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_check_installation">#</a>
|
||
|
|
<code><a href="source-class-Appointments.html#589-611" title="Go to source code">check_installation</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>This method checks whether the application is installed.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>This method checks whether the application is installed.</p>
|
||
|
|
|
||
|
|
<p>This method resides in this controller because the "index()" function will
|
||
|
|
be the first to be launched after the files are on the server. NOTE that the
|
||
|
|
"configuration.php" file must be already set because we won't be able to
|
||
|
|
connect to the database otherwise.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="ajax_install" id="_ajax_install">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_ajax_install">#</a>
|
||
|
|
<code><a href="source-class-Appointments.html#613-669" title="Go to source code">ajax_install</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Installs Easy!Appointments on server.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Installs Easy!Appointments on server.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Magic methods summary</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="footer">
|
||
|
|
API documentation generated by <a href="http://apigen.org">ApiGen</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script src="resources/combined.js"></script>
|
||
|
|
<script src="elementlist.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|