docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3   <html xmlns="http://www.w3.org/1999/xhtml">
   4                 <head>
   5                         <!-- template designed by Marco Von Ballmoos -->
   6                         <title>Docs for page AwlDatabase.php</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9                 </head>
  10                 <body>
  11                         <div class="page-body">
  12 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/AwlDatabase.php</h2>
  13
  14 <a name="sec-description"></a>
  15 <div class="info-box">
  16         <div class="info-box-title">Description</div>
  17         <div class="nav-bar">
  18                                         <span class="disabled">Description</span> |
  19                                                         <a href="#sec-classes">Classes</a>
  20                         |                                                       <a href="#sec-includes">Includes</a>
  21                                                                                                 </div>
  22         <div class="info-box-body">
  23                 <!-- ========== Info from phpDoc block ========= -->
  24 <p class="short-description">AwlDatabase query/statement class and associated functions</p>
  25 <p class="description"><p>This subpackage provides some functions that are useful around database  activity and a AwlDBDialect, 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
  26     minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
  27     be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
  28     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-&gt;pdo_connect.</p><p>We will die if the database is not currently connected and we fail to find  a working connection.</p></p>
  29         <ul class="tags">
  30                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
  31                                 <li><span class="field">copyright:</span> Morphoss Ltd</li>
  32                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
  33                         </ul>
  34
  35                         </div>
  36 </div>
  37
  38         <a name="sec-classes"></a>
  39         <div class="info-box">
  40                 <div class="info-box-title">Classes</div>
  41                 <div class="nav-bar">
  42                         <a href="#sec-description">Description</a> |
  43                         <span class="disabled">Classes</span>
  44                         |                                                       <a href="#sec-includes">Includes</a>
  45                                                                                                                                                 </div>
  46                 <div class="info-box-body">
  47                         <table cellpadding="2" cellspacing="0" class="class-table">
  48                                 <tr>
  49                                         <th class="class-table-header">Class</th>
  50                                         <th class="class-table-header">Description</th>
  51                                 </tr>
  52                                                                 <tr>
  53                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
  54                                                 <img src="../../media/images/Class.png"
  55                                                                  alt=" class"
  56                                                                  title=" class"/>
  57                                                 <a href="../../awl/AwlDatabase/AwlDatabase.html">AwlDatabase</a>
  58                                         </td>
  59                                         <td>
  60                                                                                         Typically there will only be a single instance of the database level class in an application.
  61                                                                                 </td>
  62                                 </tr>
  63                                                         </table>
  64                 </div>
  65         </div>
  66
  67         <a name="sec-includes"></a>
  68         <div class="info-box">
  69                 <div class="info-box-title">Includes</div>
  70                 <div class="nav-bar">
  71                         <a href="#sec-description">Description</a> |
  72                                                         <a href="#sec-classes">Classes</a>
  73                                 |                                               <span class="disabled">Includes</span>
  74                                                                                                                 </div>
  75                 <div class="info-box-body">
  76                         <a name="_AwlDBDialect_php"><!-- --></a>
  77 <div class="oddrow">
  78
  79         <div>
  80                 <img src="../../media/images/Page.png" alt=" " />
  81                 <span class="include-title">
  82                         <span class="include-type">require</span>
  83                         (<span class="include-name"><a href="../../awl/AwlDatabase/_inc---AwlDBDialect.php.html">'AwlDBDialect.php'</a></span>)
  84                         (line <span class="line-number">37</span>)
  85                 </span>
  86         </div>
  87
  88         <!-- ========== Info from phpDoc block ========= -->
  89
  90 </div>
  91                 </div>
  92         </div>
  93
  94
  95
  96
  97         <p class="notes" id="credit">
  98                 Documentation generated on Sat, 17 Apr 2010 12:32:22 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  99         </p>
 100         </div></body>
 101 </html>