docs/api/awl/MenuSet/MenuSet.html

   1
   2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
   3 <?xml version="1.0" encoding="iso-8859-1"?>
   4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5   <html xmlns="http://www.w3.org/1999/xhtml">
   6                 <head>
   7                         <!-- template designed by Marco Von Ballmoos  -->
   8                         <title>Docs For Class MenuSet</title>
   9                         <link rel="stylesheet" href="../../media/stylesheet.css" />
  10                                                 <script src="../../media/lib/classTree.js"></script>
  11                                                                                                 <script language="javascript" type="text/javascript">
  12                                 var imgPlus = new Image();
  13                                 var imgMinus = new Image();
  14                                 imgPlus.src = "../../media/images/plus.png";
  15                                 imgMinus.src = "../../media/images/minus.png";
  16
  17                                 function showNode(Node){
  18                                                         switch(navigator.family){
  19                                                                 case 'nn4':
  20                                                                         // Nav 4.x code fork...
  21                                                         var oTable = document.layers["span" + Node];
  22                                                         var oImg = document.layers["img" + Node];
  23                                                                         break;
  24                                                                 case 'ie4':
  25                                                                         // IE 4/5 code fork...
  26                                                         var oTable = document.all["span" + Node];
  27                                                         var oImg = document.all["img" + Node];
  28                                                                         break;
  29                                                                 case 'gecko':
  30                                                                         // Standards Compliant code fork...
  31                                                         var oTable = document.getElementById("span" + Node);
  32                                                         var oImg = document.getElementById("img" + Node);
  33                                                                         break;
  34                                                         }
  35                                         oImg.src = imgMinus.src;
  36                                         oTable.style.display = "block";
  37                                 }
  38
  39                                 function hideNode(Node){
  40                                                         switch(navigator.family){
  41                                                                 case 'nn4':
  42                                                                         // Nav 4.x code fork...
  43                                                         var oTable = document.layers["span" + Node];
  44                                                         var oImg = document.layers["img" + Node];
  45                                                                         break;
  46                                                                 case 'ie4':
  47                                                                         // IE 4/5 code fork...
  48                                                         var oTable = document.all["span" + Node];
  49                                                         var oImg = document.all["img" + Node];
  50                                                                         break;
  51                                                                 case 'gecko':
  52                                                                         // Standards Compliant code fork...
  53                                                         var oTable = document.getElementById("span" + Node);
  54                                                         var oImg = document.getElementById("img" + Node);
  55                                                                         break;
  56                                                         }
  57                                         oImg.src = imgPlus.src;
  58                                         oTable.style.display = "none";
  59                                 }
  60
  61                                 function nodeIsVisible(Node){
  62                                                         switch(navigator.family){
  63                                                                 case 'nn4':
  64                                                                         // Nav 4.x code fork...
  65                                                         var oTable = document.layers["span" + Node];
  66                                                                         break;
  67                                                                 case 'ie4':
  68                                                                         // IE 4/5 code fork...
  69                                                         var oTable = document.all["span" + Node];
  70                                                                         break;
  71                                                                 case 'gecko':
  72                                                                         // Standards Compliant code fork...
  73                                                         var oTable = document.getElementById("span" + Node);
  74                                                                         break;
  75                                                         }
  76                                         return (oTable && oTable.style.display == "block");
  77                                 }
  78
  79                                 function toggleNodeVisibility(Node){
  80                                         if (nodeIsVisible(Node)){
  81                                                 hideNode(Node);
  82                                         }else{
  83                                                 showNode(Node);
  84                                         }
  85                                 }
  86                         </script>
  87                                         </head>
  88                 <body>
  89                         <div class="page-body">
  90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
  91                                                                                                                 alt=" Class"
  92                                                                                                                 title=" Class"
  93                                                                                                                 style="vertical-align: middle"> MenuSet</h2>
  94
  95 <a name="sec-description"></a>
  96 <div class="info-box">
  97         <div class="info-box-title">Description</div>
  98         <div class="nav-bar">
  99                                         <span class="disabled">Description</span> |
 100                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 101
 102                                         </div>
 103         <div class="info-box-body">
 104
 105 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
 106 <!-- ========== Info from phpDoc block ========= -->
 107 <p class="short-description">A MenuSet is a hierarchy of MenuOptions, some of which might be  MenuSet objects themselves.</p>
 108 <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>
 109 <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>
 110 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 111 <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>
 112 <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>
 113 <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>
 114 <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>
 115 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 116 <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>
 117 <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>
 118 <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>
 119 <li><div class="src-line">&nbsp;&nbsp;...</div></li>
 120 <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>
 121 <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>
 122 <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>
 123 <li><div class="src-line"><span class="src-sym">}</span></div></li>
 124 </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>
 125                 <p class="notes">
 126                         Located in <a class="field" href="_MenuSet.php.html">/MenuSet.php</a> (line <span class="field">222</span>)
 127                 </p>
 128
 129
 130                 <pre></pre>
 131
 132                         </div>
 133 </div>
 134
 135
 136
 137
 138         <a name="sec-method-summary"></a>
 139         <div class="info-box">
 140                 <div class="info-box-title">Method Summary</span></div>
 141                 <div class="nav-bar">
 142                         <a href="#sec-description">Description</a> |
 143                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 144                 </div>
 145                 <div class="info-box-body">
 146                         <div class="method-summary">
 147
 148                                 <div class="method-definition">
 149                                         <img src="../../media/images/Constructor.png" alt=" "/>
 150                                                                                         <span class="method-result">MenuSet</span>
 151                                                                                 <a href="#MenuSet" title="details" class="method-name">MenuSet</a>
 152                                                                                         (<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>])
 153                                                                         </div>
 154
 155                                 <div class="method-definition">
 156                                         <img src="../../media/images/Method.png" alt=" "/>
 157                                                                                         <span class="method-result">mixed</span>
 158                                                                                 <a href="#AddOption" title="details" class="method-name">&amp;AddOption</a>
 159                                                                                         (<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>])
 160                                                                         </div>
 161
 162                                 <div class="method-definition">
 163                                         <img src="../../media/images/Method.png" alt=" "/>
 164                                                                                         <span class="method-result">mixed</span>
 165                                                                                 <a href="#AddSubMenu" title="details" class="method-name">&amp;AddSubMenu</a>
 166                                                                                         (<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>])
 167                                                                         </div>
 168
 169                                 <div class="method-definition">
 170                                         <img src="../../media/images/Method.png" alt=" "/>
 171                                                                                         <span class="method-result">void</span>
 172                                                                                 <a href="#LinkActiveSubMenus" title="details" class="method-name">LinkActiveSubMenus</a>
 173                                                                                 ()
 174                                                                         </div>
 175
 176                                 <div class="method-definition">
 177                                         <img src="../../media/images/Method.png" alt=" "/>
 178                                                                                         <span class="method-result">void</span>
 179                                                                                 <a href="#MakeSomethingActive" title="details" class="method-name">MakeSomethingActive</a>
 180                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>)
 181                                                                         </div>
 182
 183                                 <div class="method-definition">
 184                                         <img src="../../media/images/Method.png" alt=" "/>
 185                                                                                         <span class="method-result">string</span>
 186                                                                                 <a href="#Render" title="details" class="method-name">Render</a>
 187                                                                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span> = <span class="var-default">false</span>])
 188                                                                         </div>
 189
 190                                 <div class="method-definition">
 191                                         <img src="../../media/images/Method.png" alt=" "/>
 192                                                                                         <span class="method-result">string</span>
 193                                                                                 <a href="#RenderAsCSS" title="details" class="method-name">RenderAsCSS</a>
 194                                                                                         ([<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>)
 195                                                                         </div>
 196
 197                                 <div class="method-definition">
 198                                         <img src="../../media/images/Method.png" alt=" "/>
 199                                                                                         <span class="method-result">int</span>
 200                                                                                 <a href="#Size" title="details" class="method-name">Size</a>
 201                                                                                 ()
 202                                                                         </div>
 203
 204                                 <div class="method-definition">
 205                                         <img src="../../media/images/Method.png" alt=" "/>
 206                                                                                         <span class="method-result">int</span>
 207                                                                                 <a href="#_CompareSequence" title="details" class="method-name">_CompareSequence</a>
 208                                                                                         (<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>)
 209                                                                         </div>
 210
 211                                 <div class="method-definition">
 212                                         <img src="../../media/images/Method.png" alt=" "/>
 213                                                                                         <span class="method-result">boolean</span>
 214                                                                                 <a href="#_HasActive" title="details" class="method-name">_HasActive</a>
 215                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
 216                                                                         </div>
 217
 218                                 <div class="method-definition">
 219                                         <img src="../../media/images/Method.png" alt=" "/>
 220                                                                                         <span class="method-result">boolean</span>
 221                                                                                 <a href="#_OptionExists" title="details" class="method-name">_OptionExists</a>
 222                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$newlabel</span>)
 223                                                                         </div>
 224                                                                                         </div>
 225                 </div>
 226         </div>
 227
 228
 229         <a name="sec-methods"></a>
 230         <div class="info-box">
 231                 <div class="info-box-title">Methods</div>
 232                 <div class="nav-bar">
 233                         <a href="#sec-description">Description</a> |
 234                                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 235
 236                 </div>
 237                 <div class="info-box-body">
 238
 239 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
 240
 241 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
 242 <A NAME='method_detail'></A>
 243 <a name="methodMenuSet" id="MenuSet"><!-- --></a>
 244 <div class="oddrow">
 245
 246         <div class="method-header">
 247                 <img src="../../media/images/Constructor.png" />
 248                 <span class="method-title">Constructor MenuSet</span> (line <span class="line-number">276</span>)
 249         </div>
 250
 251         <!-- ========== Info from phpDoc block ========= -->
 252 <p class="short-description">Start a new MenuSet with no options.</p>
 253
 254         <div class="method-signature">
 255                 <span class="method-result">MenuSet</span>
 256                 <span class="method-name">
 257                         MenuSet
 258                 </span>
 259                                         (<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>])
 260                         </div>
 261
 262                         <ul class="parameters">
 263                                         <li>
 264                                 <span class="var-type">string</span>
 265                                 <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>
 266                                         <li>
 267                                 <span class="var-type">string</span>
 268                                 <span class="var-name">$main_class</span><span class="var-description">: A CSS class for most menu options.</span>                      </li>
 269                                         <li>
 270                                 <span class="var-type">string</span>
 271                                 <span class="var-name">$active_class</span><span class="var-description">: A CSS class for active menu options.</span>                  </li>
 272                                 </ul>
 273
 274
 275         </div>
 276 <a name="methodAddOption" id="AddOption"><!-- --></a>
 277 <div class="evenrow">
 278
 279         <div class="method-header">
 280                 <img src="../../media/images/Method.png" />
 281                 <span class="method-title">AddOption</span> (line <span class="line-number">295</span>)
 282         </div>
 283
 284         <!-- ========== Info from phpDoc block ========= -->
 285 <p class="short-description">Add an option, which is a link.</p>
 286 <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>
 287         <ul class="tags">
 288                                 <li><span class="field">return:</span> A reference to the MenuOption that was added, or false if none were added.</li>
 289                         </ul>
 290
 291         <div class="method-signature">
 292                 <span class="method-result">mixed</span>
 293                 <span class="method-name">
 294                         &amp;AddOption
 295                 </span>
 296                                         (<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>])
 297                         </div>
 298
 299                         <ul class="parameters">
 300                                         <li>
 301                                 <span class="var-type">string</span>
 302                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 303                                         <li>
 304                                 <span class="var-type">string</span>
 305                                 <span class="var-name">$target</span><span class="var-description">: The URL to target for this option.</span>                  </li>
 306                                         <li>
 307                                 <span class="var-type">string</span>
 308                                 <span class="var-name">$title</span><span class="var-description">: Some tooltip help for the title tag.</span>                 </li>
 309                                         <li>
 310                                 <span class="var-type">string</span>
 311                                 <span class="var-name">$active</span><span class="var-description">: Whether this option should be marked as Active.</span>                     </li>
 312                                         <li>
 313                                 <span class="var-type">int</span>
 314                                 <span class="var-name">$sortkey</span><span class="var-description">: An (optional) value to allow option ordering.</span>                      </li>
 315                                         <li>
 316                                 <span class="var-type">external</span>
 317                                 <span class="var-name">$external</span><span class="var-description">: open this link in a new window/tab.</span>                       </li>
 318                                 </ul>
 319
 320
 321         </div>
 322 <a name="methodAddSubMenu" id="AddSubMenu"><!-- --></a>
 323 <div class="oddrow">
 324
 325         <div class="method-header">
 326                 <img src="../../media/images/Method.png" />
 327                 <span class="method-title">AddSubMenu</span> (line <span class="line-number">341</span>)
 328         </div>
 329
 330         <!-- ========== Info from phpDoc block ========= -->
 331 <p class="short-description">Add an option, which is a submenu</p>
 332         <ul class="tags">
 333                                 <li><span class="field">return:</span> A reference to the MenuOption that was added, or false if none were added.</li>
 334                         </ul>
 335
 336         <div class="method-signature">
 337                 <span class="method-result">mixed</span>
 338                 <span class="method-name">
 339                         &amp;AddSubMenu
 340                 </span>
 341                                         (<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>])
 342                         </div>
 343
 344                         <ul class="parameters">
 345                                         <li>
 346                                 <span class="var-type">object</span>
 347                                 <span class="var-name">&$submenu_set</span><span class="var-description">: A reference to a menu tree</span>                    </li>
 348                                         <li>
 349                                 <span class="var-type">string</span>
 350                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 351                                         <li>
 352                                 <span class="var-type">string</span>
 353                                 <span class="var-name">$target</span><span class="var-description">: The URL to target for this option.</span>                  </li>
 354                                         <li>
 355                                 <span class="var-type">string</span>
 356                                 <span class="var-name">$title</span><span class="var-description">: Some tooltip help for the title tag.</span>                 </li>
 357                                         <li>
 358                                 <span class="var-type">string</span>
 359                                 <span class="var-name">$active</span><span class="var-description">: Whether this option should be marked as Active.</span>                     </li>
 360                                         <li>
 361                                 <span class="var-type">int</span>
 362                                 <span class="var-name">$sortkey</span><span class="var-description">: An (optional) value to allow option ordering.</span>                      </li>
 363                                 </ul>
 364
 365
 366         </div>
 367 <a name="methodLinkActiveSubMenus" id="LinkActiveSubMenus"><!-- --></a>
 368 <div class="evenrow">
 369
 370         <div class="method-header">
 371                 <img src="../../media/images/Method.png" />
 372                 <span class="method-title">LinkActiveSubMenus</span> (line <span class="line-number">395</span>)
 373         </div>
 374
 375         <!-- ========== Info from phpDoc block ========= -->
 376 <p class="short-description">Mark each MenuOption as active that has an active sub-menu entry.</p>
 377 <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>
 378
 379         <div class="method-signature">
 380                 <span class="method-result">void</span>
 381                 <span class="method-name">
 382                         LinkActiveSubMenus
 383                 </span>
 384                                 ()
 385                         </div>
 386
 387
 388
 389         </div>
 390 <a name="methodMakeSomethingActive" id="MakeSomethingActive"><!-- --></a>
 391 <div class="oddrow">
 392
 393         <div class="method-header">
 394                 <img src="../../media/images/Method.png" />
 395                 <span class="method-title">MakeSomethingActive</span> (line <span class="line-number">413</span>)
 396         </div>
 397
 398         <!-- ========== Info from phpDoc block ========= -->
 399 <p class="short-description">Mark each MenuOption as active that has an active sub-menu entry.</p>
 400 <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>
 401
 402         <div class="method-signature">
 403                 <span class="method-result">void</span>
 404                 <span class="method-name">
 405                         MakeSomethingActive
 406                 </span>
 407                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>)
 408                         </div>
 409
 410                         <ul class="parameters">
 411                                         <li>
 412                                 <span class="var-type"></span>
 413                                 <span class="var-name">$test_pattern</span>                     </li>
 414                                 </ul>
 415
 416
 417         </div>
 418 <a name="methodRender" id="Render"><!-- --></a>
 419 <div class="evenrow">
 420
 421         <div class="method-header">
 422                 <img src="../../media/images/Method.png" />
 423                 <span class="method-title">Render</span> (line <span class="line-number">462</span>)
 424         </div>
 425
 426         <!-- ========== Info from phpDoc block ========= -->
 427 <p class="short-description">Render the menu tree to an HTML fragment.</p>
 428         <ul class="tags">
 429                                 <li><span class="field">return:</span> The HTML fragment.</li>
 430                         </ul>
 431
 432         <div class="method-signature">
 433                 <span class="method-result">string</span>
 434                 <span class="method-name">
 435                         Render
 436                 </span>
 437                                         ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$submenus_inline</span> = <span class="var-default">false</span>])
 438                         </div>
 439
 440                         <ul class="parameters">
 441                                         <li>
 442                                 <span class="var-type">boolean</span>
 443                                 <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>
 444                                 </ul>
 445
 446
 447         </div>
 448 <a name="methodRenderAsCSS" id="RenderAsCSS"><!-- --></a>
 449 <div class="oddrow">
 450
 451         <div class="method-header">
 452                 <img src="../../media/images/Method.png" />
 453                 <span class="method-title">RenderAsCSS</span> (line <span class="line-number">494</span>)
 454         </div>
 455
 456         <!-- ========== Info from phpDoc block ========= -->
 457 <p class="short-description">Render the menu tree to an HTML fragment.</p>
 458         <ul class="tags">
 459                                 <li><span class="field">return:</span> The HTML fragment.</li>
 460                         </ul>
 461
 462         <div class="method-signature">
 463                 <span class="method-result">string</span>
 464                 <span class="method-name">
 465                         RenderAsCSS
 466                 </span>
 467                                         ([<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>)
 468                         </div>
 469
 470                         <ul class="parameters">
 471                                         <li>
 472                                 <span class="var-type">boolean</span>
 473                                 <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>
 474                                         <li>
 475                                 <span class="var-type"></span>
 476                                 <span class="var-name">$depth</span>                    </li>
 477                                         <li>
 478                                 <span class="var-type"></span>
 479                                 <span class="var-name">$skip_empty</span>                       </li>
 480                                 </ul>
 481
 482
 483         </div>
 484 <a name="methodSize" id="Size"><!-- --></a>
 485 <div class="evenrow">
 486
 487         <div class="method-header">
 488                 <img src="../../media/images/Method.png" />
 489                 <span class="method-title">Size</span> (line <span class="line-number">372</span>)
 490         </div>
 491
 492         <!-- ========== Info from phpDoc block ========= -->
 493 <p class="short-description">Find out how many options the menu has.</p>
 494         <ul class="tags">
 495                                 <li><span class="field">return:</span> The number of options in the menu.</li>
 496                         </ul>
 497
 498         <div class="method-signature">
 499                 <span class="method-result">int</span>
 500                 <span class="method-name">
 501                         Size
 502                 </span>
 503                                 ()
 504                         </div>
 505
 506
 507
 508         </div>
 509 <a name="method_CompareSequence" id="_CompareSequence"><!-- --></a>
 510 <div class="oddrow">
 511
 512         <div class="method-header">
 513                 <img src="../../media/images/Method.png" />
 514                 <span class="method-title">_CompareSequence</span> (line <span class="line-number">448</span>)
 515         </div>
 516
 517         <!-- ========== Info from phpDoc block ========= -->
 518 <p class="short-description">_CompareSequence is used in sorting the menu options into the sequence order</p>
 519         <ul class="tags">
 520                                 <li><span class="field">return:</span> ( $a == b ? 0 ( $a &gt; b ? 1 : -1 ))</li>
 521                         </ul>
 522
 523         <div class="method-signature">
 524                 <span class="method-result">int</span>
 525                 <span class="method-name">
 526                         _CompareSequence
 527                 </span>
 528                                         (<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>)
 529                         </div>
 530
 531                         <ul class="parameters">
 532                                         <li>
 533                                 <span class="var-type">objectref</span>
 534                                 <span class="var-name">$a</span><span class="var-description">: The first menu option</span>                    </li>
 535                                         <li>
 536                                 <span class="var-type">objectref</span>
 537                                 <span class="var-name">$b</span><span class="var-description">: The second menu option</span>                   </li>
 538                                 </ul>
 539
 540
 541         </div>
 542 <a name="method_HasActive" id="_HasActive"><!-- --></a>
 543 <div class="evenrow">
 544
 545         <div class="method-header">
 546                 <img src="../../media/images/Method.png" />
 547                 <span class="method-title">_HasActive</span> (line <span class="line-number">354</span>)
 548         </div>
 549
 550         <!-- ========== Info from phpDoc block ========= -->
 551 <p class="short-description">Does the menu have any options that are active.</p>
 552 <p class="description"><p>Most likely used so that we can then set the parent menu as active.</p></p>
 553         <ul class="tags">
 554                                 <li><span class="field">return:</span> Whether the menu has options that are active.</li>
 555                         </ul>
 556
 557         <div class="method-signature">
 558                 <span class="method-result">boolean</span>
 559                 <span class="method-name">
 560                         _HasActive
 561                 </span>
 562                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
 563                         </div>
 564
 565                         <ul class="parameters">
 566                                         <li>
 567                                 <span class="var-type">string</span>
 568                                 <span class="var-name">$label</span><span class="var-description">: A Label for the new menu option</span>                      </li>
 569                                 </ul>
 570
 571
 572         </div>
 573 <a name="method_OptionExists" id="_OptionExists"><!-- --></a>
 574 <div class="oddrow">
 575
 576         <div class="method-header">
 577                 <img src="../../media/images/Method.png" />
 578                 <span class="method-title">_OptionExists</span> (line <span class="line-number">380</span>)
 579         </div>
 580
 581         <!-- ========== Info from phpDoc block ========= -->
 582 <p class="short-description">See if a menu already has this option</p>
 583         <ul class="tags">
 584                                 <li><span class="field">return:</span> Whether the option already exists in the menu.</li>
 585                         </ul>
 586
 587         <div class="method-signature">
 588                 <span class="method-result">boolean</span>
 589                 <span class="method-name">
 590                         _OptionExists
 591                 </span>
 592                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$newlabel</span>)
 593                         </div>
 594
 595                         <ul class="parameters">
 596                                         <li>
 597                                 <span class="var-type"></span>
 598                                 <span class="var-name">$newlabel</span>                 </li>
 599                                 </ul>
 600
 601
 602         </div>
 603
 604                 </div>
 605         </div>
 606
 607
 608
 609 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
 610         <p class="notes" id="credit">
 611                 Documentation generated on Sun, 17 Jun 2012 10:00:17 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 612         </p>
 613         </div></body>
 614 </html>