diff options
Diffstat (limited to 'docs/classes/client.html')
| -rw-r--r-- | docs/classes/client.html | 731 |
1 files changed, 0 insertions, 731 deletions
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> |