diff options
| author | Camil Staps | 2015-02-15 10:15:59 +0100 |
|---|---|---|
| committer | Camil Staps | 2015-02-15 10:15:59 +0100 |
| commit | a22425e8c781c1b5e8a3707ea67736673d6bc797 (patch) | |
| tree | d24316a0fb0e96dc16311cfd4e479ae27f1cf498 /docs/classes/contact.html | |
| parent | fixed bug in the top navigation bar (diff) | |
Updated makefile, removed docs (users can compile it themselves if they want)
Diffstat (limited to 'docs/classes/contact.html')
| -rw-r--r-- | docs/classes/contact.html | 1365 |
1 files changed, 0 insertions, 1365 deletions
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> |