iflrandevu/doc/code/php/class-Backend.html
alextselegidis@gmail.com f0fd08e444 * Updated database structure and added new sample data.
* Regenerated code docs (js + php).
* Added custom error 404 page.
* Added service price and description in the appointment booking wizard.
* Completed Issue #21 - devide services in categories in the appointment booking wizard.
* Completed the backend user management page.
2013-09-13 13:21:03 +00:00

351 lines
6.9 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</title>
<script type="text/javascript" src="resources/combined.js?955602237"></script>
<script type="text/javascript" src="elementlist.js?3375239373"></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 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-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>
</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</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>Backend</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Backend.html#3-132" title="Go to source code">backend.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-Backend.html#4-42" 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><code>string</code><br>$appointment_hash If given, the appointment edit dialog will appear when the
page loads.</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#44-66" 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#68-92" 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#94-120" 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#122-131" 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>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>