docs/api/awl/DataEntry/EntryForm.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 EntryForm</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"> EntryForm</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 class to handle displaying a form on the page (for editing) or a structured  layout of non-editable content (for viewing), with a simple switch to flip from  view mode to edit mode.</p>
 108                 <p class="notes">
 109                         Located in <a class="field" href="_DataEntry.php.html">/DataEntry.php</a> (line <span class="field">334</span>)
 110                 </p>
 111
 112
 113                 <pre></pre>
 114
 115                         </div>
 116 </div>
 117
 118
 119
 120
 121         <a name="sec-method-summary"></a>
 122         <div class="info-box">
 123                 <div class="info-box-title">Method Summary</span></div>
 124                 <div class="nav-bar">
 125                         <a href="#sec-description">Description</a> |
 126                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 127                 </div>
 128                 <div class="info-box-body">
 129                         <div class="method-summary">
 130
 131                                 <div class="method-definition">
 132                                         <img src="../../media/images/StaticMethod.png" alt=" "/>
 133                                         static                                          <span class="method-result">string</span>
 134                                                                                 <a href="#_ParseAttributes" title="details" class="method-name">_ParseAttributes</a>
 135                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 136                                                                         </div>
 137
 138                                 <div class="method-definition">
 139                                         <img src="../../media/images/Constructor.png" alt=" "/>
 140                                                                                         <span class="method-result">EntryForm</span>
 141                                                                                 <a href="#EntryForm" title="details" class="method-name">EntryForm</a>
 142                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$editing</span> = <span class="var-default">false</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$editmode</span>)
 143                                                                         </div>
 144
 145                                 <div class="method-definition">
 146                                         <img src="../../media/images/Method.png" alt=" "/>
 147                                                                                         <span class="method-result">string</span>
 148                                                                                 <a href="#BreakLine" title="details" class="method-name">BreakLine</a>
 149                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">''</span>])
 150                                                                         </div>
 151
 152                                 <div class="method-definition">
 153                                         <img src="../../media/images/Method.png" alt=" "/>
 154                                                                                         <span class="method-result">string</span>
 155                                                                                 <a href="#DataEntryField" title="details" class="method-name">DataEntryField</a>
 156                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$base_fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 157                                                                         </div>
 158
 159                                 <div class="method-definition">
 160                                         <img src="../../media/images/Method.png" alt=" "/>
 161                                                                                         <span class="method-result">string</span>
 162                                                                                 <a href="#DataEntryLine" title="details" class="method-name">DataEntryLine</a>
 163                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$field_format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 164                                                                         </div>
 165
 166                                 <div class="method-definition">
 167                                         <img src="../../media/images/Method.png" alt=" "/>
 168                                                                                         <span class="method-result">string</span>
 169                                                                                 <a href="#EndForm" title="details" class="method-name">EndForm</a>
 170                                                                                 ()
 171                                                                         </div>
 172
 173                                 <div class="method-definition">
 174                                         <img src="../../media/images/Method.png" alt=" "/>
 175                                                                                         <span class="method-result">void</span>
 176                                                                                 <a href="#HelpInCell" title="details" class="method-name">HelpInCell</a>
 177                                                                                 ()
 178                                                                         </div>
 179
 180                                 <div class="method-definition">
 181                                         <img src="../../media/images/Method.png" alt=" "/>
 182                                                                                         <span class="method-result">void</span>
 183                                                                                 <a href="#HelpInLine" title="details" class="method-name">HelpInLine</a>
 184                                                                                 ()
 185                                                                         </div>
 186
 187                                 <div class="method-definition">
 188                                         <img src="../../media/images/Method.png" alt=" "/>
 189                                                                                         <span class="method-result">string</span>
 190                                                                                 <a href="#HiddenField" title="details" class="method-name">HiddenField</a>
 191                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvaluei</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fid</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fvalue</span>)
 192                                                                         </div>
 193
 194                                 <div class="method-definition">
 195                                         <img src="../../media/images/Method.png" alt=" "/>
 196                                                                                         <span class="method-result">string</span>
 197                                                                                 <a href="#MultiEntryLine" title="details" class="method-name">MultiEntryLine</a>
 198                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt_options</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prompt_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$default_prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span>)
 199                                                                         </div>
 200
 201                                 <div class="method-definition">
 202                                         <img src="../../media/images/Method.png" alt=" "/>
 203                                                                                         <span class="method-result">void</span>
 204                                                                                 <a href="#NoHelp" title="details" class="method-name">NoHelp</a>
 205                                                                                 ()
 206                                                                         </div>
 207
 208                                 <div class="method-definition">
 209                                         <img src="../../media/images/Method.png" alt=" "/>
 210                                                                                         <span class="method-result">void</span>
 211                                                                                 <a href="#PopulateForm" title="details" class="method-name">PopulateForm</a>
 212                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>)
 213                                                                         </div>
 214
 215                                 <div class="method-definition">
 216                                         <img src="../../media/images/Method.png" alt=" "/>
 217                                                                                         <span class="method-result">void</span>
 218                                                                                 <a href="#RevertLineFormat" title="details" class="method-name">RevertLineFormat</a>
 219                                                                                 ()
 220                                                                         </div>
 221
 222                                 <div class="method-definition">
 223                                         <img src="../../media/images/Method.png" alt=" "/>
 224                                                                                         <span class="method-result">void</span>
 225                                                                                 <a href="#SimpleForm" title="details" class="method-name">SimpleForm</a>
 226                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 227                                                                         </div>
 228
 229                                 <div class="method-definition">
 230                                         <img src="../../media/images/Method.png" alt=" "/>
 231                                                                                         <span class="method-result">string</span>
 232                                                                                 <a href="#StartForm" title="details" class="method-name">StartForm</a>
 233                                                                                         ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_attributes</span> = <span class="var-default">''</span>])
 234                                                                         </div>
 235
 236                                 <div class="method-definition">
 237                                         <img src="../../media/images/Method.png" alt=" "/>
 238                                                                                         <span class="method-result">string</span>
 239                                                                                 <a href="#SubmitButton" title="details" class="method-name">SubmitButton</a>
 240                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvalue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 241                                                                         </div>
 242
 243                                 <div class="method-definition">
 244                                         <img src="../../media/images/Method.png" alt=" "/>
 245                                                                                         <span class="method-result">void</span>
 246                                                                                 <a href="#TempLineFormat" title="details" class="method-name">TempLineFormat</a>
 247                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 248                                                                         </div>
 249                                                                                                                                                         </div>
 250                 </div>
 251         </div>
 252
 253
 254         <a name="sec-methods"></a>
 255         <div class="info-box">
 256                 <div class="info-box-title">Methods</div>
 257                 <div class="nav-bar">
 258                         <a href="#sec-description">Description</a> |
 259                                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 260
 261                 </div>
 262                 <div class="info-box-body">
 263
 264 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
 265
 266 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
 267 <A NAME='method_detail'></A>
 268 <a name="method_ParseAttributes" id="_ParseAttributes"><!-- --></a>
 269 <div class="evenrow">
 270
 271         <div class="method-header">
 272                 <img src="../../media/images/StaticMethod.png" />
 273                 <span class="method-title">static _ParseAttributes</span> (line <span class="line-number">532</span>)
 274         </div>
 275
 276         <!-- ========== Info from phpDoc block ========= -->
 277 <p class="short-description">Internal function for parsing the type extra on a field.</p>
 278 <p class="description"><p>If the '_help' attribute is not set it will be assigned the value of  the 'title' attribute, if there is one.</p><p>If the 'class' attribute is not set it will be assigned to 'flookup',  'fselect', etc, according to the field type.</p></p>
 279         <ul class="tags">
 280                                 <li><span class="field">return:</span> The parsed type extra.</li>
 281                         </ul>
 282
 283         <div class="method-signature">
 284                 static <span class="method-result">string</span>
 285                 <span class="method-name">
 286                         _ParseAttributes
 287                 </span>
 288                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 289                         </div>
 290
 291                         <ul class="parameters">
 292                                         <li>
 293                                 <span class="var-type"></span>
 294                                 <span class="var-name">$ftype</span>                    </li>
 295                                         <li>
 296                                 <span class="var-type"></span>
 297                                 <span class="var-name">$attributes</span>                       </li>
 298                                 </ul>
 299
 300
 301         </div>
 302 <a name="methodEntryForm" id="EntryForm"><!-- --></a>
 303 <div class="oddrow">
 304
 305         <div class="method-header">
 306                 <img src="../../media/images/Constructor.png" />
 307                 <span class="method-title">Constructor EntryForm</span> (line <span class="line-number">394</span>)
 308         </div>
 309
 310         <!-- ========== Info from phpDoc block ========= -->
 311 <p class="short-description">Initialise a new data-entry form.</p>
 312
 313         <div class="method-signature">
 314                 <span class="method-result">EntryForm</span>
 315                 <span class="method-name">
 316                         EntryForm
 317                 </span>
 318                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$editing</span> = <span class="var-default">false</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$editmode</span>)
 319                         </div>
 320
 321                         <ul class="parameters">
 322                                         <li>
 323                                 <span class="var-type">string</span>
 324                                 <span class="var-name">$action</span><span class="var-description">: The action when the form is submitted.</span>                      </li>
 325                                         <li>
 326                                 <span class="var-type">objectref</span>
 327                                 <span class="var-name">$record</span><span class="var-description">: A reference to the database object we are displaying / editing.</span>                     </li>
 328                                         <li>
 329                                 <span class="var-type">boolean</span>
 330                                 <span class="var-name">$editmode</span><span class="var-description">: Whether we are editing.</span>                   </li>
 331                                         <li>
 332                                 <span class="var-type"></span>
 333                                 <span class="var-name">&$record</span>                  </li>
 334                                         <li>
 335                                 <span class="var-type"></span>
 336                                 <span class="var-name">$editing</span>                  </li>
 337                                 </ul>
 338
 339
 340         </div>
 341 <a name="methodBreakLine" id="BreakLine"><!-- --></a>
 342 <div class="evenrow">
 343
 344         <div class="method-header">
 345                 <img src="../../media/images/Method.png" />
 346                 <span class="method-title">BreakLine</span> (line <span class="line-number">504</span>)
 347         </div>
 348
 349         <!-- ========== Info from phpDoc block ========= -->
 350 <p class="short-description">A utility function for a heading line within a data entry table</p>
 351         <ul class="tags">
 352                                 <li><span class="field">return:</span> The HTML fragment to end the form.</li>
 353                         </ul>
 354
 355         <div class="method-signature">
 356                 <span class="method-result">string</span>
 357                 <span class="method-name">
 358                         BreakLine
 359                 </span>
 360                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">''</span>])
 361                         </div>
 362
 363                         <ul class="parameters">
 364                                         <li>
 365                                 <span class="var-type"></span>
 366                                 <span class="var-name">$text</span>                     </li>
 367                                 </ul>
 368
 369
 370         </div>
 371 <a name="methodDataEntryField" id="DataEntryField"><!-- --></a>
 372 <div class="oddrow">
 373
 374         <div class="method-header">
 375                 <img src="../../media/images/Method.png" />
 376                 <span class="method-title">DataEntryField</span> (line <span class="line-number">563</span>)
 377         </div>
 378
 379         <!-- ========== Info from phpDoc block ========= -->
 380 <p class="short-description">A utility function for a data entry line within a table</p>
 381         <ul class="tags">
 382                                 <li><span class="field">return:</span> The HTML fragment to display the data entry field</li>
 383                         </ul>
 384
 385         <div class="method-signature">
 386                 <span class="method-result">string</span>
 387                 <span class="method-name">
 388                         DataEntryField
 389                 </span>
 390                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$base_fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 391                         </div>
 392
 393                         <ul class="parameters">
 394                                         <li>
 395                                 <span class="var-type"></span>
 396                                 <span class="var-name">$format</span>                   </li>
 397                                         <li>
 398                                 <span class="var-type"></span>
 399                                 <span class="var-name">$ftype</span>                    </li>
 400                                         <li>
 401                                 <span class="var-type"></span>
 402                                 <span class="var-name">$base_fname</span>                       </li>
 403                                         <li>
 404                                 <span class="var-type"></span>
 405                                 <span class="var-name">$attributes</span>                       </li>
 406                                         <li>
 407                                 <span class="var-type"></span>
 408                                 <span class="var-name">$prefix</span>                   </li>
 409                                 </ul>
 410
 411
 412         </div>
 413 <a name="methodDataEntryLine" id="DataEntryLine"><!-- --></a>
 414 <div class="evenrow">
 415
 416         <div class="method-header">
 417                 <img src="../../media/images/Method.png" />
 418                 <span class="method-title">DataEntryLine</span> (line <span class="line-number">639</span>)
 419         </div>
 420
 421         <!-- ========== Info from phpDoc block ========= -->
 422 <p class="short-description">A utility function for a data entry line within a table</p>
 423         <ul class="tags">
 424                                 <li><span class="field">return:</span> The HTML fragment to display the prompt and field.</li>
 425                         </ul>
 426
 427         <div class="method-signature">
 428                 <span class="method-result">string</span>
 429                 <span class="method-name">
 430                         DataEntryLine
 431                 </span>
 432                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$field_format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 433                         </div>
 434
 435                         <ul class="parameters">
 436                                         <li>
 437                                 <span class="var-type"></span>
 438                                 <span class="var-name">$prompt</span>                   </li>
 439                                         <li>
 440                                 <span class="var-type"></span>
 441                                 <span class="var-name">$field_format</span>                     </li>
 442                                         <li>
 443                                 <span class="var-type"></span>
 444                                 <span class="var-name">$ftype</span>                    </li>
 445                                         <li>
 446                                 <span class="var-type"></span>
 447                                 <span class="var-name">$fname</span>                    </li>
 448                                         <li>
 449                                 <span class="var-type"></span>
 450                                 <span class="var-name">$attributes</span>                       </li>
 451                                         <li>
 452                                 <span class="var-type"></span>
 453                                 <span class="var-name">$prefix</span>                   </li>
 454                                 </ul>
 455
 456
 457         </div>
 458 <a name="methodEndForm" id="EndForm"><!-- --></a>
 459 <div class="oddrow">
 460
 461         <div class="method-header">
 462                 <img src="../../media/images/Method.png" />
 463                 <span class="method-title">EndForm</span> (line <span class="line-number">496</span>)
 464         </div>
 465
 466         <!-- ========== Info from phpDoc block ========= -->
 467 <p class="short-description">Return the HTML fragment to end the form.</p>
 468         <ul class="tags">
 469                                 <li><span class="field">return:</span> The HTML fragment to end the form.</li>
 470                         </ul>
 471
 472         <div class="method-signature">
 473                 <span class="method-result">string</span>
 474                 <span class="method-name">
 475                         EndForm
 476                 </span>
 477                                 ()
 478                         </div>
 479
 480
 481
 482         </div>
 483 <a name="methodHelpInCell" id="HelpInCell"><!-- --></a>
 484 <div class="evenrow">
 485
 486         <div class="method-header">
 487                 <img src="../../media/images/Method.png" />
 488                 <span class="method-title">HelpInCell</span> (line <span class="line-number">434</span>)
 489         </div>
 490
 491         <!-- ========== Info from phpDoc block ========= -->
 492 <p class="short-description">Set the line format to have help displayed in it's own separate cell</p>
 493
 494         <div class="method-signature">
 495                 <span class="method-result">void</span>
 496                 <span class="method-name">
 497                         HelpInCell
 498                 </span>
 499                                 ()
 500                         </div>
 501
 502
 503
 504         </div>
 505 <a name="methodHelpInLine" id="HelpInLine"><!-- --></a>
 506 <div class="oddrow">
 507
 508         <div class="method-header">
 509                 <img src="../../media/images/Method.png" />
 510                 <span class="method-title">HelpInLine</span> (line <span class="line-number">426</span>)
 511         </div>
 512
 513         <!-- ========== Info from phpDoc block ========= -->
 514 <p class="short-description">Set the line format to have help displayed in the same cell as the entry field.</p>
 515
 516         <div class="method-signature">
 517                 <span class="method-result">void</span>
 518                 <span class="method-name">
 519                         HelpInLine
 520                 </span>
 521                                 ()
 522                         </div>
 523
 524
 525
 526         </div>
 527 <a name="methodHiddenField" id="HiddenField"><!-- --></a>
 528 <div class="evenrow">
 529
 530         <div class="method-header">
 531                 <img src="../../media/images/Method.png" />
 532                 <span class="method-title">HiddenField</span> (line <span class="line-number">516</span>)
 533         </div>
 534
 535         <!-- ========== Info from phpDoc block ========= -->
 536 <p class="short-description">A utility function for a hidden field within a data entry table</p>
 537         <ul class="tags">
 538                                 <li><span class="field">return:</span> The HTML fragment for the hidden field.</li>
 539                         </ul>
 540
 541         <div class="method-signature">
 542                 <span class="method-result">string</span>
 543                 <span class="method-name">
 544                         HiddenField
 545                 </span>
 546                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvaluei</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fid</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fvalue</span>)
 547                         </div>
 548
 549                         <ul class="parameters">
 550                                         <li>
 551                                 <span class="var-type">string</span>
 552                                 <span class="var-name">$fname</span><span class="var-description">: The name of the field.</span>                       </li>
 553                                         <li>
 554                                 <span class="var-type">string</span>
 555                                 <span class="var-name">$fvalue</span><span class="var-description">: The value of the field.</span>                     </li>
 556                                         <li>
 557                                 <span class="var-type"></span>
 558                                 <span class="var-name">$fvaluei</span>                  </li>
 559                                         <li>
 560                                 <span class="var-type"></span>
 561                                 <span class="var-name">$fid</span>                      </li>
 562                                 </ul>
 563
 564
 565         </div>
 566 <a name="methodMultiEntryLine" id="MultiEntryLine"><!-- --></a>
 567 <div class="oddrow">
 568
 569         <div class="method-header">
 570                 <img src="../../media/images/Method.png" />
 571                 <span class="method-title">MultiEntryLine</span> (line <span class="line-number">652</span>)
 572         </div>
 573
 574         <!-- ========== Info from phpDoc block ========= -->
 575 <p class="short-description">A utility function for a data entry line, where the prompt is a drop-down.</p>
 576         <ul class="tags">
 577                                 <li><span class="field">return:</span> The HTML fragment for the drop-down prompt and associated entry field.</li>
 578                         </ul>
 579
 580         <div class="method-signature">
 581                 <span class="method-result">string</span>
 582                 <span class="method-name">
 583                         MultiEntryLine
 584                 </span>
 585                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt_options</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prompt_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$default_prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span>)
 586                         </div>
 587
 588                         <ul class="parameters">
 589                                         <li>
 590                                 <span class="var-type"></span>
 591                                 <span class="var-name">$prompt_options</span>                   </li>
 592                                         <li>
 593                                 <span class="var-type"></span>
 594                                 <span class="var-name">$prompt_name</span>                      </li>
 595                                         <li>
 596                                 <span class="var-type"></span>
 597                                 <span class="var-name">$default_prompt</span>                   </li>
 598                                         <li>
 599                                 <span class="var-type"></span>
 600                                 <span class="var-name">$format</span>                   </li>
 601                                         <li>
 602                                 <span class="var-type"></span>
 603                                 <span class="var-name">$ftype</span>                    </li>
 604                                         <li>
 605                                 <span class="var-type"></span>
 606                                 <span class="var-name">$fname</span>                    </li>
 607                                         <li>
 608                                 <span class="var-type"></span>
 609                                 <span class="var-name">$attributes</span>                       </li>
 610                                         <li>
 611                                 <span class="var-type"></span>
 612                                 <span class="var-name">$prefix</span>                   </li>
 613                                 </ul>
 614
 615
 616         </div>
 617 <a name="methodNoHelp" id="NoHelp"><!-- --></a>
 618 <div class="evenrow">
 619
 620         <div class="method-header">
 621                 <img src="../../media/images/Method.png" />
 622                 <span class="method-title">NoHelp</span> (line <span class="line-number">418</span>)
 623         </div>
 624
 625         <!-- ========== Info from phpDoc block ========= -->
 626 <p class="short-description">Set the line format to have no help display</p>
 627
 628         <div class="method-signature">
 629                 <span class="method-result">void</span>
 630                 <span class="method-name">
 631                         NoHelp
 632                 </span>
 633                                 ()
 634                         </div>
 635
 636
 637
 638         </div>
 639 <a name="methodPopulateForm" id="PopulateForm"><!-- --></a>
 640 <div class="oddrow">
 641
 642         <div class="method-header">
 643                 <img src="../../media/images/Method.png" />
 644                 <span class="method-title">PopulateForm</span> (line <span class="line-number">408</span>)
 645         </div>
 646
 647         <!-- ========== Info from phpDoc block ========= -->
 648 <p class="short-description">Initialise some more of the forms fields, possibly with a prefix</p>
 649
 650         <div class="method-signature">
 651                 <span class="method-result">void</span>
 652                 <span class="method-name">
 653                         PopulateForm
 654                 </span>
 655                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>)
 656                         </div>
 657
 658                         <ul class="parameters">
 659                                         <li>
 660                                 <span class="var-type">objectref</span>
 661                                 <span class="var-name">$record</span><span class="var-description">: A reference to the database object we are displaying / editing.</span>                     </li>
 662                                         <li>
 663                                 <span class="var-type">string</span>
 664                                 <span class="var-name">$prefix</span><span class="var-description">: A prefix to prepend to the field name.</span>                      </li>
 665                                         <li>
 666                                 <span class="var-type"></span>
 667                                 <span class="var-name">&$record</span>                  </li>
 668                                 </ul>
 669
 670
 671         </div>
 672 <a name="methodRevertLineFormat" id="RevertLineFormat"><!-- --></a>
 673 <div class="evenrow">
 674
 675         <div class="method-header">
 676                 <img src="../../media/images/Method.png" />
 677                 <span class="method-title">RevertLineFormat</span> (line <span class="line-number">459</span>)
 678         </div>
 679
 680         <!-- ========== Info from phpDoc block ========= -->
 681 <p class="short-description">Revert the line format to what was in place before the last TempLineFormat call.</p>
 682
 683         <div class="method-signature">
 684                 <span class="method-result">void</span>
 685                 <span class="method-name">
 686                         RevertLineFormat
 687                 </span>
 688                                 ()
 689                         </div>
 690
 691
 692
 693         </div>
 694 <a name="methodSimpleForm" id="SimpleForm"><!-- --></a>
 695 <div class="oddrow">
 696
 697         <div class="method-header">
 698                 <img src="../../media/images/Method.png" />
 699                 <span class="method-title">SimpleForm</span> (line <span class="line-number">442</span>)
 700         </div>
 701
 702         <!-- ========== Info from phpDoc block ========= -->
 703 <p class="short-description">Set the line format to an extremely simple CSS based prompt / field layout.</p>
 704
 705         <div class="method-signature">
 706                 <span class="method-result">void</span>
 707                 <span class="method-name">
 708                         SimpleForm
 709                 </span>
 710                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 711                         </div>
 712
 713                         <ul class="parameters">
 714                                         <li>
 715                                 <span class="var-type"></span>
 716                                 <span class="var-name">$new_format</span>                       </li>
 717                                 </ul>
 718
 719
 720         </div>
 721 <a name="methodStartForm" id="StartForm"><!-- --></a>
 722 <div class="evenrow">
 723
 724         <div class="method-header">
 725                 <img src="../../media/images/Method.png" />
 726                 <span class="method-title">StartForm</span> (line <span class="line-number">470</span>)
 727         </div>
 728
 729         <!-- ========== Info from phpDoc block ========= -->
 730 <p class="short-description">Start the actual HTML form.  Return the fragment to do this.</p>
 731         <ul class="tags">
 732                                 <li><span class="field">return:</span> The HTML fragment for the start of the form.</li>
 733                         </ul>
 734
 735         <div class="method-signature">
 736                 <span class="method-result">string</span>
 737                 <span class="method-name">
 738                         StartForm
 739                 </span>
 740                                         ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_attributes</span> = <span class="var-default">''</span>])
 741                         </div>
 742
 743                         <ul class="parameters">
 744                                         <li>
 745                                 <span class="var-type">array</span>
 746                                 <span class="var-name">$extra_attributes</span><span class="var-description">: Extra key/value pairs for the FORM tag.</span>                   </li>
 747                                 </ul>
 748
 749
 750         </div>
 751 <a name="methodSubmitButton" id="SubmitButton"><!-- --></a>
 752 <div class="oddrow">
 753
 754         <div class="method-header">
 755                 <img src="../../media/images/Method.png" />
 756                 <span class="method-title">SubmitButton</span> (line <span class="line-number">629</span>)
 757         </div>
 758
 759         <!-- ========== Info from phpDoc block ========= -->
 760 <p class="short-description">A utility function for a submit button within a data entry table</p>
 761         <ul class="tags">
 762                                 <li><span class="field">return:</span> The HTML fragment to display a submit button for the form.</li>
 763                         </ul>
 764
 765         <div class="method-signature">
 766                 <span class="method-result">string</span>
 767                 <span class="method-name">
 768                         SubmitButton
 769                 </span>
 770                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvalue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 771                         </div>
 772
 773                         <ul class="parameters">
 774                                         <li>
 775                                 <span class="var-type"></span>
 776                                 <span class="var-name">$fname</span>                    </li>
 777                                         <li>
 778                                 <span class="var-type"></span>
 779                                 <span class="var-name">$fvalue</span>                   </li>
 780                                         <li>
 781                                 <span class="var-type"></span>
 782                                 <span class="var-name">$attributes</span>                       </li>
 783                                 </ul>
 784
 785
 786         </div>
 787 <a name="methodTempLineFormat" id="TempLineFormat"><!-- --></a>
 788 <div class="evenrow">
 789
 790         <div class="method-header">
 791                 <img src="../../media/images/Method.png" />
 792                 <span class="method-title">TempLineFormat</span> (line <span class="line-number">451</span>)
 793         </div>
 794
 795         <!-- ========== Info from phpDoc block ========= -->
 796 <p class="short-description">Set the line format to a temporary one that we can revert from.</p>
 797
 798         <div class="method-signature">
 799                 <span class="method-result">void</span>
 800                 <span class="method-name">
 801                         TempLineFormat
 802                 </span>
 803                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 804                         </div>
 805
 806                         <ul class="parameters">
 807                                         <li>
 808                                 <span class="var-type">string</span>
 809                                 <span class="var-name">$new_format</span><span class="var-description">: The (optional) new format we will temporarily use.</span>                      </li>
 810                                 </ul>
 811
 812
 813         </div>
 814
 815                 </div>
 816         </div>
 817
 818
 819
 820 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
 821         <p class="notes" id="credit">
 822                 Documentation generated on Sun, 17 Jun 2012 10:00:15 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 823         </p>
 824         </div></body>
 825 </html>