<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: ProvidersHelper</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: ProvidersHelper</h1> <section> <header> <h2> ProvidersHelper </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="ProvidersHelper"><span class="type-signature"></span>new ProvidersHelper<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> This class contains the Providers helper class declaration, along with the "Providers" tab event handlers. By deviding the backend/users tab functionality into separate files it is easier to maintain the code. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line1">line 1</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="bindEventHandlers"><span class="type-signature"></span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Bind the event handlers for the backend/users "Providers" tab. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line15">line 15</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(id)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Delete a provider record from database. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">numeric</span> </td> <td class="description last">Record id to be deleted.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line242">line 242</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="display"><span class="type-signature"></span>display<span class="signature">(provider)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Display a provider record into the admin form. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>provider</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">Contains the provider record data.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line343">line 343</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="editableBreakDay"><span class="type-signature"></span>editableBreakDay<span class="signature">($selector)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Initialize the editable functionality to the break day table cells. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>$selector</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The cells to be initialized.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line443">line 443</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="editableBreakTime"><span class="type-signature"></span>editableBreakTime<span class="signature">($selector)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Initialize the editable functionality to the break time table cells. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>$selector</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The cells to be initialized.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line470">line 470</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(key, selectId, display)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Filters provider records depending a string key. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">This is used to filter the provider records of the database.</td> </tr> <tr> <td class="name"><code>selectId</code></td> <td class="type"> <span class="param-type">numeric</span> </td> <td class="description last">(OPTIONAL = undefined) If set, when the function is complete a result row can be set as selected.</td> </tr> <tr> <td class="name"><code>display</code></td> <td class="type"> <span class="param-type">bool</span> </td> <td class="description last">(OPTIONAL = false) If true then the selected record will be also displayed.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line388">line 388</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="getFilterHtml"><span class="type-signature"></span>getFilterHtml<span class="signature">(provider)</span><span class="type-signature"> → {string}</span></h4> </dt> <dd> <div class="description"> Get an provider row html code that is going to be displayed on the filter results list. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>provider</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">Contains the provider record data.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line428">line 428</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The html code that represents the record on the filter results list. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> </dd> <dt> <h4 class="name" id="resetForm"><span class="type-signature"></span>resetForm<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Resets the admin tab form back to its initial state. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line310">line 310</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(provider)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Save provider record to database. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>provider</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">Contains the admin record data. If an 'id' value is provided then the update operation is going to be executed.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line217">line 217</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="select"><span class="type-signature"></span>select<span class="signature">(id, display)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Select and display a providers filter result on the form. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">numeric</span> </td> <td class="description last">Record id to be selected.</td> </tr> <tr> <td class="name"><code>display</code></td> <td class="type"> <span class="param-type">bool</span> </td> <td class="description last">(OPTIONAL = false) If true the record will be displayed on the form.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line495">line 495</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">(provider)</span><span class="type-signature"> → {bool}</span></h4> </dt> <dd> <div class="description"> Validates a provider record. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>provider</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">Contains the admin data to be validated.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="backend_users_providers.js.html">backend_users_providers.js</a>, <a href="backend_users_providers.js.html#line263">line 263</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Returns the validation result. </div> <dl> <dt> Type </dt> <dd> <span class="param-type">bool</span> </dd> </dl> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="AdminsHelper.html">AdminsHelper</a></li><li><a href="CategoriesHelper.html">CategoriesHelper</a></li><li><a href="CustomersHelper.html">CustomersHelper</a></li><li><a href="ProvidersHelper.html">ProvidersHelper</a></li><li><a href="SecretariesHelper.html">SecretariesHelper</a></li><li><a href="ServicesHelper.html">ServicesHelper</a></li><li><a href="SystemSettings.html">SystemSettings</a></li><li><a href="UserSettings.html">UserSettings</a></li><li><a href="WorkingPlan.html">WorkingPlan</a></li></ul><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="BackendCustomers.html">BackendCustomers</a></li><li><a href="BackendServices.html">BackendServices</a></li><li><a href="BackendSettings.html">BackendSettings</a></li><li><a href="BackendUsers.html">BackendUsers</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#enableCancel">enableCancel</a></li><li><a href="global.html#enableSubmit">enableSubmit</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Sat Oct 19 2013 11:58:42 GMT+0300 (EEST) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>