mirror of
https://github.com/alextselegidis/easyappointments.git
synced 2024-12-23 07:03:26 +03:00
401 lines
8.7 KiB
HTML
401 lines
8.7 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?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 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-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-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 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-679" 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-198" 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#200-292" 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#294-390" 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">
|
|
<code>Returns</code><br>a json object with the available hours.<br />
|
|
</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#392-441" 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">
|
|
<code>boolean</code><br>Returns whether the selected datetime is still available.<br />
|
|
</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#604-626" 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#628-678" 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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|