easyappointments/doc/code/php/class-Secretaries_Model.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

789 lines
18 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 Secretaries_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><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 class="active"><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 Secretaries_Model</h1>
<div class="description">
<p>Secretaries Model</p>
<p>Handles the db actions that have to do with secretaries.</p>
<p>Data Structure 'first_name' 'last_name' 'email' 'mobile_number'
'phone_number' 'address' 'city' 'state' 'zip_code' 'notes' 'id_roles'
'providers' &gt;&gt; array with provider ids that the secretary handles
'settings' &gt;&gt; array with the secretary settings</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>Secretaries_Model</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Secretaries_Model.html#3-413" title="Go to source code">secretaries_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-Secretaries_Model.html#24-29" 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-Secretaries_Model.html#31-54" title="Go to source code">add</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Add (insert or update) a secretary user record into database.</p>
</div>
<div class="description detailed hidden">
<p>Add (insert or update) a secretary user record into database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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 secretary 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-Secretaries_Model.html#56-79" title="Go to source code">exists</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Check whether a particular secretary record exists in the database.</p>
</div>
<div class="description detailed hidden">
<p>Check whether a particular secretary record exists in the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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 $secretary 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-Secretaries_Model.html#81-106" title="Go to source code">insert</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Insert a new sercretary record into the database.</p>
</div>
<div class="description detailed hidden">
<p>Insert a new sercretary record into the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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-Secretaries_Model.html#108-130" title="Go to source code">update</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Update an existing secretary record in the database.</p>
</div>
<div class="description detailed hidden">
<p>Update an existing secretary record in the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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-Secretaries_Model.html#132-158" title="Go to source code">find_record_id</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Find the database record id of a secretary.</p>
</div>
<div class="description detailed hidden">
<p>Find the database record id of a secretary.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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 $secretary 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-Secretaries_Model.html#160-200" title="Go to source code">validate</a>( <span>array <var>$secretary</var></span> )</code>
<div class="description short">
<p>Validate secretary user data before add() operation is executed.</p>
</div>
<div class="description detailed hidden">
<p>Validate secretary user data before add() operation is executed.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary</var></dt>
<dd><code>array</code><br>$secretary Contains the secretary 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-Secretaries_Model.html#202-220" title="Go to source code">delete</a>( <span>numeric <var>$secretary_id</var></span> )</code>
<div class="description short">
<p>Delete an existing secretary record from the database.</p>
</div>
<div class="description detailed hidden">
<p>Delete an existing secretary record from the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary_id</var></dt>
<dd><code>numeric</code><br>$secretary_id The secretary 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 $secretary_id is not a valid numeric value.<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-Secretaries_Model.html#222-254" title="Go to source code">get_row</a>( <span>numeric <var>$secretary_id</var></span> )</code>
<div class="description short">
<p>Get a specific secretary record from the database.</p>
</div>
<div class="description detailed hidden">
<p>Get a specific secretary record from the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$secretary_id</var></dt>
<dd><code>numeric</code><br>$secretary_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 secretary user data.<br />
</div>
<h4>Throws</h4>
<div class="list">
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the $secretary_id is not a valid numeric value.<br />
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When given record id does not exist in the database.<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-Secretaries_Model.html#256-291" title="Go to source code">get_value</a>( <span>string <var>$field_name</var></span>, <span>numeric <var>$secretary_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>$secretary_id</var></dt>
<dd><code>numeric</code><br>$secretary_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 $secretary_id is not a valid numeric.<br />
<code><code><a href="class-Exception.html">Exception</a></code></code><br>When the secretary 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-Secretaries_Model.html#293-326" 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 secretary records from database.</p>
</div>
<div class="description detailed hidden">
<p>Get all, or specific secretary 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 secretary records.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>Returns an array with secretary records.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="get_secretary_role_id" id="_get_secretary_role_id">
<td class="attributes"><code>
public
integer
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_secretary_role_id">#</a>
<code><a href="source-class-Secretaries_Model.html#328-335" title="Go to source code">get_secretary_role_id</a>( )</code>
<div class="description short">
<p>Get the secretary users role id.</p>
</div>
<div class="description detailed hidden">
<p>Get the secretary 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>
<tr data-order="get_setting" id="_get_setting">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_setting">#</a>
<code><a href="source-class-Secretaries_Model.html#387-398" title="Go to source code">get_setting</a>( <span>string <var>$setting_name</var></span>, <span>integer <var>$secretary_id</var></span> )</code>
<div class="description short">
<p>Get a providers setting from the database.</p>
</div>
<div class="description detailed hidden">
<p>Get a providers setting from the database.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$setting_name</var></dt>
<dd><code>string</code><br>$setting_name The setting name that is going to be returned.</dd>
<dt><var>$secretary_id</var></dt>
<dd><code>integer</code><br>$secretary_id The selected provider id.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>string</code><br>Returs the value of the selected user setting.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="set_setting" id="_set_setting">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_set_setting">#</a>
<code><a href="source-class-Secretaries_Model.html#400-412" title="Go to source code">set_setting</a>( <span>string <var>$setting_name</var></span>, <span>string <var>$value</var></span>, <span>numeric <var>$secretary_id</var></span> )</code>
<div class="description short">
<p>Set a provider's setting value in the database.</p>
</div>
<div class="description detailed hidden">
<p>Set a provider's setting value in the database.</p>
<p>The provider and settings record must already exist.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$setting_name</var></dt>
<dd><code>string</code><br>$setting_name The setting's name.</dd>
<dt><var>$value</var></dt>
<dd><code>string</code><br>$value The setting's value.</dd>
<dt><var>$secretary_id</var></dt>
<dd><code>numeric</code><br>$secretary_id The selected provider id.</dd>
</dl></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>