mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-01-27 00:33:34 +00:00
111 lines
6.4 KiB
HTML
111 lines
6.4 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs for page AwlDatabase.php</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
|
|
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/AwlDatabase.php</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-classes">Classes</a>
|
|
| <a href="#sec-includes">Includes</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">AwlDatabase query/statement class and associated functions</p>
|
|
<p class="description"><p>This subpackage provides some functions that are useful around database activity and a AwlDialect, AwlDatabase and AwlStatement classes to simplify handling of database queries and provide some access for a limited ability to handle varying database dialects.</p><p>The class is intended to be a very lightweight wrapper with some features that have proved useful in developing and debugging web-based applications: <ul><li>All queries are timed, and an expected time can be provided.</li><li>Parameters replaced into the SQL will be escaped correctly in order to
|
|
minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
|
|
be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
|
|
particular sets of queries.</li><li>Simple syntax for iterating through a result set.</li></ul> See http://wiki.davical.org/w/AwlDatabase for design and usage information.</p><p>If not already connected, AwlDatabase will attempt to connect to the database, successively applying connection parameters from the array in $c->pdo_connect.</p><p>We will die if the database is not currently connected and we fail to find a working connection.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
|
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
|
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-classes"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Classes</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Classes</span>
|
|
| <a href="#sec-includes">Includes</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
|
<tr>
|
|
<th class="class-table-header">Class</th>
|
|
<th class="class-table-header">Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
|
<img src="../../media/images/Class.png"
|
|
alt=" class"
|
|
title=" class"/>
|
|
<a href="../../awl/AwlDatabase/AwlDatabase.html">AwlDatabase</a>
|
|
</td>
|
|
<td>
|
|
Typically there will only be a single instance of the database level class in an application.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-includes"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Includes</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-classes">Classes</a>
|
|
| <span class="disabled">Includes</span>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="_AwlDBDialect_php"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Page.png" alt=" " />
|
|
<span class="include-title">
|
|
<span class="include-type">require</span>
|
|
(<span class="include-name"><a href="../../awl/AwlDatabase/_inc---AwlDBDialect.php.html">'AwlDBDialect.php'</a></span>)
|
|
(line <span class="line-number">37</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">AwlDatabase query/statement class and associated functions</p>
|
|
<p class="description"><p>This subpackage provides some functions that are useful around database activity and a AwlDialect, AwlDatabase and AwlStatement classes to simplify handling of database queries and provide some access for a limited ability to handle varying database dialects.</p><p>The class is intended to be a very lightweight wrapper with some features that have proved useful in developing and debugging web-based applications: <ul><li>All queries are timed, and an expected time can be provided.</li><li>Parameters replaced into the SQL will be escaped correctly in order to
|
|
minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
|
|
be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
|
|
particular sets of queries.</li><li>Simple syntax for iterating through a result set.</li></ul> See http://wiki.davical.org/w/AwlDatabase for design and usage information.</p><p>If not already connected, AwlDatabase will attempt to connect to the database, successively applying connection parameters from the array in $c->pdo_connect.</p><p>We will die if the database is not currently connected and we fail to find a working connection.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
|
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
|
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Thu, 24 Dec 2009 22:09:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|