forked from mirrors/easyappointments
f0fd08e444
* 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.
701 lines
16 KiB
HTML
701 lines
16 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 Admins_Model</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 class="active"><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><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 Admins_Model</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Admins_Model Class</p>
|
|
|
|
<p>Handles the database actions for admin users management.</p>
|
|
|
|
<p>Data Structure: 'fist_name' 'last_name' (required) 'email' (required)
|
|
'mobile_number' 'phone_number' (required) 'address' 'city' 'state' 'zip_code'
|
|
'notes' 'id_roles' 'settings' >>> array that contains user settings
|
|
(username, password etc)</p>
|
|
|
|
</div>
|
|
|
|
<dl class="tree">
|
|
<dd style="padding-left:0px">
|
|
CI_Model
|
|
|
|
|
|
</dd>
|
|
<dd style="padding-left:30px">
|
|
<img src="resources/inherit.png" alt="Extended by" />
|
|
<b><span>Admins_Model</span></b>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
|
|
|
|
|
|
<b>Located at</b> <a href="source-class-Admins_Model.html#3-331" title="Go to source code">admins_model.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-Admins_Model.html#23-28" title="Go to source code">__construct</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Class Constructor</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Class Constructor</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="add" id="_add">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_add">#</a>
|
|
<code><a href="source-class-Admins_Model.html#30-53" title="Go to source code">add</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Add (insert or update) an admin user record into database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Add (insert or update) an admin user record into database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin user data.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>integer</code><br>Returns the record id.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the admin data are invalid (see validate() method).<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="exists" id="_exists">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_exists">#</a>
|
|
<code><a href="source-class-Admins_Model.html#55-78" title="Go to source code">exists</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Check whether a particular admin record exists in the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Check whether a particular admin record exists in the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin data. The 'email' value is required to be present at
|
|
the moment.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br>Returns whether the record exists or not.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the 'email' value is not present on the $admin argument.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="insert" id="_insert">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_insert">#</a>
|
|
<code><a href="source-class-Admins_Model.html#80-110" title="Go to source code">insert</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Insert a new admin record into the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Insert a new admin record into the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin data.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>integer</code><br>Returns the new record id.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the insert operation fails.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="update" id="_update">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_update">#</a>
|
|
<code><a href="source-class-Admins_Model.html#112-135" title="Go to source code">update</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Update an existing admin record in the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Update an existing admin record in the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin record data.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>integer</code><br>Retuns the record id.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the update operation fails.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="find_record_id" id="_find_record_id">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_find_record_id">#</a>
|
|
<code><a href="source-class-Admins_Model.html#137-163" title="Go to source code">find_record_id</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Find the database record id of an admin user.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Find the database record id of an admin user.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin data. The 'email' value is required in order to find
|
|
the record id.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>integer</code><br>Returns the record id<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the 'email' value is not present on the $admin array.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="validate" id="_validate">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_validate">#</a>
|
|
<code><a href="source-class-Admins_Model.html#165-200" title="Go to source code">validate</a>( <span>array <var>$admin</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Validate admin user data before add() operation is executed.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Validate admin user data before add() operation is executed.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin</var></dt>
|
|
<dd><code>array</code><br>$admin Contains the admin user data.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br>Returns the validation result.<br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="delete" id="_delete">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_delete">#</a>
|
|
<code><a href="source-class-Admins_Model.html#202-231" title="Go to source code">delete</a>( <span>numeric <var>$admin_id</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Delete an existing admin record from the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Delete an existing admin record from the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin_id</var></dt>
|
|
<dd><code>numeric</code><br>$admin_id The admin record id to be deleted.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>boolean</code><br>Returns the delete operation result.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the $admin_id is not a valid numeric value.<br />
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the record to be deleted is the only one admin user left on the system.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="get_row" id="_get_row">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_get_row">#</a>
|
|
<code><a href="source-class-Admins_Model.html#233-258" title="Go to source code">get_row</a>( <span>numeric <var>$admin_id</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get a specific admin record from the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get a specific admin record from the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$admin_id</var></dt>
|
|
<dd><code>numeric</code><br>$admin_id The id of the record to be returned.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br>Returns an array with the admin user data.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the $admin_id is not a valid numeric value.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="get_value" id="_get_value">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_get_value">#</a>
|
|
<code><a href="source-class-Admins_Model.html#260-295" title="Go to source code">get_value</a>( <span>string <var>$field_name</var></span>, <span>numeric <var>$admin_id</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get a specific field value from the database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get a specific field value from the database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$field_name</var></dt>
|
|
<dd><code>string</code><br>$field_name The field name of the value to be returned.</dd>
|
|
<dt><var>$admin_id</var></dt>
|
|
<dd><code>numeric</code><br>$admin_id Record id of the value to be returned.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>string</code><br>Returns the selected record value from the database.<br />
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the $field_name argument is not a valid string.<br />
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the $admin_id is not a valid numeric.<br />
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the admin record does not exist in the database.<br />
|
|
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the selected field value is not present on database.<br />
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="get_batch" id="_get_batch">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
array
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_get_batch">#</a>
|
|
<code><a href="source-class-Admins_Model.html#297-321" title="Go to source code">get_batch</a>( <span>string|array <var>$where_clause</var> = <span class="php-quote">''</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get all, or specific admin records from database.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get all, or specific admin records from database.</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$where_clause</var></dt>
|
|
<dd><code>string|array</code><br>$where_clause (OPTIONAL) The WHERE clause of the query to be executed. Use this
|
|
to get specific admin records.</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>array</code><br>Returns an array with admin records.<br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="get_admin_role_id" id="_get_admin_role_id">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_get_admin_role_id">#</a>
|
|
<code><a href="source-class-Admins_Model.html#323-330" title="Go to source code">get_admin_role_id</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Get the admin users role id.</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Get the admin users role id.</p>
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code>integer</code><br>Returns the role record id.<br />
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</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>
|