mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-30 03:42:44 +03:00
Code Issues Projects Releases Packages Wiki Activity
easyappointments/doc/code/php/class-Secretaries_Model.html

798 lines
21 KiB
HTML
Raw Normal View History

Replaced phpdoc with apigen
2015-01-29 00:56:57 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Secretaries_Model</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><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 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>
<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><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 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>
<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 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' >> array with provider ids that the secretary handles 'settings' >> array with the secretary settings</p>
</div>
<dl class="tree well">
<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="alert alert-info">
<b>Located at</b> <a href="source-class-Secretaries_Model.html#3-466" title="Go to source code">secretaries_model.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-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-52" 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>Contains the secretary user data.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
integer<br>Returns the record id.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the secretary data are invalid (see validate() method).
</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#54-77" 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><p>Contains the secretary data. The 'email' value is required to
be present at the moment.</p></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>Returns whether the record exists or not.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the 'email' value is not present on the $secretary argument.
</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#79-108" 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>Contains the secretary data.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
integer<br>Returns the new record id.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the insert operation fails.
</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#110-139" 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>Contains the secretary record data.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
integer<br>Retuns the record id.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the update operation fails.
</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#141-167" 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><p>Contains the secretary data. The 'email' value is required
in order to find the record id.</p></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
integer<br>Returns the record id
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the 'email' value is not present on the $secretary array.
</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#169-240" 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>Contains the secretary user data.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>Returns the validation result.
</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#242-260" 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>The secretary record id to be deleted.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>Returns the delete operation result.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the $secretary_id is not a valid numeric value.
</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#262-294" 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>The id of the record to be returned.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
array<br>Returns an array with the secretary user data.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the $secretary_id is not a valid numeric value.<br>
Exception<br>When given record id does not exist in the database.
</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#296-331" 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>The field name of the value to be returned.</dd>
<dt><var>$secretary_id</var></dt>
<dd>Record id of the value to be returned.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
string<br>Returns the selected record value from the database.
</div>
<h4>Throws</h4>
<div class="list">
Exception<br>When the $field_name argument is not a valid string.<br>
Exception<br>When the $secretary_id is not a valid numeric.<br>
Exception<br>When the secretary record does not exist in the database.<br>
Exception<br>When the selected field value is not present on database.
</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#333-366" 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><p>(OPTIONAL) The WHERE clause of the query to be executed.
Use this to get specific secretary records.</p></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
array<br>Returns an array with secretary records.
</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#368-375" 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">
integer<br>Returns the role record id.
</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#427-438" 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>The setting name that is going to be returned.</dd>
<dt><var>$secretary_id</var></dt>
<dd>The selected provider id.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
string<br>Returs the value of the selected user setting.
</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#440-452" 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>The setting's name.</dd>
<dt><var>$value</var></dt>
<dd>The setting's value.</dd>
<dt><var>$secretary_id</var></dt>
<dd>The selected provider id.</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="validate_username" id="_validate_username">
<td class="attributes"><code>
public
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_validate_username">#</a>
<code><a href="source-class-Secretaries_Model.html#454-465" title="Go to source code">validate_username</a>( <span>string <var>$username</var></span>, <span>numeric <var>$user_id</var></span> )</code>
<div class="description short">
<p>Validate Records Username</p>
</div>
<div class="description detailed hidden">
<p>Validate Records Username</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$username</var></dt>
<dd>The provider records username.</dd>
<dt><var>$user_id</var></dt>
<dd>The user record id.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
boolean<br>Returns the validation result.
</div>
</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>
Reference in a new issue Copy permalink