forked from mirrors/easyappointments
1107 lines
63 KiB
HTML
1107 lines
63 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
||
<meta charset="utf-8"/>
|
||
<title>API Documentation</title>
|
||
<meta name="author" content=""/>
|
||
<meta name="description" content=""/>
|
||
|
||
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
||
<link href="../css/font-awesome.min.css" rel="stylesheet">
|
||
<link href="../css/prism.css" rel="stylesheet" media="all"/>
|
||
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../js/html5.js"></script>
|
||
<![endif]-->
|
||
<script src="../js/jquery-1.11.0.min.js"></script>
|
||
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
|
||
<script src="../js/bootstrap.min.js"></script>
|
||
<script src="../js/jquery.smooth-scroll.js"></script>
|
||
<script src="../js/prism.min.js"></script>
|
||
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
||
<script type="text/javascript">
|
||
function loadExternalCodeSnippets() {
|
||
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
|
||
var src = pre.getAttribute('data-src');
|
||
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
||
var language = 'php';
|
||
|
||
var code = document.createElement('code');
|
||
code.className = 'language-' + language;
|
||
|
||
pre.textContent = '';
|
||
|
||
code.textContent = 'Loading…';
|
||
|
||
pre.appendChild(code);
|
||
|
||
var xhr = new XMLHttpRequest();
|
||
|
||
xhr.open('GET', src, true);
|
||
|
||
xhr.onreadystatechange = function () {
|
||
if (xhr.readyState == 4) {
|
||
|
||
if (xhr.status < 400 && xhr.responseText) {
|
||
code.textContent = xhr.responseText;
|
||
|
||
Prism.highlightElement(code);
|
||
}
|
||
else if (xhr.status >= 400) {
|
||
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
||
}
|
||
else {
|
||
code.textContent = '✖ Error: File does not exist or is empty';
|
||
}
|
||
}
|
||
};
|
||
|
||
xhr.send(null);
|
||
});
|
||
}
|
||
|
||
$(document).ready(function(){
|
||
loadExternalCodeSnippets();
|
||
});
|
||
$('#source-view').on('shown', function () {
|
||
loadExternalCodeSnippets();
|
||
})
|
||
</script>
|
||
|
||
<link rel="shortcut icon" href="../images/favicon.ico"/>
|
||
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
|
||
</head>
|
||
<body>
|
||
|
||
<div class="navbar navbar-fixed-top">
|
||
<div class="navbar-inner">
|
||
<div class="container">
|
||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
||
<i class="icon-ellipsis-vertical"></i>
|
||
</a>
|
||
<a class="brand" href="../index.html">API Documentation</a>
|
||
|
||
<div class="nav-collapse">
|
||
<ul class="nav pull-right">
|
||
<li class="dropdown" id="charts-menu">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
Charts <b class="caret"></b>
|
||
</a>
|
||
<ul class="dropdown-menu">
|
||
<li>
|
||
<a href="../graphs/class.html">
|
||
<i class="icon-list-alt"></i> Class hierarchy diagram
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown" id="reports-menu">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
Reports <b class="caret"></b>
|
||
</a>
|
||
<ul class="dropdown-menu">
|
||
<li>
|
||
<a href="../reports/errors.html">
|
||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">368</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../reports/markers.html">
|
||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../reports/deprecated.html">
|
||
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">1</span>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!--<div class="go_to_top">-->
|
||
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
|
||
<!--</div>-->
|
||
</div>
|
||
|
||
<div id="___" class="container-fluid">
|
||
<section class="row-fluid">
|
||
<div class="span2 sidebar">
|
||
<div class="accordion" style="margin-bottom: 0">
|
||
<div class="accordion-group">
|
||
<div class="accordion-heading">
|
||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-937060998"></a>
|
||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||
</div>
|
||
<div id="namespace-937060998" class="accordion-body collapse in">
|
||
<div class="accordion-inner">
|
||
|
||
|
||
<ul>
|
||
<li class="class"><a href="../classes/Admins_Model.html">Admins_Model</a></li>
|
||
<li class="class"><a href="../classes/Appointments.html">Appointments</a></li>
|
||
<li class="class"><a href="../classes/Appointments_Model.html">Appointments_Model</a></li>
|
||
<li class="class"><a href="../classes/Backend.html">Backend</a></li>
|
||
<li class="class"><a href="../classes/Backend_api.html">Backend_api</a></li>
|
||
<li class="class"><a href="../classes/Customers_Model.html">Customers_Model</a></li>
|
||
<li class="class"><a href="../classes/Errors.html">Errors</a></li>
|
||
<li class="class"><a href="../classes/Google.html">Google</a></li>
|
||
<li class="class"><a href="../classes/Google_Sync.html">Google_Sync</a></li>
|
||
<li class="class"><a href="../classes/Notifications.html">Notifications</a></li>
|
||
<li class="class"><a href="../classes/Providers_Model.html">Providers_Model</a></li>
|
||
<li class="class"><a href="../classes/Roles_Model.html">Roles_Model</a></li>
|
||
<li class="class"><a href="../classes/Secretaries_Model.html">Secretaries_Model</a></li>
|
||
<li class="class"><a href="../classes/Services_Model.html">Services_Model</a></li>
|
||
<li class="class"><a href="../classes/Settings_Model.html">Settings_Model</a></li>
|
||
<li class="class"><a href="../classes/Test.html">Test</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests.html">Unit_tests</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_admins_model.html">Unit_tests_admins_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_appointments_model.html">Unit_tests_appointments_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_customers_model.html">Unit_tests_customers_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_providers_model.html">Unit_tests_providers_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_secretaries_model.html">Unit_tests_secretaries_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_services_model.html">Unit_tests_services_model</a></li>
|
||
<li class="class"><a href="../classes/Unit_tests_settings_model.html">Unit_tests_settings_model</a></li>
|
||
<li class="class"><a href="../classes/User.html">User</a></li>
|
||
<li class="class"><a href="../classes/User_Model.html">User_Model</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
<section class="row-fluid">
|
||
<div class="span10 offset2">
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<nav>
|
||
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
|
||
</nav>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
||
|
||
<h1><small>\</small>Providers_Model</h1>
|
||
<p><em>Providers_Model Class</em></p>
|
||
<p>Contains the database operations for the service provider users of
|
||
Easy!Appointmenst.</p>
|
||
<p>Data Structure:</p>
|
||
<pre><code> 'fist_name'
|
||
'last_name' (required)
|
||
'email' (required)
|
||
'mobile_number'
|
||
'phone_number' (required)
|
||
'address'
|
||
'city'
|
||
'state'
|
||
'zip_code'
|
||
'notes'
|
||
'id_roles'
|
||
'services' >> array that contains the ids that the provider can provide
|
||
'settings'
|
||
'username'
|
||
'password'
|
||
'notifications'
|
||
'working_plan'
|
||
'google_sync'
|
||
'google_token'
|
||
'google_calendar'
|
||
'sync_past_days'
|
||
'sync_future_days'</code></pre>
|
||
|
||
|
||
<section id="summary">
|
||
<h2>Summary</h2>
|
||
<section class="row-fluid heading">
|
||
<section class="span4">
|
||
<a href="#methods">Methods</a>
|
||
</section>
|
||
<section class="span4">
|
||
<a href="#properties">Properties</a>
|
||
</section>
|
||
<section class="span4">
|
||
<a href="#constants">Constants</a>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid public">
|
||
<section class="span4">
|
||
<a href="../classes/Providers_Model.html#method___construct" class="">__construct()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_add" class="">add()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_exists" class="">exists()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_insert" class="">insert()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_update" class="">update()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_find_record_id" class="">find_record_id()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_validate" class="">validate()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_delete" class="">delete()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_row" class="">get_row()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_value" class="">get_value()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_batch" class="">get_batch()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_available_providers" class="deprecated">get_available_providers()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_providers_role_id" class="">get_providers_role_id()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_get_setting" class="">get_setting()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_set_setting" class="">set_setting()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_validate_username" class="">validate_username()</a><br />
|
||
</section>
|
||
<section class="span4">
|
||
<em>No public properties found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>No constants found</em>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid protected">
|
||
<section class="span4">
|
||
<em>No protected methods found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>No protected properties found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>N/A</em>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid private">
|
||
<section class="span4">
|
||
<a href="../classes/Providers_Model.html#method_save_settings" class="">save_settings()</a><br />
|
||
<a href="../classes/Providers_Model.html#method_save_services" class="">save_services()</a><br />
|
||
</section>
|
||
<section class="span4">
|
||
<em>No private properties found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>N/A</em>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
|
||
|
||
<dl>
|
||
<dt>File</dt>
|
||
<dd><a href="../files/models.providers_model.html"><div class="path-wrapper">models/providers_model.php</div></a></dd>
|
||
<dt>Package</dt>
|
||
<dd><div class="namespace-wrapper">Default</div></dd>
|
||
<dt>Class hierarchy</dt>
|
||
<dd class="hierarchy">
|
||
|
||
<div class="namespace-wrapper">\CI_Model</div>
|
||
<div class="namespace-wrapper">\Providers_Model</div>
|
||
</dd>
|
||
|
||
|
||
|
||
|
||
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
|
||
|
||
<a id="methods" name="methods"></a>
|
||
<div class="row-fluid">
|
||
<div class="span8 content class"><h2>Methods</h2></div>
|
||
<aside class="span4 detailsbar"></aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method___construct" name="method___construct" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">__construct()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">__construct() </pre>
|
||
<p><em>Class Constructor</em></p>
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_add" name="method_add" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">add()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">add(array <span class="argument">$provider</span>) : integer</pre>
|
||
<p><em>Add (insert - update) a service provider record.</em></p>
|
||
<p>If the record already exists (id value provided) then it is going to be updated,
|
||
otherwise inserted into the database.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the service provider data.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the record data validation fails.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>Returns the record id.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_exists" name="method_exists" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">exists()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">exists(array <span class="argument">$provider</span>) : boolean</pre>
|
||
<p><em>Check whether a particular provider record already exists in the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the provider data. The 'email' value is required
|
||
in order to check for a provider.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the 'email' value is not provided.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
boolean
|
||
— <p>Returns whether the provider record exists or not.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_insert" name="method_insert" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">insert()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">insert(array <span class="argument">$provider</span>) : integer</pre>
|
||
<p><em>Insert a new provider record into the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the provider data (must be already validated).</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the insert operation fails.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>Returns the new record id.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_update" name="method_update" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">update()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">update(array <span class="argument">$provider</span>) : integer</pre>
|
||
<p><em>Update an existing provider record in the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the provider data.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the update operation fails.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>Returns the record id.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_find_record_id" name="method_find_record_id" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">find_record_id()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">find_record_id(array <span class="argument">$provider</span>) : integer</pre>
|
||
<p><em>Find the database record id of a provider.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the provider data. The 'email' value is required
|
||
in order to find the record id.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the provider's email value is not provided.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>Returns the record id.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_validate" name="method_validate" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">validate()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">validate(array <span class="argument">$provider</span>) : boolean</pre>
|
||
<p><em>Validate provider data before the insert or update operation is executed.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$provider </td>
|
||
<td><p>Contains the provider data.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
boolean
|
||
— <p>Returns the validation result.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_delete" name="method_delete" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">delete()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">delete( <span class="argument">$provider_id</span>) : boolean</pre>
|
||
<p><em>Delete an existing provider record from the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td></td>
|
||
<td>$provider_id </td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the provider id value is not numeric.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
boolean
|
||
— <p>Returns the delete operation result.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_row" name="method_get_row" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_row()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_row(integer <span class="argument">$provider_id</span>) : array</pre>
|
||
<p><em>Get a specific provider record from the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>integer</td>
|
||
<td>$provider_id </td>
|
||
<td><p>The id of the record to be returned.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the selected record does not exist in database.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
array
|
||
— <p>Returns an associative array with the selected record's data. Each key
|
||
has the same name as the database field names.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_value" name="method_get_value" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_value()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_value(string <span class="argument">$field_name</span>, \numeric <span class="argument">$provider_id</span>) : string</pre>
|
||
<p><em>Get a specific field value from the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$field_name </td>
|
||
<td><p>The field name of the value to be returned.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>\numeric</td>
|
||
<td>$provider_id </td>
|
||
<td><p>Record id of the value to be returned.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the $field_name argument is not a valid string.</p></dd>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the $admin_id is not a valid numeric.</p></dd>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the admin record does not exist in the database.</p></dd>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the selected field value is not present on database.</p></dd>
|
||
</dl>
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>Returns the selected record value from the database.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_batch" name="method_get_batch" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_batch()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_batch(mixed <span class="argument">$where_clause = ''</span>) : array</pre>
|
||
<p><em>Get all, or specific records from provider's table.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>mixed</td>
|
||
<td>$where_clause </td>
|
||
<td><p>(OPTIONAL) The WHERE clause of the query to be executed.</p>
|
||
<p>NOTICE: DO NOT INCLUDE 'WHERE' KEYWORD.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
array
|
||
— <p>Returns the rows from the database.</p>
|
||
|
||
<h4>Examples</h4>
|
||
<h5>= ' . $recordId);</h5>
|
||
<pre class="pre-scrollable">** File not found : $this->Model->get_batch('id **</pre>
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_available_providers" name="method_get_available_providers" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public deprecated">get_available_providers()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_available_providers() : array</pre>
|
||
<p><em>Get the available system providers.</em></p>
|
||
<p>This method returns the available providers and the services that can
|
||
provide.</p>
|
||
|
||
|
||
|
||
<h4>Returns</h4>
|
||
array
|
||
— <p>Returns an array with the providers data.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<aside class="alert alert-block alert-error">
|
||
<h4>Deprecated</h4>
|
||
since version 0.5 - Use get_batch() instead.
|
||
</aside>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_providers_role_id" name="method_get_providers_role_id" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_providers_role_id()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_providers_role_id() : integer</pre>
|
||
<p><em>Get the providers role id from the database.</em></p>
|
||
|
||
|
||
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>Returns the role id for the provider records.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_setting" name="method_get_setting" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_setting()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_setting(string <span class="argument">$setting_name</span>, integer <span class="argument">$provider_id</span>) : string</pre>
|
||
<p><em>Get a providers setting from the database.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$setting_name </td>
|
||
<td><p>The setting name that is going to be
|
||
returned.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>integer</td>
|
||
<td>$provider_id </td>
|
||
<td><p>The selected provider id.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>Returs the value of the selected user setting.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_set_setting" name="method_set_setting" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">set_setting()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">set_setting(string <span class="argument">$setting_name</span>, string <span class="argument">$value</span>, \numeric <span class="argument">$provider_id</span>) </pre>
|
||
<p><em>Set a provider's setting value in the database.</em></p>
|
||
<p>The provider and settings record must already exist.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$setting_name </td>
|
||
<td><p>The setting's name.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$value </td>
|
||
<td><p>The setting's value.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>\numeric</td>
|
||
<td>$provider_id </td>
|
||
<td><p>The selected provider id.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_validate_username" name="method_validate_username" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">validate_username()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">validate_username(string <span class="argument">$username</span>, \numeric <span class="argument">$user_id</span>) : boolean</pre>
|
||
<p><em>Validate Records Username</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$username </td>
|
||
<td><p>The provider records username.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>\numeric</td>
|
||
<td>$user_id </td>
|
||
<td><p>The user record id.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
boolean
|
||
— <p>Returns the validation result.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_save_settings" name="method_save_settings" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="private ">save_settings()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">save_settings(array <span class="argument">$settings</span>, \numeric <span class="argument">$provider_id</span>) </pre>
|
||
<p><em>Save the provider settings (used from insert or update operation).</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$settings </td>
|
||
<td><p>Contains the setting values.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>\numeric</td>
|
||
<td>$provider_id </td>
|
||
<td><p>Record id of the provider.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_save_services" name="method_save_services" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="private ">save_services()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">save_services(array <span class="argument">$services</span>, \numeric <span class="argument">$provider_id</span>) </pre>
|
||
<p><em>Save the provider services in the database (use on both insert and update operation).</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$services </td>
|
||
<td><p>Contains the service ids that the selected provider can provide.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>\numeric</td>
|
||
<td>$provider_id </td>
|
||
<td><p>The selected provider record id.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Throws</h4>
|
||
<dl>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the $services argument type is not array.</p></dd>
|
||
<dt>\Exception</dt>
|
||
<dd><p>When the $provider_id argumetn type is not numeric.</p></dd>
|
||
</dl>
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
||
<h3 id="source-view-label">providers_model.php</h3>
|
||
</div>
|
||
<div class="modal-body">
|
||
<pre data-src="../files/models/providers_model.php.txt" class="language-php line-numbers"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="row-fluid">
|
||
<section class="span10 offset2">
|
||
<section class="row-fluid">
|
||
<section class="span10 offset1">
|
||
<section class="row-fluid footer-sections">
|
||
<section class="span4">
|
||
<h1><i class="icon-code"></i></h1>
|
||
<div>
|
||
<ul>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section class="span4">
|
||
<h1><i class="icon-bar-chart"></i></h1>
|
||
<div>
|
||
<ul>
|
||
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section class="span4">
|
||
<h1><i class="icon-pushpin"></i></h1>
|
||
<div>
|
||
<ul>
|
||
<li><a href="../reports/errors.html">Errors</a></li>
|
||
<li><a href="../reports/markers.html">Markers</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid">
|
||
<section class="span10 offset1">
|
||
<hr />
|
||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||
on January 21st, 2015 at 23:15.
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</footer>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|