docs/api/awl/MenuSet/MenuSet.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 Class MenuSet</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="class-name"><img src="../../media/images/Class_logo.png"
  89                                                                                                                 alt=" Class"
  90                                                                                                                 title=" Class"
  91                                                                                                                 style="vertical-align: middle"> MenuSet</h2>
  92
  93 <a name="sec-description"></a>
  94 <div class="info-box">
  95         <div class="info-box-title">Description</div>
  96         <div class="nav-bar">
  97                                         <span class="disabled">Description</span> |
  98                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  99
 100                                         </div>
 101         <div class="info-box-body">
 102                         <!-- ========== Info from phpDoc block ========= -->
 103 <p class="short-description">A MenuSet is a hierarchy of MenuOptions, some of which might be  MenuSet objects themselves.</p>
 104 <p class="description"><p>The menu options are presented in HTML span tags, and the menus  themselves are presented inside HTML div tags.  All layout and  styling is expected to be provide by CSS.</p><p>A non-trivial example would look something like this: <div class="src-code"><ol><li><div class="src-line">require<span class="src-sym">(</span><span class="src-str">&quot;MenuSet.php&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 105 <li><div class="src-line"><span class="src-var">$main_menu&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><a href="../../awl/MenuSet/MenuSet.html#methodMenuSet">MenuSet</a><span class="src-sym">(</span><span class="src-str">'menu'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'menu'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'menu_active'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 106 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 107 <li><div class="src-line"><span class="src-var">$other_menu&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><a href="../../awl/MenuSet/MenuSet.html#methodMenuSet">MenuSet</a><span class="src-sym">(</span><span class="src-str">'submenu'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'submenu'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'submenu_active'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 108 <li><div class="src-line"><span class="src-var">$other_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Extra&nbsp;Other&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/extraother.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Submenu&nbsp;option&nbsp;to&nbsp;do&nbsp;extra&nbsp;things.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 109 <li><div class="src-line"><span class="src-var">$other_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Super&nbsp;Other&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/superother.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Submenu&nbsp;option&nbsp;to&nbsp;do&nbsp;super&nbsp;things.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 110 <li><div class="src-line"><span class="src-var">$other_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Meta&nbsp;Other&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/metaother.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Submenu&nbsp;option&nbsp;to&nbsp;do&nbsp;meta&nbsp;things.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 111 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 112 <li><div class="src-line"><span class="src-var">$main_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Do&nbsp;This&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/dothis.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Option&nbsp;to&nbsp;do&nbsp;this&nbsp;thing.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 113 <li><div class="src-line"><span class="src-var">$main_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Do&nbsp;That&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/dothat.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Option&nbsp;to&nbsp;do&nbsp;all&nbsp;of&nbsp;that.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 114 <li><div class="src-line"><span class="src-var">$main_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddSubMenu">AddSubMenu</a><span class="src-sym">(&nbsp;</span><span class="src-var">$other_menu</span><span class="src-sym">,&nbsp;</span><span class="src-str">&quot;Do&nbsp;The&nbsp;Other&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/dotheother.php&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Submenu&nbsp;to&nbsp;do&nbsp;all&nbsp;of&nbsp;the&nbsp;other&nbsp;things.&quot;</span><span class="src-sym">,&nbsp;</span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 115 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 116 <li><div class="src-line"><span class="src-key">if&nbsp;</span><span class="src-sym">(&nbsp;</span>isset<span class="src-sym">(</span><span class="src-var">$main_menu</span><span class="src-sym">)&nbsp;</span>&amp;&amp;&nbsp;<a href="http://www.php.net/is_object">is_object</a><span class="src-sym">(</span><span class="src-var">$main_menu</span><span class="src-sym">)&nbsp;)&nbsp;</span><span class="src-sym">{</span></div></li>
 117 <li><div class="src-line">&nbsp;&nbsp;<span class="src-var">$main_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodAddOption">AddOption</a><span class="src-sym">(</span><span class="src-str">&quot;Home&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;/&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;Go&nbsp;back&nbsp;to&nbsp;the&nbsp;home&nbsp;page&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 118 <li><div class="src-line">&nbsp;&nbsp;echo&nbsp;<span class="src-var">$main_menu</span><span class="src-sym">-&gt;</span><a href="../../awl/MenuSet/MenuSet.html#methodRender">Render</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
 119 <li><div class="src-line"><span class="src-sym">}</span></div></li>
 120 </ol></div>  In a hierarchical menu tree, like the example above, only one sub-menu will be  shown, which will be the first one that is found to have active menu options.</p><p>The menu display will generally recognise the current URL and mark as active the  menu option that matches it, but in some cases it might be desirable to force one  or another option to be marked as active using the appropriate parameter to the  AddOption or AddSubMenu call.</p></p>
 121                 <p class="notes">
 122                         Located in <a class="field" href="_MenuSet.php.html">/MenuSet.php</a> (line <span class="field">222</span>)
 123                 </p>
 124
 125
 126                 <pre></pre>
 127
 128                         </div>
 129 </div>
 130
 131
 132
 133
 134         <a name="sec-method-summary"></a>
 135         <div class="info-box">
 136                 <div class="info-box-title">Method Summary</span></div>
 137                 <div class="nav-bar">
 138                         <a href="#sec-description">Description</a> |
 139                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 140                 </div>
 141                 <div class="info-box-body">
 142                         <div class="method-summary">
 143
 144                                 <div class="method-definition">
 145                                         <img src="../../media/images/Constructor.png" alt=" "/>
 146                                                                                         <span class="method-result">MenuSet</span>
 147                                                                                 <a href="#MenuSet" title="details" class="method-name">MenuSet</a>
 148                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$div_id</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$main_class</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active_class</span> = <span class="var-default">'active'</span>])
 149                                                                         </div>
 150
 151                                 <div class="method-definition">
 152                                         <img src="../../media/images/Method.png" alt=" "/>
 153                                                                                         <span class="method-result">mixed</span>
 154                                                                                 <a href="#AddOption" title="details" class="method-name">&amp;AddOption</a>
 155                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">null</span>], [<span class="var-type">external</span>&nbsp;<span class="var-name">$external</span> = <span class="var-default">false</span>])
 156                                                                         </div>
 157
 158                                 <div class="method-definition">
 159                                         <img src="../../media/images/Method.png" alt=" "/>
 160                                                                                         <span class="method-result">mixed</span>
 161                                                                                 <a href="#AddSubMenu" title="details" class="method-name">&amp;AddSubMenu</a>
 162                                                                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">&$submenu_set</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">2000</span>])
 163                                                                         </div>
 164
 165                                 <div class="method-definition">
 166                                         <img src="../../media/images/Method.png" alt=" "/>
 167                                                                                         <span class="method-result">void</span>
 168                                                                                 <a href="#LinkActiveSubMenus" title="details" class="method-name">LinkActiveSubMenus</a>
 169                                                                                 ()
 170                                                                         </div>
 171
 172                                 <div class="method-definition">
 173                                         <img src="../../media/images/Method.png" alt=" "/>
 174                                                                                         <span class="method-result">void</span>
 175                                                                                 <a href="#MakeSomethingActive" title="details" class="method-name">MakeSomethingActive</a>
 176                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>)
 177                                                                         </div>
 178
 179                                 <div class="method-definition">
 180                                         <img src="../../media/images/Method.png" alt=" "/>
 181                                                                                         <span class="method-result">string</span>
 182                                                                                 <a href="#Render" title="details" class="method-name">Render</a>
 183                                                                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span> = <span class="var-default">false</span>])
 184                                                                         </div>
 185
 186                                 <div class="method-definition">
 187                                         <img src="../../media/images/Method.png" alt=" "/>
 188                                                                                         <span class="method-result">string</span>
 189                                                                                 <a href="#RenderAsCSS" title="details" class="method-name">RenderAsCSS</a>
 190                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$skip_empty</span> = <span class="var-default">true</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span>)
 191                                                                         </div>
 192
 193                                 <div class="method-definition">
 194                                         <img src="../../media/images/Method.png" alt=" "/>
 195                                                                                         <span class="method-result">int</span>
 196                                                                                 <a href="#Size" title="details" class="method-name">Size</a>
 197                                                                                 ()
 198                                                                         </div>
 199
 200                                 <div class="method-definition">
 201                                         <img src="../../media/images/Method.png" alt=" "/>
 202                                                                                         <span class="method-result">int</span>
 203                                                                                 <a href="#_CompareSequence" title="details" class="method-name">_CompareSequence</a>
 204                                                                                         (<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>)
 205                                                                         </div>
 206
 207                                 <div class="method-definition">
 208                                         <img src="../../media/images/Method.png" alt=" "/>
 209                                                                                         <span class="method-result">boolean</span>
 210                                                                                 <a href="#_HasActive" title="details" class="method-name">_HasActive</a>
 211                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
 212                                                                         </div>
 213
 214                                 <div class="method-definition">
 215                                         <img src="../../media/images/Method.png" alt=" "/>
 216                                                                                         <span class="method-result">boolean</span>
 217                                                                                 <a href="#_OptionExists" title="details" class="method-name">_OptionExists</a>
 218                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$newlabel</span>)
 219                                                                         </div>
 220                                                                                         </div>
 221                 </div>
 222         </div>
 223
 224
 225         <a name="sec-methods"></a>
 226         <div class="info-box">
 227                 <div class="info-box-title">Methods</div>
 228                 <div class="nav-bar">
 229                         <a href="#sec-description">Description</a> |
 230                                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 231
 232                 </div>
 233                 <div class="info-box-body">
 234                         <A NAME='method_detail'></A>
 235 <a name="methodMenuSet" id="MenuSet"><!-- --></a>
 236 <div class="evenrow">
 237
 238         <div class="method-header">
 239                 <img src="../../media/images/Constructor.png" />
 240                 <span class="method-title">Constructor MenuSet</span> (line <span class="line-number">276</span>)
 241         </div>
 242
 243         <!-- ========== Info from phpDoc block ========= -->
 244 <p class="short-description">Start a new MenuSet with no options.</p>
 245
 246         <div class="method-signature">
 247                 <span class="method-result">MenuSet</span>
 248                 <span class="method-name">
 249                         MenuSet
 250                 </span>
 251                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$div_id</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$main_class</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active_class</span> = <span class="var-default">'active'</span>])
 252                         </div>
 253
 254                         <ul class="parameters">
 255                                         <li>
 256                                 <span class="var-type">string</span>
 257                                 <span class="var-name">$div_id</span><span class="var-description">: An ID for the HTML div that the menu will be presented in.</span>                  </li>
 258                                         <li>
 259                                 <span class="var-type">string</span>
 260                                 <span class="var-name">$main_class</span><span class="var-description">: A CSS class for most menu options.</span>                      </li>
 261                                         <li>
 262                                 <span class="var-type">string</span>
 263                                 <span class="var-name">$active_class</span><span class="var-description">: A CSS class for active menu options.</span>                  </li>
 264                                 </ul>
 265
 266
 267         </div>
 268 <a name="methodAddOption" id="AddOption"><!-- --></a>
 269 <div class="oddrow">
 270
 271         <div class="method-header">
 272                 <img src="../../media/images/Method.png" />
 273                 <span class="method-title">AddOption</span> (line <span class="line-number">295</span>)
 274         </div>
 275
 276         <!-- ========== Info from phpDoc block ========= -->
 277 <p class="short-description">Add an option, which is a link.</p>
 278 <p class="description"><p>The call will attempt to work out whether the option should be marked as  active, and will sometimes get it wrong.</p></p>
 279         <ul class="tags">
 280                                 <li><span class="field">return:</span> A reference to the MenuOption that was added, or false if none were added.</li>
 281                         </ul>
 282
 283         <div class="method-signature">
 284                 <span class="method-result">mixed</span>
 285                 <span class="method-name">
 286                         &amp;AddOption
 287                 </span>
 288                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">null</span>], [<span class="var-type">external</span>&nbsp;<span class="var-name">$external</span> = <span class="var-default">false</span>])
 289                         </div>
 290
 291                         <ul class="parameters">
 292                                         <li>
 293                                 <span class="var-type">string</span>
 294                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 295                                         <li>
 296                                 <span class="var-type">string</span>
 297                                 <span class="var-name">$target</span><span class="var-description">: The URL to target for this option.</span>                  </li>
 298                                         <li>
 299                                 <span class="var-type">string</span>
 300                                 <span class="var-name">$title</span><span class="var-description">: Some tooltip help for the title tag.</span>                 </li>
 301                                         <li>
 302                                 <span class="var-type">string</span>
 303                                 <span class="var-name">$active</span><span class="var-description">: Whether this option should be marked as Active.</span>                     </li>
 304                                         <li>
 305                                 <span class="var-type">int</span>
 306                                 <span class="var-name">$sortkey</span><span class="var-description">: An (optional) value to allow option ordering.</span>                      </li>
 307                                         <li>
 308                                 <span class="var-type">external</span>
 309                                 <span class="var-name">$external</span><span class="var-description">: open this link in a new window/tab.</span>                       </li>
 310                                 </ul>
 311
 312
 313         </div>
 314 <a name="methodAddSubMenu" id="AddSubMenu"><!-- --></a>
 315 <div class="evenrow">
 316
 317         <div class="method-header">
 318                 <img src="../../media/images/Method.png" />
 319                 <span class="method-title">AddSubMenu</span> (line <span class="line-number">341</span>)
 320         </div>
 321
 322         <!-- ========== Info from phpDoc block ========= -->
 323 <p class="short-description">Add an option, which is a submenu</p>
 324         <ul class="tags">
 325                                 <li><span class="field">return:</span> A reference to the MenuOption that was added, or false if none were added.</li>
 326                         </ul>
 327
 328         <div class="method-signature">
 329                 <span class="method-result">mixed</span>
 330                 <span class="method-name">
 331                         &amp;AddSubMenu
 332                 </span>
 333                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">&$submenu_set</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$active</span> = <span class="var-default">false</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">2000</span>])
 334                         </div>
 335
 336                         <ul class="parameters">
 337                                         <li>
 338                                 <span class="var-type">object</span>
 339                                 <span class="var-name">&$submenu_set</span><span class="var-description">: A reference to a menu tree</span>                    </li>
 340                                         <li>
 341                                 <span class="var-type">string</span>
 342                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 343                                         <li>
 344                                 <span class="var-type">string</span>
 345                                 <span class="var-name">$target</span><span class="var-description">: The URL to target for this option.</span>                  </li>
 346                                         <li>
 347                                 <span class="var-type">string</span>
 348                                 <span class="var-name">$title</span><span class="var-description">: Some tooltip help for the title tag.</span>                 </li>
 349                                         <li>
 350                                 <span class="var-type">string</span>
 351                                 <span class="var-name">$active</span><span class="var-description">: Whether this option should be marked as Active.</span>                     </li>
 352                                         <li>
 353                                 <span class="var-type">int</span>
 354                                 <span class="var-name">$sortkey</span><span class="var-description">: An (optional) value to allow option ordering.</span>                      </li>
 355                                 </ul>
 356
 357
 358         </div>
 359 <a name="methodLinkActiveSubMenus" id="LinkActiveSubMenus"><!-- --></a>
 360 <div class="oddrow">
 361
 362         <div class="method-header">
 363                 <img src="../../media/images/Method.png" />
 364                 <span class="method-title">LinkActiveSubMenus</span> (line <span class="line-number">395</span>)
 365         </div>
 366
 367         <!-- ========== Info from phpDoc block ========= -->
 368 <p class="short-description">Mark each MenuOption as active that has an active sub-menu entry.</p>
 369 <p class="description"><p>Currently needs to be called manually before rendering but  really should probably be called as part of the render now,  and then this could be a private routine.</p></p>
 370
 371         <div class="method-signature">
 372                 <span class="method-result">void</span>
 373                 <span class="method-name">
 374                         LinkActiveSubMenus
 375                 </span>
 376                                 ()
 377                         </div>
 378
 379
 380
 381         </div>
 382 <a name="methodMakeSomethingActive" id="MakeSomethingActive"><!-- --></a>
 383 <div class="evenrow">
 384
 385         <div class="method-header">
 386                 <img src="../../media/images/Method.png" />
 387                 <span class="method-title">MakeSomethingActive</span> (line <span class="line-number">413</span>)
 388         </div>
 389
 390         <!-- ========== Info from phpDoc block ========= -->
 391 <p class="short-description">Mark each MenuOption as active that has an active sub-menu entry.</p>
 392 <p class="description"><p>Currently needs to be called manually before rendering but  really should probably be called as part of the render now,  and then this could be a private routine.</p></p>
 393
 394         <div class="method-signature">
 395                 <span class="method-result">void</span>
 396                 <span class="method-name">
 397                         MakeSomethingActive
 398                 </span>
 399                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>)
 400                         </div>
 401
 402                         <ul class="parameters">
 403                                         <li>
 404                                 <span class="var-type"></span>
 405                                 <span class="var-name">$test_pattern</span>                     </li>
 406                                 </ul>
 407
 408
 409         </div>
 410 <a name="methodRender" id="Render"><!-- --></a>
 411 <div class="oddrow">
 412
 413         <div class="method-header">
 414                 <img src="../../media/images/Method.png" />
 415                 <span class="method-title">Render</span> (line <span class="line-number">462</span>)
 416         </div>
 417
 418         <!-- ========== Info from phpDoc block ========= -->
 419 <p class="short-description">Render the menu tree to an HTML fragment.</p>
 420         <ul class="tags">
 421                                 <li><span class="field">return:</span> The HTML fragment.</li>
 422                         </ul>
 423
 424         <div class="method-signature">
 425                 <span class="method-result">string</span>
 426                 <span class="method-name">
 427                         Render
 428                 </span>
 429                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span> = <span class="var-default">false</span>])
 430                         </div>
 431
 432                         <ul class="parameters">
 433                                         <li>
 434                                 <span class="var-type">boolean</span>
 435                                 <span class="var-name">$submenus_inline</span><span class="var-description">: Indicate whether to render the sub-menus within    the menus, or render them entirely separately after we finish rendering the    top level ones.</span>                  </li>
 436                                 </ul>
 437
 438
 439         </div>
 440 <a name="methodRenderAsCSS" id="RenderAsCSS"><!-- --></a>
 441 <div class="evenrow">
 442
 443         <div class="method-header">
 444                 <img src="../../media/images/Method.png" />
 445                 <span class="method-title">RenderAsCSS</span> (line <span class="line-number">494</span>)
 446         </div>
 447
 448         <!-- ========== Info from phpDoc block ========= -->
 449 <p class="short-description">Render the menu tree to an HTML fragment.</p>
 450         <ul class="tags">
 451                                 <li><span class="field">return:</span> The HTML fragment.</li>
 452                         </ul>
 453
 454         <div class="method-signature">
 455                 <span class="method-result">string</span>
 456                 <span class="method-name">
 457                         RenderAsCSS
 458                 </span>
 459                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$skip_empty</span> = <span class="var-default">true</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span>)
 460                         </div>
 461
 462                         <ul class="parameters">
 463                                         <li>
 464                                 <span class="var-type">boolean</span>
 465                                 <span class="var-name">$submenus_inline</span><span class="var-description">: Indicate whether to render the sub-menus within    the menus, or render them entirely separately after we finish rendering the    top level ones.</span>                  </li>
 466                                         <li>
 467                                 <span class="var-type"></span>
 468                                 <span class="var-name">$depth</span>                    </li>
 469                                         <li>
 470                                 <span class="var-type"></span>
 471                                 <span class="var-name">$skip_empty</span>                       </li>
 472                                 </ul>
 473
 474
 475         </div>
 476 <a name="methodSize" id="Size"><!-- --></a>
 477 <div class="oddrow">
 478
 479         <div class="method-header">
 480                 <img src="../../media/images/Method.png" />
 481                 <span class="method-title">Size</span> (line <span class="line-number">372</span>)
 482         </div>
 483
 484         <!-- ========== Info from phpDoc block ========= -->
 485 <p class="short-description">Find out how many options the menu has.</p>
 486         <ul class="tags">
 487                                 <li><span class="field">return:</span> The number of options in the menu.</li>
 488                         </ul>
 489
 490         <div class="method-signature">
 491                 <span class="method-result">int</span>
 492                 <span class="method-name">
 493                         Size
 494                 </span>
 495                                 ()
 496                         </div>
 497
 498
 499
 500         </div>
 501 <a name="method_CompareSequence" id="_CompareSequence"><!-- --></a>
 502 <div class="evenrow">
 503
 504         <div class="method-header">
 505                 <img src="../../media/images/Method.png" />
 506                 <span class="method-title">_CompareSequence</span> (line <span class="line-number">448</span>)
 507         </div>
 508
 509         <!-- ========== Info from phpDoc block ========= -->
 510 <p class="short-description">_CompareSequence is used in sorting the menu options into the sequence order</p>
 511         <ul class="tags">
 512                                 <li><span class="field">return:</span> ( $a == b ? 0 ( $a &gt; b ? 1 : -1 ))</li>
 513                         </ul>
 514
 515         <div class="method-signature">
 516                 <span class="method-result">int</span>
 517                 <span class="method-name">
 518                         _CompareSequence
 519                 </span>
 520                                         (<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>)
 521                         </div>
 522
 523                         <ul class="parameters">
 524                                         <li>
 525                                 <span class="var-type">objectref</span>
 526                                 <span class="var-name">$a</span><span class="var-description">: The first menu option</span>                    </li>
 527                                         <li>
 528                                 <span class="var-type">objectref</span>
 529                                 <span class="var-name">$b</span><span class="var-description">: The second menu option</span>                   </li>
 530                                 </ul>
 531
 532
 533         </div>
 534 <a name="method_HasActive" id="_HasActive"><!-- --></a>
 535 <div class="oddrow">
 536
 537         <div class="method-header">
 538                 <img src="../../media/images/Method.png" />
 539                 <span class="method-title">_HasActive</span> (line <span class="line-number">354</span>)
 540         </div>
 541
 542         <!-- ========== Info from phpDoc block ========= -->
 543 <p class="short-description">Does the menu have any options that are active.</p>
 544 <p class="description"><p>Most likely used so that we can then set the parent menu as active.</p></p>
 545         <ul class="tags">
 546                                 <li><span class="field">return:</span> Whether the menu has options that are active.</li>
 547                         </ul>
 548
 549         <div class="method-signature">
 550                 <span class="method-result">boolean</span>
 551                 <span class="method-name">
 552                         _HasActive
 553                 </span>
 554                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
 555                         </div>
 556
 557                         <ul class="parameters">
 558                                         <li>
 559                                 <span class="var-type">string</span>
 560                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 561                                 </ul>
 562
 563
 564         </div>
 565 <a name="method_OptionExists" id="_OptionExists"><!-- --></a>
 566 <div class="evenrow">
 567
 568         <div class="method-header">
 569                 <img src="../../media/images/Method.png" />
 570                 <span class="method-title">_OptionExists</span> (line <span class="line-number">380</span>)
 571         </div>
 572
 573         <!-- ========== Info from phpDoc block ========= -->
 574 <p class="short-description">See if a menu already has this option</p>
 575         <ul class="tags">
 576                                 <li><span class="field">return:</span> Whether the option already exists in the menu.</li>
 577                         </ul>
 578
 579         <div class="method-signature">
 580                 <span class="method-result">boolean</span>
 581                 <span class="method-name">
 582                         _OptionExists
 583                 </span>
 584                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$newlabel</span>)
 585                         </div>
 586
 587                         <ul class="parameters">
 588                                         <li>
 589                                 <span class="var-type"></span>
 590                                 <span class="var-name">$newlabel</span>                 </li>
 591                                 </ul>
 592
 593
 594         </div>
 595
 596                 </div>
 597         </div>
 598
 599
 600         <p class="notes" id="credit">
 601                 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>
 602         </p>
 603         </div></body>
 604 </html>