docs/api/awl/AwlDatabase/_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                                                 <script src="../../media/lib/classTree.js"></script>
   9                                                                                                 <script language="javascript" type="text/javascript">
  10                                 var imgPlus = new Image();
  11                                 var imgMinus = new Image();
  12                                 imgPlus.src = "../../media/images/plus.png";
  13                                 imgMinus.src = "../../media/images/minus.png";
  14
  15                                 function showNode(Node){
  16                                                         switch(navigator.family){
  17                                                                 case 'nn4':
  18                                                                         // Nav 4.x code fork...
  19                                                         var oTable = document.layers["span" + Node];
  20                                                         var oImg = document.layers["img" + Node];
  21                                                                         break;
  22                                                                 case 'ie4':
  23                                                                         // IE 4/5 code fork...
  24                                                         var oTable = document.all["span" + Node];
  25                                                         var oImg = document.all["img" + Node];
  26                                                                         break;
  27                                                                 case 'gecko':
  28                                                                         // Standards Compliant code fork...
  29                                                         var oTable = document.getElementById("span" + Node);
  30                                                         var oImg = document.getElementById("img" + Node);
  31                                                                         break;
  32                                                         }
  33                                         oImg.src = imgMinus.src;
  34                                         oTable.style.display = "block";
  35                                 }
  36
  37                                 function hideNode(Node){
  38                                                         switch(navigator.family){
  39                                                                 case 'nn4':
  40                                                                         // Nav 4.x code fork...
  41                                                         var oTable = document.layers["span" + Node];
  42                                                         var oImg = document.layers["img" + Node];
  43                                                                         break;
  44                                                                 case 'ie4':
  45                                                                         // IE 4/5 code fork...
  46                                                         var oTable = document.all["span" + Node];
  47                                                         var oImg = document.all["img" + Node];
  48                                                                         break;
  49                                                                 case 'gecko':
  50                                                                         // Standards Compliant code fork...
  51                                                         var oTable = document.getElementById("span" + Node);
  52                                                         var oImg = document.getElementById("img" + Node);
  53                                                                         break;
  54                                                         }
  55                                         oImg.src = imgPlus.src;
  56                                         oTable.style.display = "none";
  57                                 }
  58
  59                                 function nodeIsVisible(Node){
  60                                                         switch(navigator.family){
  61                                                                 case 'nn4':
  62                                                                         // Nav 4.x code fork...
  63                                                         var oTable = document.layers["span" + Node];
  64                                                                         break;
  65                                                                 case 'ie4':
  66                                                                         // IE 4/5 code fork...
  67                                                         var oTable = document.all["span" + Node];
  68                                                                         break;
  69                                                                 case 'gecko':
  70                                                                         // Standards Compliant code fork...
  71                                                         var oTable = document.getElementById("span" + Node);
  72                                                                         break;
  73                                                         }
  74                                         return (oTable && oTable.style.display == "block");
  75                                 }
  76
  77                                 function toggleNodeVisibility(Node){
  78                                         if (nodeIsVisible(Node)){
  79                                                 hideNode(Node);
  80                                         }else{
  81                                                 showNode(Node);
  82                                         }
  83                                 }
  84                         </script>
  85                                         </head>
  86                 <body>
  87                         <div class="page-body">
  88 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/AwlDatabase.php</h2>
  89
  90 <a name="sec-description"></a>
  91 <div class="info-box">
  92         <div class="info-box-title">Description</div>
  93         <div class="nav-bar">
  94                                         <span class="disabled">Description</span> |
  95                                                         <a href="#sec-classes">Classes</a>
  96                         |                                                       <a href="#sec-includes">Includes</a>
  97                                                                                                 </div>
  98         <div class="info-box-body">
  99                 <!-- ========== Info from phpDoc block ========= -->
 100 <p class="short-description">AwlDatabase query/statement class and associated functions</p>
 101 <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
 102     minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
 103     be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
 104     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>
 105         <ul class="tags">
 106                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
 107                                 <li><span class="field">copyright:</span> Morphoss Ltd</li>
 108                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
 109                         </ul>
 110
 111                         </div>
 112 </div>
 113
 114         <a name="sec-classes"></a>
 115         <div class="info-box">
 116                 <div class="info-box-title">Classes</div>
 117                 <div class="nav-bar">
 118                         <a href="#sec-description">Description</a> |
 119                         <span class="disabled">Classes</span>
 120                         |                                                       <a href="#sec-includes">Includes</a>
 121                                                                                                                                                 </div>
 122                 <div class="info-box-body">
 123                         <table cellpadding="2" cellspacing="0" class="class-table">
 124                                 <tr>
 125                                         <th class="class-table-header">Class</th>
 126                                         <th class="class-table-header">Description</th>
 127                                 </tr>
 128                                                                 <tr>
 129                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 130                                                 <img src="../../media/images/Class.png"
 131                                                                  alt=" class"
 132                                                                  title=" class"/>
 133                                                 <a href="../../awl/AwlDatabase/AwlDatabase.html">AwlDatabase</a>
 134                                         </td>
 135                                         <td>
 136                                                                                         Typically there will only be a single instance of the database level class in an application.
 137                                                                                 </td>
 138                                 </tr>
 139                                                         </table>
 140                 </div>
 141         </div>
 142
 143         <a name="sec-includes"></a>
 144         <div class="info-box">
 145                 <div class="info-box-title">Includes</div>
 146                 <div class="nav-bar">
 147                         <a href="#sec-description">Description</a> |
 148                                                         <a href="#sec-classes">Classes</a>
 149                                 |                                               <span class="disabled">Includes</span>
 150                                                                                                                 </div>
 151                 <div class="info-box-body">
 152                         <a name="_AwlDBDialect_php"><!-- --></a>
 153 <div class="oddrow">
 154
 155         <div>
 156                 <img src="../../media/images/Page.png" alt=" " />
 157                 <span class="include-title">
 158                         <span class="include-type">require_once</span>
 159                         (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlDBDialect.php.html">'AwlDBDialect.php'</a></span>)
 160                         (line <span class="line-number">37</span>)
 161                 </span>
 162         </div>
 163
 164         <!-- ========== Info from phpDoc block ========= -->
 165
 166 </div>
 167                 </div>
 168         </div>
 169
 170
 171
 172
 173         <p class="notes" id="credit">
 174                 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 175         </p>
 176         </div></body>
 177 </html>