diff options
Diffstat (limited to 'docs/classes')
| -rw-r--r-- | docs/classes/BusinessAdmin.html | 854 | ||||
| -rw-r--r-- | docs/classes/assignment.html | 1195 | ||||
| -rw-r--r-- | docs/classes/client.html | 731 | ||||
| -rw-r--r-- | docs/classes/constants.html | 785 | ||||
| -rw-r--r-- | docs/classes/contact.html | 1365 | ||||
| -rw-r--r-- | docs/classes/correspondence.html | 682 | ||||
| -rw-r--r-- | docs/classes/file.html | 611 | ||||
| -rw-r--r-- | docs/classes/offer.html | 1491 | ||||
| -rw-r--r-- | docs/classes/response.html | 618 |
9 files changed, 0 insertions, 8332 deletions
diff --git a/docs/classes/BusinessAdmin.html b/docs/classes/BusinessAdmin.html deleted file mode 100644 index 3738620..0000000 --- a/docs/classes/BusinessAdmin.html +++ /dev/null @@ -1,854 +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-1939095602"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-1939095602" 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>BusinessAdmin</h1> - <p><em>Provides basic functions like adding elements to 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/BusinessAdmin.html#method_getClientIds" class="">getClientIds()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getClients" class="">getClients()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getContactIds" class="">getContactIds()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getContacts" class="">getContacts()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getOfferIds" class="">getOfferIds()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getOffers" class="">getOffers()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getAssignmentIds" class="">getAssignmentIds()</a><br /> - <a href="../classes/BusinessAdmin.html#method_getAssignments" class="">getAssignments()</a><br /> - <a href="../classes/BusinessAdmin.html#method_createClient" class="">createClient()</a><br /> - <a href="../classes/BusinessAdmin.html#method_createFile" class="">createFile()</a><br /> - <a href="../classes/BusinessAdmin.html#method_formatDate" class="">formatDate()</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"> - <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/BusinessAdmin.class.html"><div class="path-wrapper">BusinessAdmin.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">\BusinessAdmin</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_getClientIds" name="method_getClientIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getClientIds()</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;">getClientIds(\PDO <span class="argument">$pdo</span>) : array<mixed,integer></pre> - <p><em>Get all client ids</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</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> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getClients"><span class="namespace-wrapper">This funtion returns instances of the client class instead of just the ids</span></a></dd> - </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_getClients" name="method_getClients" class="anchor"></a> - <article class="method"> - <h3 class="public ">getClients()</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;">getClients(\PDO <span class="argument">$pdo</span>) : array<mixed,\client></pre> - <p><em>Get all clients</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</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> - array<mixed,<a href="../classes/client.html">\client</a>> - — <p>An array indexed by id of instances of the client class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getClientIds"><span class="namespace-wrapper">This function returns just the ids of the clients, and not instances of the client class</span></a></dd> - </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_getContactIds" name="method_getContactIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContactIds()</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;">getContactIds(\PDO <span class="argument">$pdo</span>) : array<mixed,integer></pre> - <p><em>Get all contact ids</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>Is something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getContacts"><span class="namespace-wrapper">This funtion returns instances of the contact class instead of just the ids</span></a></dd> - </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_getContacts" name="method_getContacts" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContacts()</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;">getContacts(\PDO <span class="argument">$pdo</span>) : array<mixed,\contact></pre> - <p><em>Get all contacts</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</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> - array<mixed,<a href="../classes/contact.html">\contact</a>> - — <p>An array indexed by id of instances of the contact class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getContactIds"><span class="namespace-wrapper">This function returns just the ids of the contacts, and not instances of the contact class</span></a></dd> - </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_getOfferIds" name="method_getOfferIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getOfferIds()</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;">getOfferIds(\PDO <span class="argument">$pdo</span>, array<mixed,string> <span class="argument">$where = array()</span>) : array<mixed,integer></pre> - <p><em>Get all offer ids</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</p></td> - </tr> - <tr> - <td>array<mixed,string></td> - <td>$where </td> - <td><p>An array of WHERE clauses that will be AND-ed</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>Is something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getOffers"><span class="namespace-wrapper">This funtion returns instances of the offer class instead of just the ids</span></a></dd> - </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_getOffers" name="method_getOffers" class="anchor"></a> - <article class="method"> - <h3 class="public ">getOffers()</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;">getOffers(\PDO <span class="argument">$pdo</span>, array<mixed,string> <span class="argument">$where = array()</span>) : array<mixed,\offer></pre> - <p><em>Get all offers</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</p></td> - </tr> - <tr> - <td>array<mixed,string></td> - <td>$where </td> - <td><p>An array of WHERE clauses that will be AND-ed</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> - array<mixed,<a href="../classes/offer.html">\offer</a>> - — <p>An array indexed by id of instances of the offer class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getOfferIds"><span class="namespace-wrapper">This function returns just the ids of the offers, and not instances of the offer class</span></a></dd> - </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_getAssignmentIds" name="method_getAssignmentIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAssignmentIds()</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;">getAssignmentIds(\PDO <span class="argument">$pdo</span>) : array<mixed,integer></pre> - <p><em>Get all assignment ids</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</p></td> - </tr> - </table> - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>Is something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getAssignments"><span class="namespace-wrapper">This funtion returns instances of the assignment class instead of just the ids</span></a></dd> - </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_getAssignments" name="method_getAssignments" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAssignments()</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;">getAssignments(\PDO <span class="argument">$pdo</span>) : array<mixed,\assignment></pre> - <p><em>Get all assignments</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The PDO class for database connection</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> - array<mixed,<a href="../classes/assignment.html">\assignment</a>> - — <p>An array indexed by id of instances of the assignment class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - <dt>See also</dt> - <dd><a href="../classes/BusinessAdmin.html#method_getAssignmentIds"><span class="namespace-wrapper">This function returns just the ids of the assignments, and not instances of the assignment class</span></a></dd> - </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_createClient" name="method_createClient" class="anchor"></a> - <article class="method"> - <h3 class="public ">createClient()</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;">createClient(\PDO <span class="argument">$pdo</span>, string <span class="argument">$name</span>) : \client|boolean</pre> - <p><em>Create a new client</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The database connection</p></td> - </tr> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The name for the new client</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> - <a href="../classes/client.html">\client</a>|boolean - — <p>A new instance of the client object, or false on failure</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <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_createFile" name="method_createFile" class="anchor"></a> - <article class="method"> - <h3 class="public ">createFile()</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;">createFile(\PDO <span class="argument">$pdo</span>, string <span class="argument">$filename</span>) : \file</pre> - <p><em>Create a new file</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>\PDO</td> - <td>$pdo </td> - <td><p>The database connection</p></td> - </tr> - <tr> - <td>string</td> - <td>$filename </td> - <td><p>The desired filename</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 file could not be created (due to permissions, file existed already, etc.), or the database record couldn't be added</p></dd> - </dl> - - <h4>Returns</h4> - <a href="../classes/file.html">\file</a> - — <p>A new instance of the file object</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <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_formatDate" name="method_formatDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">formatDate()</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;">formatDate(integer <span class="argument">$timestamp</span>, boolean <span class="argument">$with_time = true</span>, boolean <span class="argument">$full_date = false</span>, boolean <span class="argument">$relatively = false</span>) : string</pre> - <p><em>Format a date nicely</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$timestamp </td> - <td><p>The UNIX timestamp to format</p></td> - </tr> - <tr> - <td>boolean</td> - <td>$with_time </td> - <td><p>If false, only the date is returned; if false, also the time</p></td> - </tr> - <tr> - <td>boolean</td> - <td>$full_date </td> - <td><p>If true, a year will be outputted even if the date is in the current year</p></td> - </tr> - <tr> - <td>boolean</td> - <td>$relatively </td> - <td><p>Whether or not to show the date relatively (e.g. '1 day ago') (NOT IMPLEMENTED YET)</p></td> - </tr> - </table> - - - <h4>Returns</h4> - string - — <p>The formatted date</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <span class="label label-info">static</span> - <dl> - </dl> - <h2>Tags</h2> - <table class="table table-condensed"> - <tr> - <th> - todo - </th> - <td> - <p>implement $relatively = true</p> - </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">BusinessAdmin.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/BusinessAdmin.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> 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> diff --git a/docs/classes/client.html b/docs/classes/client.html deleted file mode 100644 index ba12c86..0000000 --- a/docs/classes/client.html +++ /dev/null @@ -1,731 +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-2107738844"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-2107738844" 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>client</h1> - <p><em>An interface to the client 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/client.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/client.html#method_getId" class="">getId()</a><br /> - <a href="../classes/client.html#method_getName" class="">getName()</a><br /> - <a href="../classes/client.html#method_setName" class="">setName()</a><br /> - <a href="../classes/client.html#method_getContactIds" class="">getContactIds()</a><br /> - <a href="../classes/client.html#method_getContacts" class="">getContacts()</a><br /> - <a href="../classes/client.html#method_delete" class="">delete()</a><br /> - <a href="../classes/client.html#method_createContact" class="">createContact()</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"> - <a href="../classes/client.html#property_pdo" class="">$pdo</a><br /> - <a href="../classes/client.html#property_id" class="">$id</a><br /> - <a href="../classes/client.html#property_name" class="">$name</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/client.class.html"><div class="path-wrapper">client.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">\client</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="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_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_name" name="property_name" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$name</h3> - <pre class="signature">$name : \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 client 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 client 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 client</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_getName" name="method_getName" class="anchor"></a> - <article class="method"> - <h3 class="public ">getName()</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;">getName() : string</pre> - <p><em>Get the name of the client</em></p> - - - - - <h4>Returns</h4> - string - — <p>The name</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_setName" name="method_setName" class="anchor"></a> - <article class="method"> - <h3 class="public ">setName()</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;">setName(string <span class="argument">$name</span>) : boolean</pre> - <p><em>Set the name of the client</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The new name for the client</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_getContactIds" name="method_getContactIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContactIds()</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;">getContactIds() : array<mixed,integer></pre> - <p><em>Get all contact ids for this client</em></p> - - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>Is something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/client.html#method_getContacts"><span class="namespace-wrapper">This funtion returns instances of the contact class instead of just the ids</span></a></dd> - </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_getContacts" name="method_getContacts" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContacts()</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;">getContacts() : array<mixed,\contact></pre> - <p><em>Get all contacts for this client</em></p> - - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,<a href="../classes/contact.html">\contact</a>> - — <p>An array indexed by id of instances of the contact class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/client.html#method_getContactIds"><span class="namespace-wrapper">This function returns just the ids of the contacts, and not instances of the contact class</span></a></dd> - </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 client from the database</em></p> - <p>If this doesn't succeed (i.e. false is returned), that means the client 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 class="row-fluid"> - <div class="span8 content class"> - <a id="method_createContact" name="method_createContact" class="anchor"></a> - <article class="method"> - <h3 class="public ">createContact()</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;">createContact(string <span class="argument">$name</span>, string <span class="argument">$email</span>, string <span class="argument">$address</span>, string <span class="argument">$address_2</span>, string <span class="argument">$postal_code</span>, string <span class="argument">$city</span>, string <span class="argument">$country</span>) : \contact</pre> - <p><em>Make a new contact for this client</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The name for this contact</p></td> - </tr> - <tr> - <td>string</td> - <td>$email </td> - <td><p>The email for this contact</p></td> - </tr> - <tr> - <td>string</td> - <td>$address </td> - <td><p>The first address line of this contact (normally street and house number)</p></td> - </tr> - <tr> - <td>string</td> - <td>$address_2 </td> - <td><p>The second address line of this contact</p></td> - </tr> - <tr> - <td>string</td> - <td>$postal_code </td> - <td><p>The postal code for this contact</p></td> - </tr> - <tr> - <td>string</td> - <td>$city </td> - <td><p>The city for this contact</p></td> - </tr> - <tr> - <td>string</td> - <td>$country </td> - <td><p>The country for this contact</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 there was a problem with the input</p></dd> - </dl> - - <h4>Returns</h4> - <a href="../classes/contact.html">\contact</a> - — <p>A new instance of the contact class containing the new contact</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">client.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/client.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> diff --git a/docs/classes/constants.html b/docs/classes/constants.html deleted file mode 100644 index 750dc36..0000000 --- a/docs/classes/constants.html +++ /dev/null @@ -1,785 +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-345962606"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-345962606" 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>constants</h1> - <p><em>A class for some constants</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"> - <em>No public methods found</em> - </section> - <section class="span4"> - <em>No public properties found</em> - </section> - <section class="span4"> - <a href="../classes/constants.html#constant_db_prefix" class="">db_prefix</a><br /> - <a href="../classes/constants.html#constant_files_folder" class="">files_folder</a><br /> - <a href="../classes/constants.html#constant_files_folder_external" class="">files_folder_external</a><br /> - <a href="../classes/constants.html#constant_files_folder_trash" class="">files_folder_trash</a><br /> - <a href="../classes/constants.html#constant_url_external" class="">url_external</a><br /> - <a href="../classes/constants.html#constant_url_internal" class="">url_internal</a><br /> - <a href="../classes/constants.html#constant_my_name" class="">my_name</a><br /> - <a href="../classes/constants.html#constant_invoice_name" class="">invoice_name</a><br /> - <a href="../classes/constants.html#constant_invoice_address_1" class="">invoice_address_1</a><br /> - <a href="../classes/constants.html#constant_invoice_address_2" class="">invoice_address_2</a><br /> - <a href="../classes/constants.html#constant_invoice_address_3" class="">invoice_address_3</a><br /> - <a href="../classes/constants.html#constant_invoice_tax_nr" class="">invoice_tax_nr</a><br /> - <a href="../classes/constants.html#constant_invoice_iban" class="">invoice_iban</a><br /> - <a href="../classes/constants.html#constant_invoice_bic" class="">invoice_bic</a><br /> - <a href="../classes/constants.html#constant_invoice_tel_nr" class="">invoice_tel_nr</a><br /> - <a href="../classes/constants.html#constant_invoice_email" class="">invoice_email</a><br /> - <a href="../classes/constants.html#constant_invoice_valuta" class="">invoice_valuta</a><br /> - <a href="../classes/constants.html#constant_version" class="">version</a><br /> - </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"> - <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/constants.class.html"><div class="path-wrapper">constants.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">\constants</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_db_prefix" name="constant_db_prefix" class="anchor"></a> - <article id="constant_db_prefix" class="constant"> - <h3 class="">db_prefix</h3> - <pre class="signature">db_prefix</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> - <th> - const - </th> - <td> - <p>db_prefix A prefix to add to the tables in the database (leave empty for none)</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_files_folder" name="constant_files_folder" class="anchor"></a> - <article id="constant_files_folder" class="constant"> - <h3 class="">files_folder</h3> - <pre class="signature">files_folder</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> - <th> - const - </th> - <td> - <p>files_folder The folder to store all files (appendices, invoices, etc.) in; with a trailing slash</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_files_folder_external" name="constant_files_folder_external" class="anchor"></a> - <article id="constant_files_folder_external" class="constant"> - <h3 class="">files_folder_external</h3> - <pre class="signature">files_folder_external</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> - <th> - const - </th> - <td> - <p>files_folder_external The external URI to this folder; with a trailing slash</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_files_folder_trash" name="constant_files_folder_trash" class="anchor"></a> - <article id="constant_files_folder_trash" class="constant"> - <h3 class="">files_folder_trash</h3> - <pre class="signature">files_folder_trash</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> - <th> - const - </th> - <td> - <p>files_folder_trash The folder inside files_folder to use a trash, without any trailing slashes</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_url_external" name="constant_url_external" class="anchor"></a> - <article id="constant_url_external" class="constant"> - <h3 class="">url_external</h3> - <pre class="signature">url_external</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> - <th> - const - </th> - <td> - <p>url_external The external URI to this folder; with a trailing slash</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_url_internal" name="constant_url_internal" class="anchor"></a> - <article id="constant_url_internal" class="constant"> - <h3 class="">url_internal</h3> - <pre class="signature">url_internal</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> - <th> - const - </th> - <td> - <p>url_internal The URI without the domain name; with a slash at the beginning but not at the end</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_my_name" name="constant_my_name" class="anchor"></a> - <article id="constant_my_name" class="constant"> - <h3 class="">my_name</h3> - <pre class="signature">my_name</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> - <th> - const - </th> - <td> - <p>my_name Name of this control panel</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_invoice_name" name="constant_invoice_name" class="anchor"></a> - <article id="constant_invoice_name" class="constant"> - <h3 class="">invoice_name</h3> - <pre class="signature">invoice_name</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> - <th> - const - </th> - <td> - <p>invoice_name Your name or the name of your business</p> - <p>invoice_address_1 First address line</p> - <p>invoice_address_2 Second address line</p> - <p>invoice_address_3 Third address line</p> - <p>invoice_tax_nr Your tax number</p> - <p>invoice_iban Your IBAN number</p> - <p>invoice_bic The BIC code of your bank</p> - <p>invoice_tel_nr Your telephone number</p> - <p>invoice_email Your email address</p> - <p>invoice_valuta The valuta symbol (will be placed in front of amounts). You can use a symbol like $ or a code like USD</p> - </td> - </tr> - </table> - </aside> - </div> - - <div class="row-fluid"> - <div class="span8 content class"> - <a id="constant_invoice_address_1" name="constant_invoice_address_1" class="anchor"></a> - <article id="constant_invoice_address_1" class="constant"> - <h3 class="">invoice_address_1</h3> - <pre class="signature">invoice_address_1</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_invoice_address_2" name="constant_invoice_address_2" class="anchor"></a> - <article id="constant_invoice_address_2" class="constant"> - <h3 class="">invoice_address_2</h3> - <pre class="signature">invoice_address_2</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_invoice_address_3" name="constant_invoice_address_3" class="anchor"></a> - <article id="constant_invoice_address_3" class="constant"> - <h3 class="">invoice_address_3</h3> - <pre class="signature">invoice_address_3</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_invoice_tax_nr" name="constant_invoice_tax_nr" class="anchor"></a> - <article id="constant_invoice_tax_nr" class="constant"> - <h3 class="">invoice_tax_nr</h3> - <pre class="signature">invoice_tax_nr</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_invoice_iban" name="constant_invoice_iban" class="anchor"></a> - <article id="constant_invoice_iban" class="constant"> - <h3 class="">invoice_iban</h3> - <pre class="signature">invoice_iban</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_invoice_bic" name="constant_invoice_bic" class="anchor"></a> - <article id="constant_invoice_bic" class="constant"> - <h3 class="">invoice_bic</h3> - <pre class="signature">invoice_bic</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_invoice_tel_nr" name="constant_invoice_tel_nr" class="anchor"></a> - <article id="constant_invoice_tel_nr" class="constant"> - <h3 class="">invoice_tel_nr</h3> - <pre class="signature">invoice_tel_nr</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_invoice_email" name="constant_invoice_email" class="anchor"></a> - <article id="constant_invoice_email" class="constant"> - <h3 class="">invoice_email</h3> - <pre class="signature">invoice_email</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_invoice_valuta" name="constant_invoice_valuta" class="anchor"></a> - <article id="constant_invoice_valuta" class="constant"> - <h3 class="">invoice_valuta</h3> - <pre class="signature">invoice_valuta</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_version" name="constant_version" class="anchor"></a> - <article id="constant_version" class="constant"> - <h3 class="">version</h3> - <pre class="signature">version</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> - <th> - const - </th> - <td> - <p>version Version of BusinessAdmin. Don't change this yourself!</p> - </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">constants.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/constants.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> diff --git a/docs/classes/contact.html b/docs/classes/contact.html deleted file mode 100644 index f0f8cd6..0000000 --- a/docs/classes/contact.html +++ /dev/null @@ -1,1365 +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-1762334130"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-1762334130" 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>contact</h1> - <p><em>An interface to the contact 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/contact.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/contact.html#method_getId" class="">getId()</a><br /> - <a href="../classes/contact.html#method_getClientId" class="">getClientId()</a><br /> - <a href="../classes/contact.html#method_getClient" class="">getClient()</a><br /> - <a href="../classes/contact.html#method_getName" class="">getName()</a><br /> - <a href="../classes/contact.html#method_setName" class="">setName()</a><br /> - <a href="../classes/contact.html#method_getEmail" class="">getEmail()</a><br /> - <a href="../classes/contact.html#method_setEmail" class="">setEmail()</a><br /> - <a href="../classes/contact.html#method_getAddress" class="">getAddress()</a><br /> - <a href="../classes/contact.html#method_setAddress" class="">setAddress()</a><br /> - <a href="../classes/contact.html#method_getAddress_2" class="">getAddress_2()</a><br /> - <a href="../classes/contact.html#method_setAddress_2" class="">setAddress_2()</a><br /> - <a href="../classes/contact.html#method_getPostalCode" class="">getPostalCode()</a><br /> - <a href="../classes/contact.html#method_setPostalCode" class="">setPostalCode()</a><br /> - <a href="../classes/contact.html#method_getCity" class="">getCity()</a><br /> - <a href="../classes/contact.html#method_setCity" class="">setCity()</a><br /> - <a href="../classes/contact.html#method_getCountry" class="">getCountry()</a><br /> - <a href="../classes/contact.html#method_setCountry" class="">setCountry()</a><br /> - <a href="../classes/contact.html#method_getLanguage" class="">getLanguage()</a><br /> - <a href="../classes/contact.html#method_setLanguage" class="">setLanguage()</a><br /> - <a href="../classes/contact.html#method_delete" class="">delete()</a><br /> - <a href="../classes/contact.html#method_createOffer" class="">createOffer()</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"> - <a href="../classes/contact.html#property_pdo" class="">$pdo</a><br /> - <a href="../classes/contact.html#property_id" class="">$id</a><br /> - <a href="../classes/contact.html#property_clientId" class="">$clientId</a><br /> - <a href="../classes/contact.html#property_name" class="">$name</a><br /> - <a href="../classes/contact.html#property_email" class="">$email</a><br /> - <a href="../classes/contact.html#property_address" class="">$address</a><br /> - <a href="../classes/contact.html#property_postal_code" class="">$postal_code</a><br /> - <a href="../classes/contact.html#property_city" class="">$city</a><br /> - <a href="../classes/contact.html#property_country" class="">$country</a><br /> - <a href="../classes/contact.html#property_language" class="">$language</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/contact.class.html"><div class="path-wrapper">contact.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">\contact</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="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_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_clientId" name="property_clientId" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$clientId</h3> - <pre class="signature">$clientId : \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_name" name="property_name" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$name</h3> - <pre class="signature">$name : \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_email" name="property_email" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$email</h3> - <pre class="signature">$email : \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_address" name="property_address" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$address</h3> - <pre class="signature">$address : \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_postal_code" name="property_postal_code" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$postal_code</h3> - <pre class="signature">$postal_code : \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_city" name="property_city" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$city</h3> - <pre class="signature">$city : \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_country" name="property_country" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$country</h3> - <pre class="signature">$country : \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_language" name="property_language" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$language</h3> - <pre class="signature">$language : \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 contact 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 contact 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 contact</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_getClientId" name="method_getClientId" class="anchor"></a> - <article class="method"> - <h3 class="public ">getClientId()</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;">getClientId() : integer</pre> - <p><em>Get the ID of the client that this contact 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_getClient" name="method_getClient" class="anchor"></a> - <article class="method"> - <h3 class="public ">getClient()</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;">getClient() : \client</pre> - <p><em>Get the client that this contact is linked to</em></p> - - - - - <h4>Returns</h4> - <a href="../classes/client.html">\client</a> - — <p>The client</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_getName" name="method_getName" class="anchor"></a> - <article class="method"> - <h3 class="public ">getName()</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;">getName() : string</pre> - <p><em>Get the name of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The name</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_setName" name="method_setName" class="anchor"></a> - <article class="method"> - <h3 class="public ">setName()</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;">setName(string <span class="argument">$name</span>) : boolean</pre> - <p><em>Set the name of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The new name for the contact</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_getEmail" name="method_getEmail" class="anchor"></a> - <article class="method"> - <h3 class="public ">getEmail()</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;">getEmail() : string</pre> - <p><em>Get the email of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The email</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_setEmail" name="method_setEmail" class="anchor"></a> - <article class="method"> - <h3 class="public ">setEmail()</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;">setEmail(string <span class="argument">$email</span>) : boolean</pre> - <p><em>Set the email of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$email </td> - <td><p>The new email for the contact</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_getAddress" name="method_getAddress" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAddress()</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;">getAddress() : string</pre> - <p><em>Get the first address line of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The address</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_setAddress" name="method_setAddress" class="anchor"></a> - <article class="method"> - <h3 class="public ">setAddress()</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;">setAddress(string <span class="argument">$address</span>) : boolean</pre> - <p><em>Set the first address line of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$address </td> - <td><p>The new address for the contact</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_getAddress_2" name="method_getAddress_2" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAddress_2()</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;">getAddress_2() : string</pre> - <p><em>Get the second address line of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The address</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_setAddress_2" name="method_setAddress_2" class="anchor"></a> - <article class="method"> - <h3 class="public ">setAddress_2()</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;">setAddress_2(string <span class="argument">$address_2</span>) : boolean</pre> - <p><em>Set the second address line of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$address_2 </td> - <td><p>The new address for the contact</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_getPostalCode" name="method_getPostalCode" class="anchor"></a> - <article class="method"> - <h3 class="public ">getPostalCode()</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;">getPostalCode() : string</pre> - <p><em>Get the postal_code of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The postal_code</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_setPostalCode" name="method_setPostalCode" class="anchor"></a> - <article class="method"> - <h3 class="public ">setPostalCode()</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;">setPostalCode( <span class="argument">$postal_code</span>) : boolean</pre> - <p><em>Set the postal code of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td></td> - <td>$postal_code </td> - <td><p>string The new postal code for the contact</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_getCity" name="method_getCity" class="anchor"></a> - <article class="method"> - <h3 class="public ">getCity()</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;">getCity() : string</pre> - <p><em>Get the city of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The city</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_setCity" name="method_setCity" class="anchor"></a> - <article class="method"> - <h3 class="public ">setCity()</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;">setCity(string <span class="argument">$city</span>) : boolean</pre> - <p><em>Set the city of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$city </td> - <td><p>The new city for the contact</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_getCountry" name="method_getCountry" class="anchor"></a> - <article class="method"> - <h3 class="public ">getCountry()</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;">getCountry() : string</pre> - <p><em>Get the country of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The country</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_setCountry" name="method_setCountry" class="anchor"></a> - <article class="method"> - <h3 class="public ">setCountry()</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;">setCountry(string <span class="argument">$country</span>) : boolean</pre> - <p><em>Set the country of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$country </td> - <td><p>The new country for the contact</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_getLanguage" name="method_getLanguage" class="anchor"></a> - <article class="method"> - <h3 class="public ">getLanguage()</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;">getLanguage() : string</pre> - <p><em>Get the language of the contact</em></p> - - - - - <h4>Returns</h4> - string - — <p>The language</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_setLanguage" name="method_setLanguage" class="anchor"></a> - <article class="method"> - <h3 class="public ">setLanguage()</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;">setLanguage(string <span class="argument">$language</span>) : boolean</pre> - <p><em>Set the language of the contact</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$language </td> - <td><p>The new language for the contact</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_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 contact from the database</em></p> - <p>If this doesn't succeed (i.e. false is returned), that means the contact 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 class="row-fluid"> - <div class="span8 content class"> - <a id="method_createOffer" name="method_createOffer" class="anchor"></a> - <article class="method"> - <h3 class="public ">createOffer()</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;">createOffer() : \offer</pre> - <p><em>Make a new offer for this contact</em></p> - - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - <dt>\Exception</dt> - <dd><p>If there was a problem with the input</p></dd> - </dl> - - <h4>Returns</h4> - <a href="../classes/offer.html">\offer</a> - — <p>A new instance of the offer class containing the new 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> - </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">contact.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/contact.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> diff --git a/docs/classes/correspondence.html b/docs/classes/correspondence.html deleted file mode 100644 index c5b3db3..0000000 --- a/docs/classes/correspondence.html +++ /dev/null @@ -1,682 +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-637080709"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-637080709" 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>correspondence</h1> - <p><em>An extension of FPDF to generate personalized correspondence PDFs</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/correspondence.html#method__" class="">_()</a><br /> - <a href="../classes/correspondence.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/correspondence.html#method_SetLangauge" class="">SetLangauge()</a><br /> - <a href="../classes/correspondence.html#method_SetContact" class="">SetContact()</a><br /> - <a href="../classes/correspondence.html#method_CorrespondenceHeader" class="">CorrespondenceHeader()</a><br /> - <a href="../classes/correspondence.html#method__putinfo" class="">_putinfo()</a><br /> - </section> - <section class="span4"> - <a href="../classes/correspondence.html#property_contact" class="">$contact</a><br /> - <a href="../classes/correspondence.html#property_language" class="">$language</a><br /> - </section> - <section class="span4"> - <a href="../classes/correspondence.html#constant_HEAD_RED" class="">HEAD_RED</a><br /> - <a href="../classes/correspondence.html#constant_HEAD_GREEN" class="">HEAD_GREEN</a><br /> - <a href="../classes/correspondence.html#constant_HEAD_BLUE" class="">HEAD_BLUE</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/correspondence.html#property_translations" class="">$translations</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/correspondence.class.html"><div class="path-wrapper">correspondence.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">\FPDF</div> - <div class="namespace-wrapper">\correspondence</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_HEAD_RED" name="constant_HEAD_RED" class="anchor"></a> - <article id="constant_HEAD_RED" class="constant"> - <h3 class="">HEAD_RED</h3> - <pre class="signature">HEAD_RED</pre> - <p><em>If you'd want, you could change these constants to encode an RGB colour for headings in your PDFs</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_HEAD_GREEN" name="constant_HEAD_GREEN" class="anchor"></a> - <article id="constant_HEAD_GREEN" class="constant"> - <h3 class="">HEAD_GREEN</h3> - <pre class="signature">HEAD_GREEN</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_HEAD_BLUE" name="constant_HEAD_BLUE" class="anchor"></a> - <article id="constant_HEAD_BLUE" class="constant"> - <h3 class="">HEAD_BLUE</h3> - <pre class="signature">HEAD_BLUE</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_contact" name="property_contact" class="anchor"></a> - <article class="property"> - <h3 class="public ">$contact</h3> - <pre class="signature">$contact : </pre> - <p><em></em></p> - - - <h4>Type</h4> - - — Holds the contact this correspondence will be sent to </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_language" name="property_language" class="anchor"></a> - <article class="property"> - <h3 class="public ">$language</h3> - <pre class="signature">$language : </pre> - <p><em></em></p> - - - <h4>Type</h4> - - — Holds the contact this correspondence will be sent to </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_translations" name="property_translations" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$translations</h3> - <pre class="signature">$translations : </pre> - <p><em>Array holding the translations</em></p> - - - <h4>Type</h4> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/correspondence.html#method__"><span class="namespace-wrapper">A function to translate</span></a></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__" name="method__" class="anchor"></a> - <article class="method"> - <h3 class="public ">_()</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;">_(string <span class="argument">$key</span>) : string</pre> - <p><em>Translate a string</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$key </td> - <td><p>The string to translate</p></td> - </tr> - </table> - - - <h4>Returns</h4> - string - — <p>The translated string</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/correspondence.html#property_translations"><span class="namespace-wrapper">The array holding the translations</span></a></dd> - </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___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(string <span class="argument">$orientation = 'P'</span>, string <span class="argument">$unit = 'mm'</span>, string <span class="argument">$size = 'A4'</span>) </pre> - <p><em>Create a new PDF</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$orientation </td> - <td><p>See the FPDF class specs</p></td> - </tr> - <tr> - <td>string</td> - <td>$unit </td> - <td><p>See the FPDF class specs</p></td> - </tr> - <tr> - <td>string</td> - <td>$size </td> - <td><p>See the FPDF class specs</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_SetLangauge" name="method_SetLangauge" class="anchor"></a> - <article class="method"> - <h3 class="public ">SetLangauge()</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;">SetLangauge(string <span class="argument">$lang</span>) </pre> - <p><em>Set the language of the correspondence (used to translate stuff)</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$lang </td> - <td><p>The language, two letter code ('en', 'nl', ...)</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_SetContact" name="method_SetContact" class="anchor"></a> - <article class="method"> - <h3 class="public ">SetContact()</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;">SetContact(\contact <span class="argument">$contact</span>) </pre> - <p><em>Set the contact to whom this correspondence will be sent (used for the address)</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td><a href="../classes/contact.html">\contact</a></td> - <td>$contact </td> - <td><p>The contact</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_CorrespondenceHeader" name="method_CorrespondenceHeader" class="anchor"></a> - <article class="method"> - <h3 class="public ">CorrespondenceHeader()</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;">CorrespondenceHeader() </pre> - <p><em>Makes a header with your details and the address of the contact</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__putinfo" name="method__putinfo" class="anchor"></a> - <article class="method"> - <h3 class="public ">_putinfo()</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;">_putinfo() </pre> - <p><em>Put PDF information</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> - </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">correspondence.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/correspondence.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> diff --git a/docs/classes/file.html b/docs/classes/file.html deleted file mode 100644 index 09e824e..0000000 --- a/docs/classes/file.html +++ /dev/null @@ -1,611 +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-1173319595"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-1173319595" 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>file</h1> - <p><em>An interface to the file 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/file.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/file.html#method_getId" class="">getId()</a><br /> - <a href="../classes/file.html#method_getFilename" class="">getFilename()</a><br /> - <a href="../classes/file.html#method_getFilenamePath" class="">getFilenamePath()</a><br /> - <a href="../classes/file.html#method_getFilenameURI" class="">getFilenameURI()</a><br /> - <a href="../classes/file.html#method_delete" class="">delete()</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"> - <a href="../classes/file.html#property_pdo" class="">$pdo</a><br /> - <a href="../classes/file.html#property_id" class="">$id</a><br /> - <a href="../classes/file.html#property_filename" class="">$filename</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/file.class.html"><div class="path-wrapper">file.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">\file</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="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_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_filename" name="property_filename" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$filename</h3> - <pre class="signature">$filename : \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 file 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 file 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 file</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_getFilename" name="method_getFilename" class="anchor"></a> - <article class="method"> - <h3 class="public ">getFilename()</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;">getFilename() : string</pre> - <p><em>Get the relative filename of the file</em></p> - - - - - <h4>Returns</h4> - string - — <p>The filename</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href=""><span class="namespace-wrapper">To get the full internal path to the file</span></a></dd> - <dd><a href=""><span class="namespace-wrapper">To get the full external path to the file</span></a></dd> - </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_getFilenamePath" name="method_getFilenamePath" class="anchor"></a> - <article class="method"> - <h3 class="public ">getFilenamePath()</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;">getFilenamePath() : string</pre> - <p><em>Get the full internal path to the file</em></p> - - - - - <h4>Returns</h4> - string - — <p>The path</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href=""><span class="namespace-wrapper">To get the relative filename</span></a></dd> - <dd><a href=""><span class="namespace-wrapper">To get the full external path to the file</span></a></dd> - </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_getFilenameURI" name="method_getFilenameURI" class="anchor"></a> - <article class="method"> - <h3 class="public ">getFilenameURI()</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;">getFilenameURI() : string</pre> - <p><em>Get the full external path to the file</em></p> - - - - - <h4>Returns</h4> - string - — <p>The URI</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href=""><span class="namespace-wrapper">To get the relative filename</span></a></dd> - <dd><a href=""><span class="namespace-wrapper">To get the full internal path to the file</span></a></dd> - </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>Move this file to the trash and delete all records for it</em></p> - <p>Physically, this moves the file to a trash folder -Then, the file will be removed from the file table in the database -Any appendices linking to this file with fileId will have fileId NULL -Any offers linking to this file with invoice_fileId will have invoice_fileId NULL</p> - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If there's something 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">file.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/file.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> diff --git a/docs/classes/offer.html b/docs/classes/offer.html deleted file mode 100644 index 996eb5a..0000000 --- a/docs/classes/offer.html +++ /dev/null @@ -1,1491 +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-397689466"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-397689466" 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>offer</h1> - <p><em>An interface to the offer 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/offer.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/offer.html#method_getId" class="">getId()</a><br /> - <a href="../classes/offer.html#method_getContactId" class="">getContactId()</a><br /> - <a href="../classes/offer.html#method_getContact" class="">getContact()</a><br /> - <a href="../classes/offer.html#method_getAssignmentIds" class="">getAssignmentIds()</a><br /> - <a href="../classes/offer.html#method_getAssignments" class="">getAssignments()</a><br /> - <a href="../classes/offer.html#method_getStartDate" class="">getStartDate()</a><br /> - <a href="../classes/offer.html#method_setStartDate" class="">setStartDate()</a><br /> - <a href="../classes/offer.html#method_getEndDate" class="">getEndDate()</a><br /> - <a href="../classes/offer.html#method_setEndDate" class="">setEndDate()</a><br /> - <a href="../classes/offer.html#method_getInvoiceDate" class="">getInvoiceDate()</a><br /> - <a href="../classes/offer.html#method_setInvoiceDate" class="">setInvoiceDate()</a><br /> - <a href="../classes/offer.html#method_getPaymentReceived" class="">getPaymentReceived()</a><br /> - <a href="../classes/offer.html#method_setPaymentReceived" class="">setPaymentReceived()</a><br /> - <a href="../classes/offer.html#method_isAccepted" class="">isAccepted()</a><br /> - <a href="../classes/offer.html#method_toggleAccepted" class="">toggleAccepted()</a><br /> - <a href="../classes/offer.html#method_getInvoiceFileId" class="">getInvoiceFileId()</a><br /> - <a href="../classes/offer.html#method_getInvoiceFile" class="">getInvoiceFile()</a><br /> - <a href="../classes/offer.html#method_setInvoiceFileId" class="">setInvoiceFileId()</a><br /> - <a href="../classes/offer.html#method_calculate" class="">calculate()</a><br /> - <a href="../classes/offer.html#method_delete" class="">delete()</a><br /> - <a href="../classes/offer.html#method_createAssignment" class="">createAssignment()</a><br /> - <a href="../classes/offer.html#method_generateInvoice" class="">generateInvoice()</a><br /> - </section> - <section class="span4"> - <em>No public properties found</em> - </section> - <section class="span4"> - <a href="../classes/offer.html#constant_SUBTOTAL" class="">SUBTOTAL</a><br /> - <a href="../classes/offer.html#constant_VAT" class="">VAT</a><br /> - <a href="../classes/offer.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/offer.html#property_pdo" class="">$pdo</a><br /> - <a href="../classes/offer.html#property_id" class="">$id</a><br /> - <a href="../classes/offer.html#property_contactId" class="">$contactId</a><br /> - <a href="../classes/offer.html#property_start_date" class="">$start_date</a><br /> - <a href="../classes/offer.html#property_end_date" class="">$end_date</a><br /> - <a href="../classes/offer.html#property_invoice_date" class="">$invoice_date</a><br /> - <a href="../classes/offer.html#property_accepted" class="">$accepted</a><br /> - <a href="../classes/offer.html#property_invoice_fileId" class="">$invoice_fileId</a><br /> - <a href="../classes/offer.html#property_payment_received" class="">$payment_received</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/offer.class.html"><div class="path-wrapper">offer.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">\offer</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_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_contactId" name="property_contactId" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$contactId</h3> - <pre class="signature">$contactId : \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_start_date" name="property_start_date" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$start_date</h3> - <pre class="signature">$start_date : \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_end_date" name="property_end_date" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$end_date</h3> - <pre class="signature">$end_date : \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_invoice_date" name="property_invoice_date" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$invoice_date</h3> - <pre class="signature">$invoice_date : \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_accepted" name="property_accepted" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$accepted</h3> - <pre class="signature">$accepted : \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_invoice_fileId" name="property_invoice_fileId" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$invoice_fileId</h3> - <pre class="signature">$invoice_fileId : \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_payment_received" name="property_payment_received" class="anchor"></a> - <article class="property"> - <h3 class="protected ">$payment_received</h3> - <pre class="signature">$payment_received : \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> - <p>Blah</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 offer 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 offer 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 offer</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_getContactId" name="method_getContactId" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContactId()</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;">getContactId() : integer</pre> - <p><em>Get the ID of the contact that this offer 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> - <dt>See also</dt> - <dd><a href="../classes/offer.html#method_getContact"><span class="namespace-wrapper">This function returns the contact as an instance of the object class</span></a></dd> - </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_getContact" name="method_getContact" class="anchor"></a> - <article class="method"> - <h3 class="public ">getContact()</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;">getContact() : \contact</pre> - <p><em>Get the contact that this offer is linked to</em></p> - - - - - <h4>Returns</h4> - <a href="../classes/contact.html">\contact</a> - — <p>The contact</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/offer.html#method_getContactId"><span class="namespace-wrapper">This function returns just the id</span></a></dd> - </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_getAssignmentIds" name="method_getAssignmentIds" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAssignmentIds()</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;">getAssignmentIds() : array<mixed,integer></pre> - <p><em>Get all assignment ids for this offer</em></p> - - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>Is something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,integer> - — <p>The ids</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/offer.html#method_getAssignments"><span class="namespace-wrapper">This funtion returns instances of the assignment class instead of just the ids</span></a></dd> - </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_getAssignments" name="method_getAssignments" class="anchor"></a> - <article class="method"> - <h3 class="public ">getAssignments()</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;">getAssignments() : array<mixed,\assignment></pre> - <p><em>Get all assignments for this offer</em></p> - - - - <h4>Throws</h4> - <dl> - <dt>\PDOException</dt> - <dd><p>If something went wrong with the database</p></dd> - </dl> - - <h4>Returns</h4> - array<mixed,<a href="../classes/assignment.html">\assignment</a>> - — <p>An array indexed by id of instances of the assignment class</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href="../classes/offer.html#method_getAssignmentIds"><span class="namespace-wrapper">This function returns just the ids of the assignments, and not instances of the assignment class</span></a></dd> - </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_getStartDate" name="method_getStartDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">getStartDate()</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;">getStartDate() : integer</pre> - <p><em>Get the start date of the assignment</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The start date as a UNIX timestamp</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_setStartDate" name="method_setStartDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">setStartDate()</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;">setStartDate(integer <span class="argument">$start_date</span>) : boolean</pre> - <p><em>Set the start date of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$start_date </td> - <td><p>The new start date for the assignment as a UNIX timestamp</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_getEndDate" name="method_getEndDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">getEndDate()</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;">getEndDate() : integer</pre> - <p><em>Get the end date of the assignment</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The end date as a UNIX timestamp</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_setEndDate" name="method_setEndDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">setEndDate()</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;">setEndDate(integer <span class="argument">$end_date</span>) : boolean</pre> - <p><em>Set the end date of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$end_date </td> - <td><p>The new end date for the assignment as a UNIX timestamp</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_getInvoiceDate" name="method_getInvoiceDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">getInvoiceDate()</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;">getInvoiceDate() : integer</pre> - <p><em>Get the invoice date of the assignment</em></p> - - - - - <h4>Returns</h4> - integer - — <p>The invoice date as a UNIX timestamp</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_setInvoiceDate" name="method_setInvoiceDate" class="anchor"></a> - <article class="method"> - <h3 class="public ">setInvoiceDate()</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;">setInvoiceDate(integer <span class="argument">$invoice_date</span>) : boolean</pre> - <p><em>Set the invoice date of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$invoice_date </td> - <td><p>The new invoice date for the assignment as a UNIX timestamp</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_getPaymentReceived" name="method_getPaymentReceived" class="anchor"></a> - <article class="method"> - <h3 class="public ">getPaymentReceived()</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;">getPaymentReceived() : integer|null</pre> - <p><em>Get the date the payment was received</em></p> - - - - - <h4>Returns</h4> - integer|null - — <p>The date as a UNIX timestamp, or null if it wasn't received yet</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_setPaymentReceived" name="method_setPaymentReceived" class="anchor"></a> - <article class="method"> - <h3 class="public ">setPaymentReceived()</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;">setPaymentReceived(integer <span class="argument">$payment_received</span>) : boolean</pre> - <p><em>Set the payment received date of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$payment_received </td> - <td><p>The new date the payment has been received as a UNIX timestamp</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_isAccepted" name="method_isAccepted" class="anchor"></a> - <article class="method"> - <h3 class="public ">isAccepted()</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;">isAccepted() : boolean</pre> - <p><em>Check if the offer is accepted or not</em></p> - - - - - <h4>Returns</h4> - boolean - — <p>True if the offer is accepted, false if 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_toggleAccepted" name="method_toggleAccepted" class="anchor"></a> - <article class="method"> - <h3 class="public ">toggleAccepted()</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;">toggleAccepted() : boolean</pre> - <p><em>Toggle the `accepted' status of the offer</em></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 class="row-fluid"> - <div class="span8 content class"> - <a id="method_getInvoiceFileId" name="method_getInvoiceFileId" class="anchor"></a> - <article class="method"> - <h3 class="public ">getInvoiceFileId()</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;">getInvoiceFileId() : integer</pre> - <p><em>Get the ID of the file that the invoice of this offer 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> - <dt>See also</dt> - <dd><a href="../classes/offer.html#method_getInvoiceFile"><span class="namespace-wrapper">This function returns the file as an instance of the file class</span></a></dd> - </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_getInvoiceFile" name="method_getInvoiceFile" class="anchor"></a> - <article class="method"> - <h3 class="public ">getInvoiceFile()</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;">getInvoiceFile() : \file|null</pre> - <p><em>Get the file that the invoice this offer is linked to</em></p> - - - - - <h4>Returns</h4> - <a href="../classes/file.html">\file</a>|null - — <p>The file, or null if it doesn't exist</p> - - </article> - </div> - <aside class="span4 detailsbar"> - <h1><i class="icon-arrow-down"></i></h1> - <dl> - <dt>See also</dt> - <dd><a href=""><span class="namespace-wrapper">This function returns just the id</span></a></dd> - </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_setInvoiceFileId" name="method_setInvoiceFileId" class="anchor"></a> - <article class="method"> - <h3 class="public ">setInvoiceFileId()</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;">setInvoiceFileId(integer <span class="argument">$invoice_fileId</span>) : boolean</pre> - <p><em>Set the invoice file id of the assignment</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$invoice_fileId </td> - <td><p>The new invoice file id 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 a handy number about the invoice</em></p> - <p>Subtotal: the sum of the prices of the assignments excl. VAT</p> -<p>VAT: the sum of all the VAT from all the assignments</p> -<p>Total: the sum of subtotal and total</p> - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$what </td> - <td><p>Any of offer::SUBTOTAL, offer::VAT and offer::TOTAL</p></td> - </tr> - <tr> - <td>integer</td> - <td>$round </td> - <td><p>How many decimals to round the result 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 to $round decimals, or false on incorrect input</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 offer from the database</em></p> - <p>If this doesn't succeed (i.e. false is returned), that means the offer 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 class="row-fluid"> - <div class="span8 content class"> - <a id="method_createAssignment" name="method_createAssignment" class="anchor"></a> - <article class="method"> - <h3 class="public ">createAssignment()</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;">createAssignment(string <span class="argument">$title</span>, string <span class="argument">$description</span>, integer <span class="argument">$hours</span>, float <span class="argument">$price_per_hour</span>, float <span class="argument">$vat</span>) : \assignment</pre> - <p><em>Make a new assignment linked to this order</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$title </td> - <td><p>The title for this assignment</p></td> - </tr> - <tr> - <td>string</td> - <td>$description </td> - <td><p>The description for this assignment</p></td> - </tr> - <tr> - <td>integer</td> - <td>$hours </td> - <td><p>The amount of hours to work on this assignment</p></td> - </tr> - <tr> - <td>float</td> - <td>$price_per_hour </td> - <td><p>The price per hour on this assignment</p></td> - </tr> - <tr> - <td>float</td> - <td>$vat </td> - <td><p>The VAT percentage (so, 21 for 21%, not 0.21!)</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 there was a problem with the input</p></dd> - </dl> - - <h4>Returns</h4> - <a href="../classes/assignment.html">\assignment</a> - — <p>A new instance of the assignment class containing the new assignment</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_generateInvoice" name="method_generateInvoice" class="anchor"></a> - <article class="method"> - <h3 class="public ">generateInvoice()</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;">generateInvoice() : \file</pre> - <p><em>Generate a PDF invoice</em></p> - - - - <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 file could not be written or an other error occured</p></dd> - </dl> - - <h4>Returns</h4> - <a href="../classes/file.html">\file</a> - — <p>An instance of the file class with information on the invoice file generated</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">offer.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/offer.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> diff --git a/docs/classes/response.html b/docs/classes/response.html deleted file mode 100644 index 2269d8a..0000000 --- a/docs/classes/response.html +++ /dev/null @@ -1,618 +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-1372822484"></a> - <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> - </div> - <div id="namespace-1372822484" 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>response</h1> - <p><em>Provides a standard to base all responses to be called with AJAX on</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/response.html#method___construct" class="">__construct()</a><br /> - <a href="../classes/response.html#method___set" class="">__set()</a><br /> - <a href="../classes/response.html#method___get" class="">__get()</a><br /> - <a href="../classes/response.html#method___isset" class="">__isset()</a><br /> - <a href="../classes/response.html#method___unset" class="">__unset()</a><br /> - <a href="../classes/response.html#method_http_response_code" class="">http_response_code()</a><br /> - <a href="../classes/response.html#method_getJson" class="">getJson()</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"> - <em>No private methods found</em> - </section> - <section class="span4"> - <a href="../classes/response.html#property_response" class="">$response</a><br /> - <a href="../classes/response.html#property_http_response_code" class="">$http_response_code</a><br /> - </section> - <section class="span4"> - <em>N/A</em> - </section> - </section> - </section> - </div> - <aside class="span4 detailsbar"> - - - <dl> - <dt>File</dt> - <dd><a href="../files/response.class.html"><div class="path-wrapper">response.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">\response</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="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_response" name="property_response" class="anchor"></a> - <article class="property"> - <h3 class="private ">$response</h3> - <pre class="signature">$response : </pre> - <p><em>The variable to keep the response in until output</em></p> - - - <h4>Type</h4> - - </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_http_response_code" name="property_http_response_code" class="anchor"></a> - <article class="property"> - <h3 class="private ">$http_response_code</h3> - <pre class="signature">$http_response_code : </pre> - <p><em>The variable to keep the HTTP response code in until output</em></p> - - - <h4>Type</h4> - - </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() </pre> - <p><em>Create a new instance</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___set" name="method___set" class="anchor"></a> - <article class="method"> - <h3 class="public ">__set()</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(string <span class="argument">$name</span>, string <span class="argument">$value</span>) </pre> - <p><em>Set a variable of the response</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The name of the variable to set</p></td> - </tr> - <tr> - <td>string</td> - <td>$value </td> - <td><p>The (new) value for the variable</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___get" name="method___get" class="anchor"></a> - <article class="method"> - <h3 class="public ">__get()</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(string <span class="argument">$name</span>) : mixed</pre> - <p><em>Get a variable of the response</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The name of the variable to get</p></td> - </tr> - </table> - - - <h4>Returns</h4> - mixed - — <p>The value of the variable</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___isset" name="method___isset" class="anchor"></a> - <article class="method"> - <h3 class="public ">__isset()</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;">__isset(string <span class="argument">$name</span>) : boolean</pre> - <p><em>Check if a variable of the response is set</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The name of the variable to check</p></td> - </tr> - </table> - - - <h4>Returns</h4> - boolean - — <p>True if the variable exists, false otherwise</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___unset" name="method___unset" class="anchor"></a> - <article class="method"> - <h3 class="public ">__unset()</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;">__unset(string <span class="argument">$name</span>) </pre> - <p><em>Unset a variable of the response</em></p> - - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>string</td> - <td>$name </td> - <td><p>The variable to unset</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_http_response_code" name="method_http_response_code" class="anchor"></a> - <article class="method"> - <h3 class="public ">http_response_code()</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;">http_response_code(integer <span class="argument">$code = null</span>) : integer|boolean</pre> - <p><em>Get or set the HTTP response code</em></p> - <p>If a parameter is provided, it is used as the new HTTP response code, and a bool is returned for success or failure. Otherwise, the current one is returned.</p> - - <h4>Parameters</h4> - <table class="table table-condensed table-hover"> - <tr> - <td>integer</td> - <td>$code </td> - <td><p>The new code</p></td> - </tr> - </table> - - - <h4>Returns</h4> - integer|boolean - — <p>True on successful change, false on unsuccesful change, int when the current code is returned</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_getJson" name="method_getJson" class="anchor"></a> - <article class="method"> - <h3 class="public ">getJson()</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;">getJson() : string</pre> - <p><em>Output the response in json</em></p> - - - - - <h4>Returns</h4> - string - — <p>The response in json format</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">response.class.php</h3> - </div> - <div class="modal-body"> - <pre data-src="../files/response.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> |