mirror of
https://github.com/alextselegidis/easyappointments.git
synced 2024-11-25 17:33:19 +03:00
2dddb03f87
* Fixed minor bugs (js). * Generated code documentation.
1124 lines
22 KiB
HTML
1124 lines
22 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 Backend_api</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><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-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 Backend_api</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Contains all the backend ajax calls.</p>
|
|
|
|
</div>
|
|
|
|
<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>Backend_api</span></b>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
|
|
|
|
|
|
<b>Located at</b> <a href="source-class-Backend_api.html#3-1044" title="Go to source code">backend_api.php</a><br />
|
|
</div>
|
|
|
|
|
|
|
|
<table class="summary" id="methods">
|
|
<caption>Methods summary</caption>
|
|
<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-15" 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#18-81" 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#83-230" 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#232-323" 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#325-355" 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#357-408" 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">
|
|
<code>array</code><br>Returns the search results.<br />
|
|
</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#410-472" 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#474-520" 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#522-549" 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#551-570" 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#572-599" 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#601-620" 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#622-647" 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">
|
|
<code>array</code><br>Returns a json encoded array back to client.<br />
|
|
</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#649-677" 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#679-698" 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#700-722" 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">
|
|
<code>array</code><br>Returns a json encoded array back to client with the category records.<br />
|
|
</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#724-751" 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">
|
|
<code>array</code><br>Returns a json encoded array back to client with the admin records.<br />
|
|
</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#753-786" 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">
|
|
<code>array</code><br>Returns an array with the operation status and the record id that was saved into
|
|
the database.<br />
|
|
</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#788-808" 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">
|
|
<code>string</code><br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).<br />
|
|
</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#810-837" 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">
|
|
<code>array</code><br>Returns a json encoded array back to client with the provider records.<br />
|
|
</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#839-877" 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">
|
|
<code>string</code><br>Returns the success contant 'AJAX_SUCCESS' so javascript knows that everything
|
|
completed successfully.<br />
|
|
</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#879-899" 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">
|
|
<code>string</code><br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).<br />
|
|
</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#901-928" 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">
|
|
<code>array</code><br>Returns a json encoded array back to client with the secretary records.<br />
|
|
</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#930-961" 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">
|
|
<code>string</code><br>Returns the success contant 'AJAX_SUCCESS' so javascript knows that everything
|
|
completed successfully.<br />
|
|
</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#963-983" 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">
|
|
<code>string</code><br>Returns the operation result constant (AJAX_SUCESS or AJAX_FAILURE).<br />
|
|
</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#985-1018" 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#1020-1043" 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>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|