mirror of
https://github.com/alextselegidis/easyappointments.git
synced 2024-12-29 18:12:48 +03:00
1137 lines
27 KiB
HTML
1137 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<title>Class Backend_api</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><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 class="active"><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><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 class="active"><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 Backend_api</h1>
|
|
|
|
|
|
<div class="description">
|
|
<p>Contains all the backend ajax calls.</p>
|
|
</div>
|
|
|
|
<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>Backend_api</span></b>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="alert alert-info">
|
|
|
|
|
|
|
|
|
|
|
|
<b>Located at</b> <a href="source-class-Backend_api.html#3-1142" title="Go to source code">backend_api.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-Backend_api.html#9-23" 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="ajax_get_calendar_appointments" id="_ajax_get_calendar_appointments">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_get_calendar_appointments">#</a>
|
|
<code><a href="source-class-Backend_api.html#25-88" title="Go to source code">ajax_get_calendar_appointments</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Get the registered appointments for the given date period and record.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Get the registered appointments for the given date period and record.</p>
|
|
|
|
<p>This method returns the database appointments and unavailable periods for the
|
|
user selected date period and record type (provider or service).</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_appointment" id="_ajax_save_appointment">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_appointment">#</a>
|
|
<code><a href="source-class-Backend_api.html#90-234" title="Go to source code">ajax_save_appointment</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save appointment changes that are made from the backend calendar
|
|
page.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save appointment changes that are made from the backend calendar
|
|
page.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_appointment" id="_ajax_delete_appointment">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_appointment">#</a>
|
|
<code><a href="source-class-Backend_api.html#236-327" title="Go to source code">ajax_delete_appointment</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete appointment from the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete appointment from the database.</p>
|
|
|
|
<p>This method deletes an existing appointment from the database. Once this
|
|
action is finished it cannot be undone. Notification emails are send to both
|
|
provider and customer and the delete action is executed to the Google Calendar
|
|
account of the provider, if the "google_sync" setting is enabled.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_disable_provider_sync" id="_ajax_disable_provider_sync">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_disable_provider_sync">#</a>
|
|
<code><a href="source-class-Backend_api.html#329-362" title="Go to source code">ajax_disable_provider_sync</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Disable a providers sync setting.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Disable a providers sync setting.</p>
|
|
|
|
<p>This method deletes the "google_sync" and "google_token" settings from the
|
|
database. After that the provider's appointments will be no longer synced
|
|
with google calendar.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_customers" id="_ajax_filter_customers">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_customers">#</a>
|
|
<code><a href="source-class-Backend_api.html#364-415" title="Go to source code">ajax_filter_customers</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter the customer records with the given key string.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter the customer records with the given key string.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns the search results.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_unavailable" id="_ajax_save_unavailable">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_unavailable">#</a>
|
|
<code><a href="source-class-Backend_api.html#417-481" title="Go to source code">ajax_save_unavailable</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Insert of update unavailable time period to database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Insert of update unavailable time period to database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_unavailable" id="_ajax_delete_unavailable">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_unavailable">#</a>
|
|
<code><a href="source-class-Backend_api.html#483-529" title="Go to source code">ajax_delete_unavailable</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete an unavailable time period from database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete an unavailable time period from database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_customer" id="_ajax_save_customer">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_customer">#</a>
|
|
<code><a href="source-class-Backend_api.html#531-558" title="Go to source code">ajax_save_customer</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) a customer record.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) a customer record.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_customer" id="_ajax_delete_customer">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_customer">#</a>
|
|
<code><a href="source-class-Backend_api.html#560-579" title="Go to source code">ajax_delete_customer</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete customer from database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete customer from database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_service" id="_ajax_save_service">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_service">#</a>
|
|
<code><a href="source-class-Backend_api.html#581-608" title="Go to source code">ajax_save_service</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) service record.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) service record.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_service" id="_ajax_delete_service">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_service">#</a>
|
|
<code><a href="source-class-Backend_api.html#610-629" title="Go to source code">ajax_delete_service</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete service record from database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete service record from database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_services" id="_ajax_filter_services">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_services">#</a>
|
|
<code><a href="source-class-Backend_api.html#631-656" title="Go to source code">ajax_filter_services</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter service records by given key string.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter service records by given key string.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns a json encoded array back to client.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_service_category" id="_ajax_save_service_category">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_service_category">#</a>
|
|
<code><a href="source-class-Backend_api.html#658-686" title="Go to source code">ajax_save_service_category</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) category record.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) category record.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_service_category" id="_ajax_delete_service_category">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_service_category">#</a>
|
|
<code><a href="source-class-Backend_api.html#688-707" title="Go to source code">ajax_delete_service_category</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete category record from database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete category record from database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_service_categories" id="_ajax_filter_service_categories">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_service_categories">#</a>
|
|
<code><a href="source-class-Backend_api.html#709-731" title="Go to source code">ajax_filter_service_categories</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter services categories with key string.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter services categories with key string.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns a json encoded array back to client with the category records.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_admins" id="_ajax_filter_admins">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_admins">#</a>
|
|
<code><a href="source-class-Backend_api.html#733-760" title="Go to source code">ajax_filter_admins</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter admin records with string key.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter admin records with string key.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns a json encoded array back to client with the admin records.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_admin" id="_ajax_save_admin">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_admin">#</a>
|
|
<code><a href="source-class-Backend_api.html#762-795" title="Go to source code">ajax_save_admin</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) admin record into database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) admin record into database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br><p>Returns an array with the operation status and the record id that was
|
|
saved into the database.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_admin" id="_ajax_delete_admin">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_admin">#</a>
|
|
<code><a href="source-class-Backend_api.html#797-817" title="Go to source code">ajax_delete_admin</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete an admin record from the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete an admin record from the database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_providers" id="_ajax_filter_providers">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_providers">#</a>
|
|
<code><a href="source-class-Backend_api.html#819-846" title="Go to source code">ajax_filter_providers</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter provider records with string key.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter provider records with string key.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns a json encoded array back to client with the provider records.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_provider" id="_ajax_save_provider">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_provider">#</a>
|
|
<code><a href="source-class-Backend_api.html#848-886" title="Go to source code">ajax_save_provider</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) a provider record into database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) a provider record into database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br><p>Returns the success contant 'AJAX_SUCCESS' so javascript knows that
|
|
everything completed successfully.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_provider" id="_ajax_delete_provider">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_provider">#</a>
|
|
<code><a href="source-class-Backend_api.html#888-908" title="Go to source code">ajax_delete_provider</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete a provider record from the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete a provider record from the database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_filter_secretaries" id="_ajax_filter_secretaries">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_filter_secretaries">#</a>
|
|
<code><a href="source-class-Backend_api.html#910-937" title="Go to source code">ajax_filter_secretaries</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Filter secretary records with string key.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Filter secretary records with string key.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
array<br>Returns a json encoded array back to client with the secretary records.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_secretary" id="_ajax_save_secretary">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_secretary">#</a>
|
|
<code><a href="source-class-Backend_api.html#939-970" title="Go to source code">ajax_save_secretary</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save (insert or update) a secretary record into database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save (insert or update) a secretary record into database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br><p>Returns the success contant 'AJAX_SUCCESS' so javascript knows that
|
|
everything completed successfully.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_delete_secretary" id="_ajax_delete_secretary">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_delete_secretary">#</a>
|
|
<code><a href="source-class-Backend_api.html#972-992" title="Go to source code">ajax_delete_secretary</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Delete a secretary record from the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Delete a secretary record from the database.</p>
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string<br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_save_settings" id="_ajax_save_settings">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_save_settings">#</a>
|
|
<code><a href="source-class-Backend_api.html#994-1027" title="Go to source code">ajax_save_settings</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Save a setting or multiple settings in the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Save a setting or multiple settings in the database.</p>
|
|
|
|
<p>This method is used to store settings in the database. It can be either system
|
|
or user settings, one or many. Use the $_POST variables accordingly.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_validate_username" id="_ajax_validate_username">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_validate_username">#</a>
|
|
<code><a href="source-class-Backend_api.html#1029-1047" title="Go to source code">ajax_validate_username</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] This method checks whether the username already exists in the database.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] This method checks whether the username already exists in the database.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_change_language" id="_ajax_change_language">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_change_language">#</a>
|
|
<code><a href="source-class-Backend_api.html#1049-1081" title="Go to source code">ajax_change_language</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>[AJAX] Change system language for current user.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>[AJAX] Change system language for current user.</p>
|
|
|
|
<p>The language setting is stored in session data and retrieved every time the user
|
|
visits any of the system pages.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_get_google_calendars" id="_ajax_get_google_calendars">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_get_google_calendars">#</a>
|
|
<code><a href="source-class-Backend_api.html#1083-1115" title="Go to source code">ajax_get_google_calendars</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>This method will return a list of the available google calendars.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>This method will return a list of the available google calendars.</p>
|
|
|
|
<p>The user will need to select a specific calendar from this list to sync his
|
|
appointments with. Google access must be already granted for the specific
|
|
provider.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="ajax_select_google_calendar" id="_ajax_select_google_calendar">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_ajax_select_google_calendar">#</a>
|
|
<code><a href="source-class-Backend_api.html#1117-1141" title="Go to source code">ajax_select_google_calendar</a>( )</code>
|
|
|
|
<div class="description short">
|
|
<p>Select a specific google calendar for a provider.</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Select a specific google calendar for a provider.</p>
|
|
|
|
<p>All the appointments will be synced with this particular calendar.</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>
|