mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-12-23 07:03:26 +03:00
Code Issues Projects Releases Packages Wiki Activity
easyappointments/doc/code/js/GeneralFunctions.html

715 lines
9.7 KiB
HTML
Raw Normal View History

- Φόρτωση των καταχωρημένων ραντεβού στο ημερολόγιο (backend) - Προβολή λεπτομερειών ραντεβού - Δημιουργία διαλόγου επεξεργασίας (δεν ολοκληρώθηκε ακόμα) - Παραγωγή code docs (js + php)
2013-06-13 19:25:34 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: GeneralFunctions</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">Namespace: GeneralFunctions</h1>
<section>
<header>
<h2>
GeneralFunctions
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">This file contains the General Functions javascript namespace.
It contains functions that apply both on the front and back
end of the application.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="general_functions.js.html">general_functions.js</a>, <a href="general_functions.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="centerElementOnPage"><span class="type-signature">&lt;static> </span>centerElementOnPage<span class="signature">(elementHandle)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This method centers a DOM element vertically and horizontally
on the page.
</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>elementHandle</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The object that is going to be
centered.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="general_functions.js.html">general_functions.js</a>, <a href="general_functions.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="displayMessageBox"><span class="type-signature">&lt;static> </span>displayMessageBox<span class="signature">(title, message, messageButtons)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
This functions displays a message box in
the admin array. It is usefull when user
decisions or verifications are needed.
</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>title</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The title of the message box.</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The message of the dialog.</td>
</tr>
<tr>
<td class="name"><code>messageButtons</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">Contains the dialog
buttons along with their functions.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="general_functions.js.html">general_functions.js</a>, <a href="general_functions.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getUrlParameter"><span class="type-signature">&lt;static> </span>getUrlParameter<span class="signature">(url, name)</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
This function retrieves a parameter from a "GET" formed url.
</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>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The selected url.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The parameter name.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="general_functions.js.html">general_functions.js</a>, <a href="general_functions.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the parameter value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="ISODateString"><span class="type-signature">&lt;static> </span>ISODateString<span class="signature">(dt)</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
This function creates a RFC 3339 date string. This string is needed
by the Google Calendar API in order to pass dates as parameters.
</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>dt</code></td>
<td class="type">
<span class="param-type">date</span>
</td>
<td class="description last">The given date that will be transformed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="general_functions.js.html">general_functions.js</a>, <a href="general_functions.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the transformed string.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</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 Thu Jun 13 2013 16:52:48 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue Copy permalink