docs/api/awl/XMLElement/_XMLElement.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 XMLElement.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">/XMLElement.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                         |                                                                                       <a href="#sec-functions">Functions</a>
  98                         </div>
  99         <div class="info-box-body">
 100                 <!-- ========== Info from phpDoc block ========= -->
 101 <p class="short-description">A class to assist with construction of XML documents</p>
 102         <ul class="tags">
 103                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 104                                 <li><span class="field">copyright:</span> Catalyst .Net Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 105                                 <li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/lgpl-3.0.txt">GNU LGPL version 3 or later</a></li>
 106                         </ul>
 107
 108                         </div>
 109 </div>
 110
 111         <a name="sec-classes"></a>
 112         <div class="info-box">
 113                 <div class="info-box-title">Classes</div>
 114                 <div class="nav-bar">
 115                         <a href="#sec-description">Description</a> |
 116                         <span class="disabled">Classes</span>
 117                         |                                                       <a href="#sec-includes">Includes</a>
 118                                 |                                                                                                                               <a href="#sec-functions">Functions</a>
 119                                         </div>
 120                 <div class="info-box-body">
 121                         <table cellpadding="2" cellspacing="0" class="class-table">
 122                                 <tr>
 123                                         <th class="class-table-header">Class</th>
 124                                         <th class="class-table-header">Description</th>
 125                                 </tr>
 126                                                                 <tr>
 127                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 128                                                 <img src="../../media/images/Class.png"
 129                                                                  alt=" class"
 130                                                                  title=" class"/>
 131                                                 <a href="../../awl/XMLElement/XMLElement.html">XMLElement</a>
 132                                         </td>
 133                                         <td>
 134                                                                                         A class for XML elements which may have attributes, or contain  other XML sub-elements
 135                                                                                 </td>
 136                                 </tr>
 137                                                         </table>
 138                 </div>
 139         </div>
 140
 141         <a name="sec-includes"></a>
 142         <div class="info-box">
 143                 <div class="info-box-title">Includes</div>
 144                 <div class="nav-bar">
 145                         <a href="#sec-description">Description</a> |
 146                                                         <a href="#sec-classes">Classes</a>
 147                                 |                                               <span class="disabled">Includes</span>
 148                         |                                                                                                       <a href="#sec-functions">Functions</a>
 149                                         </div>
 150                 <div class="info-box-body">
 151                         <a name="_AWLUtilities_php"><!-- --></a>
 152 <div class="oddrow">
 153
 154         <div>
 155                 <img src="../../media/images/Page.png" alt=" " />
 156                 <span class="include-title">
 157                         <span class="include-type">require_once</span>
 158                         (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">'AWLUtilities.php'</a></span>)
 159                         (line <span class="line-number">12</span>)
 160                 </span>
 161         </div>
 162
 163         <!-- ========== Info from phpDoc block ========= -->
 164
 165 </div>
 166                 </div>
 167         </div>
 168
 169
 170
 171         <a name="sec-functions"></a>
 172         <div class="info-box">
 173                 <div class="info-box-title">Functions</div>
 174                 <div class="nav-bar">
 175                         <a href="#sec-description">Description</a> |
 176                                                         <a href="#sec-classes">Classes</a>
 177                                 |                                                                               <a href="#sec-includes">Includes</a>
 178                                 |                                                                                               <span class="disabled">Functions</span>
 179                 </div>
 180                 <div class="info-box-body">
 181                         <a name="functionBuildXMLTree" id="functionBuildXMLTree"><!-- --></a>
 182 <div class="evenrow">
 183
 184         <div>
 185                 <img src="../../media/images/Function.png" />
 186                 <span class="method-title">BuildXMLTree</span> (line <span class="line-number">316</span>)
 187         </div>
 188
 189         <!-- ========== Info from phpDoc block ========= -->
 190 <p class="short-description">Rebuild an XML tree in our own style from the parsed XML tags using  a tail-recursive approach.</p>
 191         <ul class="tags">
 192                                 <li><span class="field">return:</span> Either a single XMLElement, or an array of XMLElement objects.</li>
 193                         </ul>
 194         <div class="method-signature">
 195                 <span class="method-result">mixed</span>
 196                 <span class="method-name">
 197                         BuildXMLTree
 198                 </span>
 199                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$xmltags</span>, <span class="var-type">intref</span>&nbsp;<span class="var-name">&$start_from</span>)
 200                         </div>
 201
 202                         <ul class="parameters">
 203                                         <li>
 204                                 <span class="var-type">array</span>
 205                                 <span class="var-name">$xmltags</span><span class="var-description">: An array of XML tags we get from using the PHP XML parser</span>                  </li>
 206                                         <li>
 207                                 <span class="var-type">intref</span>
 208                                 <span class="var-name">&$start_from</span><span class="var-description">: A pointer to our current integer offset into $xmltags</span>                  </li>
 209                                 </ul>
 210
 211
 212 </div>
 213                 </div>
 214         </div>
 215
 216         <p class="notes" id="credit">
 217                 Documentation generated on Tue, 28 Dec 2010 02:01:38 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 218         </p>
 219         </div></body>
 220 </html>