461 lines
12 KiB
HTML
461 lines
12 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<title>Class Backend</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 class="active"><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><a href="class-Appointments.html">Appointments</a></li>
|
||
|
|
<li><a href="class-Appointments_Model.html">Appointments_Model</a></li>
|
||
|
|
<li class="active"><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 Backend</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>Backend</span></b>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="alert alert-info">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<b>Located at</b> <a href="source-class-Backend.html#3-283" title="Go to source code">backend.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.html#4-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="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-Backend.html#17-71" 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>Display the main backend page.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Display the main backend page.</p>
|
||
|
|
|
||
|
|
<p>This method displays the main backend page. All users login permission can
|
||
|
|
view this page which displays a calendar with the events of the selected
|
||
|
|
provider or service. If a user has more priviledges he will see more menus
|
||
|
|
at the top of the page.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$appointment_hash</var></dt>
|
||
|
|
<dd><p>If given, the appointment edit dialog will
|
||
|
|
appear when the page loads.</p></dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="customers" id="_customers">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_customers">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#73-100" title="Go to source code">customers</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Display the backend customers page.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Display the backend customers page.</p>
|
||
|
|
|
||
|
|
<p>In this page the user can manage all the customer records of the system.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="services" id="_services">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_services">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#102-131" title="Go to source code">services</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Displays the backend services page.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Displays the backend services page.</p>
|
||
|
|
|
||
|
|
<p>Here the admin user will be able to organize and create the services
|
||
|
|
that the user will be able to book appointments in frontend.</p>
|
||
|
|
|
||
|
|
<p>NOTICE: The services that each provider is able to service is managed
|
||
|
|
from the backend services page.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="users" id="_users">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_users">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#133-165" title="Go to source code">users</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Display the backend users page.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Display the backend users page.</p>
|
||
|
|
|
||
|
|
<p>In this page the admin user will be able to manage the system users.
|
||
|
|
By this, we mean the provider, secretary and admin users. This is also
|
||
|
|
the page where the admin defines which service can each provider provide.</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="settings" id="_settings">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_settings">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#167-197" title="Go to source code">settings</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Display the user/system settings.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Display the user/system settings.</p>
|
||
|
|
|
||
|
|
<p>This page will display the user settings (name, password etc). If current user is
|
||
|
|
an administrator, then he will be able to make change to the current Easy!Appointment
|
||
|
|
installation (core settings like company name, book timeout etc).</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="setUserData" id="_setUserData">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_setUserData">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#241-254" title="Go to source code">setUserData</a>( <span>array <var>& $view</var></span> )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>Set the user data in order to be available at the view and js code.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>Set the user data in order to be available at the view and js code.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<div class="list"><dl>
|
||
|
|
<dt><var>$view</var></dt>
|
||
|
|
<dd>Contains the view data.</dd>
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div></td>
|
||
|
|
</tr>
|
||
|
|
<tr data-order="update" id="_update">
|
||
|
|
|
||
|
|
<td class="attributes"><code>
|
||
|
|
public
|
||
|
|
|
||
|
|
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td class="name"><div>
|
||
|
|
<a class="anchor" href="#_update">#</a>
|
||
|
|
<code><a href="source-class-Backend.html#256-282" title="Go to source code">update</a>( )</code>
|
||
|
|
|
||
|
|
<div class="description short">
|
||
|
|
<p>This method will update the installation to the latest available
|
||
|
|
version in the server. IMPORTANT: The code files must exist in the
|
||
|
|
server, this method will not fetch any new files but will update
|
||
|
|
the database schema.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description detailed hidden">
|
||
|
|
<p>This method will update the installation to the latest available
|
||
|
|
version in the server. IMPORTANT: The code files must exist in the
|
||
|
|
server, this method will not fetch any new files but will update
|
||
|
|
the database schema.</p>
|
||
|
|
|
||
|
|
<p>This method can be used either by loading the page in the browser
|
||
|
|
or by an ajax request. But it will answer with json encoded data.</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>
|