diff options
Diffstat (limited to 'docs/classes/assignment.html')
| -rw-r--r-- | docs/classes/assignment.html | 1195 |
1 files changed, 0 insertions, 1195 deletions
diff --git a/docs/classes/assignment.html b/docs/classes/assignment.html deleted file mode 100644 index af462a7..0000000 --- a/docs/classes/assignment.html +++ /dev/null @@ -1,1195 +0,0 @@ -<!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">50</span> - </a> - </li> - <li> - <a href="../reports/markers.html"> - <i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span> - </a> - </li> - <li> - <a href="../reports/deprecated.html"> - <i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</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-208326168"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-208326168" class="accordion-body collapse in"> - <div class="accordion-inner"> - - - <ul> - <li class="class"><a href="../classes/assignment.html">assignment</a></li> - <li class="class"><a href="../classes/BusinessAdmin.html">BusinessAdmin</a></li> - <li class="class"><a href="../classes/client.html">client</a></li> - <li class="class"><a href="../classes/constants.html">constants</a></li> - <li class="class"><a href="../classes/contact.html">contact</a></li> - <li class="class"><a href="../classes/correspondence.html">correspondence</a></li> - <li class="class"><a href="../classes/file.html">file</a></li> - <li class="class"><a href="../classes/offer.html">offer</a></li> - <li class="class"><a href="../classes/response.html">response</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>assignment</h1> - <p><em>An interface to the assignment table in the database</em></p> - - - - <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/assignment.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/assignment.html#method_getId" class="">getId()</a><br /> - <a href="../classes/assignment.html#method_getOfferId" class="">getOfferId()</a><br /> - <a href="../classes/assignment.html#method_getOffer" class="">getOffer()</a><br /> - <a href="../classes/assignment.html#method_getTitle" class="">getTitle()</a><br /> - <a href="../classes/assignment.html#method_setTitle" class="">setTitle()</a><br /> - <a href="../classes/assignment.html#method_getDescription" class="">getDescription()</a><br /> - <a href="../classes/assignment.html#method_setDescription" class="">setDescription()</a><br /> - <a href="../classes/assignment.html#method_getHours" class="">getHours()</a><br /> - <a href="../classes/assignment.html#method_setHours" class="">setHours()</a><br /> - <a href="../classes/assignment.html#method_getPricePerHour" class="">getPricePerHour()</a><br /> - <a href="../classes/assignment.html#method_setPricePerHour" class="">setPricePerHour()</a><br /> - <a href="../classes/assignment.html#method_getVAT" class="">getVAT()</a><br /> - <a href="../classes/assignment.html#method_setVAT" class="">setVAT()</a><br /> - <a href="../classes/assignment.html#method_calculate" class="">calculate()</a><br /> - <a href="../classes/assignment.html#method_delete" class="">delete()</a><br /> - </section> - <section class="span4"> - <em>No public properties found</em> - </section> - <section class="span4"> - <a href="../classes/assignment.html#constant_SUBTOTAL" class="">SUBTOTAL</a><br /> - <a href="../classes/assignment.html#constant_VAT" class="">VAT</a><br /> - <a href="../classes/assignment.html#constant_TOTAL" class="">TOTAL</a><br /> - </section> - </section> - <section class="row-fluid protected"> - <section class="span4"> - <em>No protected methods found</em> - </section> - <section class="span4"> - <a href="../classes/assignment.html#property_pdo" class="">$pdo</a><br /> - <a href="../classes/assignment.html#property_offerId" class="">$offerId</a><br /> - <a href="../classes/assignment.html#property_id" class="">$id</a><br /> - <a href="../classes/assignment.html#property_title" class="">$title</a><br /> - <a href="../classes/assignment.html#property_description" class="">$description</a><br /> - <a href="../classes/assignment.html#property_hours" class="">$hours</a><br /> - <a href="../classes/assignment.html#property_price_per_hour" class="">$price_per_hour</a><br /> - <a href="../classes/assignment.html#property_vat" class="">$vat</a><br /> - </section> - <section class="span4"> - <em>N/A</em> - </section> - </section> - <section class="row-fluid private"> - <section class="span4"> - <em>No private methods found</em> - </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/assignment.class.html"><div class="path-wrapper">assignment.class.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">\assignment</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="constants" name="constants"></a> - <div class="row-fluid"> - <div class="span8 content class"> - <h2>Constants</h2> - </div> - <aside class="span4 detailsbar"></aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_SUBTOTAL" name="constant_SUBTOTAL" class="anchor"></a> - <article id="constant_SUBTOTAL" class="constant"> - <h3 class="">SUBTOTAL</h3> - <pre class="signature">SUBTOTAL</pre> - <p><em></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="constant_VAT" name="constant_VAT" class="anchor"></a> - <article id="constant_VAT" class="constant"> - <h3 class="">VAT</h3> - <pre class="signature">VAT</pre> - <p><em></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="constant_TOTAL" name="constant_TOTAL" class="anchor"></a> - <article id="constant_TOTAL" class="constant"> - <h3 class="">TOTAL</h3> - <pre class="signature">TOTAL</pre> - <p><em></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> - - - <a id="properties" name="properties"></a> - <div class="row-fluid"> - <div class="span8 content class"> - <h2>Properties</h2> - </div> - <aside class="span4 detailsbar"></aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="property_pdo" name="property_pdo" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$pdo</h3> - <pre class="signature">$pdo : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_offerId" name="property_offerId" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$offerId</h3> - <pre class="signature">$offerId : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_id" name="property_id" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$id</h3> - <pre class="signature">$id : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_title" name="property_title" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$title</h3> - <pre class="signature">$title : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_description" name="property_description" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$description</h3> - <pre class="signature">$description : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_hours" name="property_hours" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$hours</h3> - <pre class="signature">$hours : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_price_per_hour" name="property_price_per_hour" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$price_per_hour</h3> - <pre class="signature">$price_per_hour : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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="property_vat" name="property_vat" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$vat</h3> - <pre class="signature">$vat : \pdo</pre> - <p><em></em></p> - - - <h4>Type</h4> - \pdo - — The PDO class for database communication </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> - - - <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(\PDO <span class="argument">$pdo</span>, integer <span class="argument">$id</span>) </pre> - <p><em>Create a new instance</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class, to access the database</p></td> - </tr> - <tr> - <td>integer</td> - <td>$id </td> - <td><p>The id of the assignment to fetch</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - <dt>\Exception</dt> - <dd><p>If the assignment could not be found</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 class="row-fluid"> - <div class="span8 content class"> - <a id="method_getId" name="method_getId" class="anchor"></a> - <article class="method"> - <h3 class="public ">getId()</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;">getId() : integer</pre> - <p><em>Get the ID of the assignment</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The 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_getOfferId" name="method_getOfferId" class="anchor"></a> - <article class="method"> - <h3 class="public ">getOfferId()</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;">getOfferId() : integer</pre> - <p><em>Get the ID of the offer that this assignment is linked to</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The 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_getOffer" name="method_getOffer" class="anchor"></a> - <article class="method"> - <h3 class="public ">getOffer()</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;">getOffer() : \offer</pre> - <p><em>Get the offer that this assignment is linked to</em></p> - - - - - <h4>Returns</h4> - <a href="../classes/offer.html">\offer</a> - — <p>The offer</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_getTitle" name="method_getTitle" class="anchor"></a> - <article class="method"> - <h3 class="public ">getTitle()</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;">getTitle() : string</pre> - <p><em>Get the title of the assignment</em></p> - - - - - <h4>Returns</h4> - string - — <p>The title</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_setTitle" name="method_setTitle" class="anchor"></a> - <article class="method"> - <h3 class="public ">setTitle()</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;">setTitle(string <span class="argument">$title</span>) : boolean</pre> - <p><em>Set the title of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$title </td> - <td><p>The new title for the assignment</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on succes, false on failure</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_getDescription" name="method_getDescription" class="anchor"></a> - <article class="method"> - <h3 class="public ">getDescription()</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;">getDescription(boolean <span class="argument">$parseMarkdown = true</span>) : string</pre> - <p><em>Get the description of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>boolean</td> - <td>$parseMarkdown </td> - <td><p>Whether or not to parse markdown</p></td> - </tr> - </table> - - - <h4>Returns</h4> - string - — <p>The description</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_setDescription" name="method_setDescription" class="anchor"></a> - <article class="method"> - <h3 class="public ">setDescription()</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;">setDescription(string <span class="argument">$description</span>) : boolean</pre> - <p><em>Set the description of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$description </td> - <td><p>The new description for the assignment</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on succes, false on failure</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_getHours" name="method_getHours" class="anchor"></a> - <article class="method"> - <h3 class="public ">getHours()</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;">getHours() : integer</pre> - <p><em>Get the amount of hours of the assignment</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The amount of hours</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_setHours" name="method_setHours" class="anchor"></a> - <article class="method"> - <h3 class="public ">setHours()</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;">setHours(integer <span class="argument">$hours</span>) : boolean</pre> - <p><em>Set the amount of hours of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$hours </td> - <td><p>The new amount hours for the assignment</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on succes, false on failure</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_getPricePerHour" name="method_getPricePerHour" class="anchor"></a> - <article class="method"> - <h3 class="public ">getPricePerHour()</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;">getPricePerHour() : float</pre> - <p><em>Get the price per hour of the assignment</em></p> - - - - - <h4>Returns</h4> - float - — <p>The price per hour</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_setPricePerHour" name="method_setPricePerHour" class="anchor"></a> - <article class="method"> - <h3 class="public ">setPricePerHour()</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;">setPricePerHour(float <span class="argument">$price_per_hour</span>) : boolean</pre> - <p><em>Set the price per hour of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>float</td> - <td>$price_per_hour </td> - <td><p>The new price per hour for the assignment</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on succes, false on failure</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_getVAT" name="method_getVAT" class="anchor"></a> - <article class="method"> - <h3 class="public ">getVAT()</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;">getVAT() : float</pre> - <p><em>Get the VAT percentage of the assignment</em></p> - - - - - <h4>Returns</h4> - float - — <p>The VAT percentage</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_setVAT" name="method_setVAT" class="anchor"></a> - <article class="method"> - <h3 class="public ">setVAT()</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;">setVAT(float <span class="argument">$vat</span>) : boolean</pre> - <p><em>Set the VAT percentage of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>float</td> - <td>$vat </td> - <td><p>The new VAT percentage for the assignment</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on succes, false on failure</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_calculate" name="method_calculate" class="anchor"></a> - <article class="method"> - <h3 class="public ">calculate()</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;">calculate(integer <span class="argument">$what = self::TOTAL</span>, integer <span class="argument">$round = 2</span>, boolean <span class="argument">$format = true</span>) : float|boolean</pre> - <p><em>Calculate useful numbers about the assignment</em></p> - <p>Subtotal: price_per_hour * hours</p> -<p>VAT: subtotal * VAT_percentage</p> -<p>Total: subtotal + VAT</p> - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$what </td> - <td><p>Any of assignment::SUBTOTAL, assignment::VAT, assignment::TOTAL</p></td> - </tr> - <tr> - <td>integer</td> - <td>$round </td> - <td><p>How many decimals to round on</p></td> - </tr> - <tr> - <td>boolean</td> - <td>$format </td> - <td><p>Whether to format the number nicely (for output) or not (for calculations)</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - float|boolean - — <p>The calculated value rounded on $round decimals, or false when the input is incorrect</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() : boolean</pre> - <p><em>Remove this assignment from the database</em></p> - <p>If this doesn't succeed (i.e. false is returned), that means the assignment was removed manually or by another instance of this class</p> - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - boolean - — <p>True on success, false on failure</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> - </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">assignment.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/assignment.class.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 February 8th, 2015 at 22:48. - </section> - </section> - </section> - </footer> -</div> - -</body> -</html> |