aboutsummaryrefslogtreecommitdiff
path: root/docs/classes/BusinessAdmin.html
diff options
context:
space:
mode:
authorCamil Staps2015-02-07 21:06:17 +0100
committerCamil Staps2015-02-07 21:06:17 +0100
commit29955216d69ca08b69afe1ace71151839049c045 (patch)
tree48a085e24cf1e65677bbace195017f118292ecc2 /docs/classes/BusinessAdmin.html
parentAdded some documentation; added Makefile for generating docs with phpdoc (diff)
Added documentation
Diffstat (limited to 'docs/classes/BusinessAdmin.html')
-rw-r--r--docs/classes/BusinessAdmin.html854
1 files changed, 854 insertions, 0 deletions
diff --git a/docs/classes/BusinessAdmin.html b/docs/classes/BusinessAdmin.html
new file mode 100644
index 0000000..c5da975
--- /dev/null
+++ b/docs/classes/BusinessAdmin.html
@@ -0,0 +1,854 @@
+<!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>&#160;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>&#160;Errors <span class="label label-info pull-right">50</span>
+ </a>
+ </li>
+ <li>
+ <a href="../reports/markers.html">
+ <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</span>
+ </a>
+ </li>
+ <li>
+ <a href="../reports/deprecated.html">
+ <i class="icon-list-alt"></i>&#160;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&#160;&#160;<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-102012100"></a>
+ <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
+ </div>
+ <div id="namespace-102012100" 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&lt;mixed,integer&gt;</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>Is something went wrong with the database</p></dd>
+ </dl>
+
+ <h4>Returns</h4>
+ array&lt;mixed,integer&gt;
+ &mdash; <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&lt;mixed,\client&gt;</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&lt;mixed,<a href="../classes/client.html">\client</a>&gt;
+ &mdash; <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&lt;mixed,integer&gt;</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&lt;mixed,integer&gt;
+ &mdash; <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&lt;mixed,\contact&gt;</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&lt;mixed,<a href="../classes/contact.html">\contact</a>&gt;
+ &mdash; <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&lt;mixed,string&gt; <span class="argument">$where = array()</span>) : array&lt;mixed,integer&gt;</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&lt;mixed,string&gt;</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&lt;mixed,integer&gt;
+ &mdash; <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&lt;mixed,string&gt; <span class="argument">$where = array()</span>) : array&lt;mixed,\offer&gt;</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&lt;mixed,string&gt;</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&lt;mixed,<a href="../classes/offer.html">\offer</a>&gt;
+ &mdash; <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&lt;mixed,integer&gt;</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&lt;mixed,integer&gt;
+ &mdash; <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&lt;mixed,\assignment&gt;</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&lt;mixed,<a href="../classes/assignment.html">\assignment</a>&gt;
+ &mdash; <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
+ &mdash; <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>
+ &mdash; <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
+ &mdash; <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 7th, 2015 at 21:04.
+ </section>
+ </section>
+ </section>
+ </footer>
+</div>
+
+</body>
+</html>