docs/api/awl/MenuSet/_MenuSet.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 MenuSet.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">/MenuSet.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">Some intelligence and standardisation around presenting a menu hierarchy.</p>
 102 <p class="description"><p>See the MenuSet class for examples as that is the primary interface.</p></p>
 103         <ul class="tags">
 104                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 105                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 106                                 <li><span class="field">see:</span> <a href="../../awl/MenuSet/MenuSet.html">MenuSet</a></li>
 107                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 108                         </ul>
 109
 110                         </div>
 111 </div>
 112
 113         <a name="sec-classes"></a>
 114         <div class="info-box">
 115                 <div class="info-box-title">Classes</div>
 116                 <div class="nav-bar">
 117                         <a href="#sec-description">Description</a> |
 118                         <span class="disabled">Classes</span>
 119                         |                                                       <a href="#sec-includes">Includes</a>
 120                                 |                                                                                                                               <a href="#sec-functions">Functions</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/MenuSet/MenuOption.html">MenuOption</a>
 134                                         </td>
 135                                         <td>
 136                                                                                         Each menu option is an object.
 137                                                                                 </td>
 138                                 </tr>
 139                                                                 <tr>
 140                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 141                                                 <img src="../../media/images/Class.png"
 142                                                                  alt=" class"
 143                                                                  title=" class"/>
 144                                                 <a href="../../awl/MenuSet/MenuSet.html">MenuSet</a>
 145                                         </td>
 146                                         <td>
 147                                                                                         A MenuSet is a hierarchy of MenuOptions, some of which might be  MenuSet objects themselves.
 148                                                                                 </td>
 149                                 </tr>
 150                                                         </table>
 151                 </div>
 152         </div>
 153
 154         <a name="sec-includes"></a>
 155         <div class="info-box">
 156                 <div class="info-box-title">Includes</div>
 157                 <div class="nav-bar">
 158                         <a href="#sec-description">Description</a> |
 159                                                         <a href="#sec-classes">Classes</a>
 160                                 |                                               <span class="disabled">Includes</span>
 161                         |                                                                                                       <a href="#sec-functions">Functions</a>
 162                                         </div>
 163                 <div class="info-box-body">
 164                         <a name="_AWLUtilities_php"><!-- --></a>
 165 <div class="oddrow">
 166
 167         <div>
 168                 <img src="../../media/images/Page.png" alt=" " />
 169                 <span class="include-title">
 170                         <span class="include-type">require_once</span>
 171                         (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">"AWLUtilities.php"</a></span>)
 172                         (line <span class="line-number">15</span>)
 173                 </span>
 174         </div>
 175
 176         <!-- ========== Info from phpDoc block ========= -->
 177
 178 </div>
 179                 </div>
 180         </div>
 181
 182
 183
 184         <a name="sec-functions"></a>
 185         <div class="info-box">
 186                 <div class="info-box-title">Functions</div>
 187                 <div class="nav-bar">
 188                         <a href="#sec-description">Description</a> |
 189                                                         <a href="#sec-classes">Classes</a>
 190                                 |                                                                               <a href="#sec-includes">Includes</a>
 191                                 |                                                                                               <span class="disabled">Functions</span>
 192                 </div>
 193                 <div class="info-box-body">
 194                         <a name="function_CompareMenuSequence" id="function_CompareMenuSequence"><!-- --></a>
 195 <div class="evenrow">
 196
 197         <div>
 198                 <img src="../../media/images/Function.png" />
 199                 <span class="method-title">_CompareMenuSequence</span> (line <span class="line-number">179</span>)
 200         </div>
 201
 202         <!-- ========== Info from phpDoc block ========= -->
 203 <p class="short-description">_CompareMenuSequence is used in sorting the menu options into the sequence order</p>
 204         <ul class="tags">
 205                                 <li><span class="field">return:</span> ( $a == b ? 0 ( $a &gt; b ? 1 : -1 ))</li>
 206                         </ul>
 207         <div class="method-signature">
 208                 <span class="method-result">int</span>
 209                 <span class="method-name">
 210                         _CompareMenuSequence
 211                 </span>
 212                                         (<span class="var-type">objectref</span>&nbsp;<span class="var-name">$a</span>, <span class="var-type">objectref</span>&nbsp;<span class="var-name">$b</span>)
 213                         </div>
 214
 215                         <ul class="parameters">
 216                                         <li>
 217                                 <span class="var-type">objectref</span>
 218                                 <span class="var-name">$a</span><span class="var-description">: The first menu option</span>                    </li>
 219                                         <li>
 220                                 <span class="var-type">objectref</span>
 221                                 <span class="var-name">$b</span><span class="var-description">: The second menu option</span>                   </li>
 222                                 </ul>
 223
 224
 225 </div>
 226                 </div>
 227         </div>
 228
 229         <p class="notes" id="credit">
 230                 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 231         </p>
 232         </div></body>
 233 </html>