aboutsummaryrefslogtreecommitdiff
path: root/docs/files/client.class.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/files/client.class.html
parentAdded some documentation; added Makefile for generating docs with phpdoc (diff)
Added documentation
Diffstat (limited to 'docs/files/client.class.html')
-rw-r--r--docs/files/client.class.html280
1 files changed, 280 insertions, 0 deletions
diff --git a/docs/files/client.class.html b/docs/files/client.class.html
new file mode 100644
index 0000000..9a1ca8c
--- /dev/null
+++ b/docs/files/client.class.html
@@ -0,0 +1,280 @@
+<!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-970143172"></a>
+ <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
+ </div>
+ <div id="namespace-970143172" 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 file">
+ <nav>
+ </nav>
+
+ <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
+ <h1><small></small>client.class.php</h1>
+ <p><em>Provides the client class, an interface to the client table in the database</em></p>
+
+
+
+
+ <h2>Classes</h2>
+ <table class="table table-hover">
+ <tr>
+ <td><a href="../classes/client.html">client</a></td>
+ <td><em>An interface to the client table in the database</em></td>
+ </tr>
+ </table>
+ </div>
+
+ <aside class="span4 detailsbar">
+ <dl>
+ <dt>Package</dt>
+ <dd><div class="namespace-wrapper">\Default</div></dd>
+
+
+ </dl>
+ <h2>Tags</h2>
+ <table class="table table-condensed">
+ <tr>
+ <th>
+ author
+ </th>
+ <td>
+ <p>Camil Staps</p>
+<p>BusinessAdmin: administrative software for small companies
+Copyright (C) 2015 Camil Staps (ViviSoft)</p>
+<p>This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.</p>
+<p>This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.</p>
+<p>You should have received a copy of the GNU General Public License
+along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</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"></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 7th, 2015 at 21:04.
+ </section>
+ </section>
+ </section>
+ </footer>
+</div>
+
+</body>
+</html>
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-15 10:37:43 +0000