includes/ui/ui_controls.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 function get_post($name, $dflt='')
  13 {
  14         return ((!isset($_POST[$name]) || $_POST[$name] === '') ? $dflt : $_POST[$name]);
  15 }
  16 //---------------------------------------------------------------------------------
  17
  18 function start_form($multi=false, $dummy=false, $action="", $name="")
  19 {
  20         // $dummy - leaved for compatibility with 2.0 API
  21
  22         if ($name != "")
  23                 $name = "name='$name'";
  24         if ($action == "")
  25                 $action = $_SERVER['PHP_SELF'];
  26
  27         if ($multi)
  28                 echo "<form enctype='multipart/form-data' method='post' action='$action' $name>\n";
  29         else
  30                 echo "<form method='post' action='$action' $name>\n";
  31
  32 }
  33
  34 //---------------------------------------------------------------------------------
  35
  36 function end_form($breaks=0)
  37 {
  38         if ($breaks)
  39                 br($breaks);
  40         echo "<input type=\"hidden\" name=\"_focus\" value=\"".get_post('_focus')."\">\n";
  41         echo "</form>\n";
  42 }
  43
  44 function start_table($extra="", $padding='2', $spacing='0')
  45 {
  46         echo "<center><table";
  47         if ($extra != "")
  48                 echo " $extra";
  49         echo " cellpadding=$padding cellspacing=$spacing>\n";
  50 }
  51
  52 function end_table($breaks=0)
  53 {
  54         echo "</table></center>\n";
  55         if ($breaks)
  56                 br($breaks);
  57 }
  58
  59 function start_outer_table($extra="", $padding='2', $spacing='0', $br=false)
  60 {
  61         if ($br)
  62                 br();
  63         start_table($extra, $padding, $spacing);
  64         echo "<tr valign=top><td>\n"; // outer table
  65 }
  66
  67 function table_section($number=1, $width=false)
  68 {
  69         if ($number > 1)
  70         {
  71                 echo "</table>\n";
  72                 $width = ($width ? "width=$width" : "");
  73                 echo "</td><td class='tableseparator' $width>\n"; // outer table
  74         }
  75         echo "<table>\n";
  76 }
  77
  78 function end_outer_table($breaks=0, $close_table=true)
  79 {
  80         if ($close_table)
  81                 echo "</table>\n";
  82         echo "</td></tr>\n";
  83         end_table($breaks);
  84 }
  85 //
  86 //  outer table spacer
  87 //
  88 function vertical_space($params='')
  89 {
  90         echo "</td></tr><tr><td valign=center $params>";
  91 }
  92
  93 function meta_forward($forward_to, $params="")
  94 {
  95     global $Ajax;
  96         echo "<meta http-equiv='Refresh' content='0; url=$forward_to?$params'>\n";
  97         echo "<center><br>" . _("You should automatically be forwarded.");
  98         echo " " . _("If this does not happen") . " " . "<a href='$forward_to?$params'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
  99         if ($params !='') $params = '?'.$params;
 100         $Ajax->redirect($forward_to.$params);
 101         exit;
 102 }
 103
 104 //-----------------------------------------------------------------------------------
 105 // Find and replace hotkey marker.
 106 // if $clean == true marker is removed and clean label is returned
 107 // (for use in wiki help system), otherwise result is array of label
 108 // with underlined hotkey letter and access property string.
 109 //
 110 function access_string($label, $clean=false)
 111 {
 112         $access = '';
 113         $slices = array();
 114
 115         if (preg_match('/(.*)&([a-zA-Z0-9])(.*)/', $label, $slices))
 116         {
 117                 $label = $clean ? $slices[1].$slices[2].$slices[3] :
 118                         $slices[1].'<u>'.$slices[2].'</u>'.$slices[3];
 119                 $access = " accesskey='".strtoupper($slices[2])."'";
 120         }
 121
 122         $label = str_replace( '&&', '&', $label);
 123
 124         return $clean ? $label : array($label, $access);
 125 }
 126
 127 function hyperlink_back($center=true)
 128 {
 129         if ($center)
 130                 echo "<center>";
 131         echo "<p><a href='javascript:goBack();'>"._("Back")."</a></p>\n";
 132         if ($center)
 133                 echo "</center>";
 134         echo "<br>";
 135 }
 136
 137 function hyperlink_no_params($target, $label, $center=true)
 138 {
 139         $id = default_focus();
 140         $pars = access_string($label);
 141         if ($target == '')
 142                 $target = $_SERVER['PHP_SELF'];
 143         if ($center)
 144                 echo "<br><center>";
 145         echo "<a href='$target' $id='$id' $pars[1]>$pars[0]</a>\n";
 146         if ($center)
 147                 echo "</center>";
 148 }
 149
 150 function hyperlink_no_params_td($target, $label)
 151 {
 152         echo "<td>";
 153         hyperlink_no_params($target, $label);
 154         echo "</td>\n";
 155 }
 156
 157 function viewer_link($label, $url='', $class='', $id='',  $icon=null)
 158 {
 159         global $path_to_root;
 160
 161         if ($class != '')
 162                 $class = " class='$class'";
 163
 164         if ($id != '')
 165                 $class = " id='$id'";
 166
 167         if ($url != "")
 168         {
 169                 $pars = access_string($label);
 170                 if (user_graphic_links() && $icon)
 171                         $pars[0] = set_icon($icon, $pars[0]);
 172                 $preview_str = "<a target='_blank' $class $id href='$path_to_root/$url' onclick=\"javascript:openWindow(this.href,this.target); return false;\"$pars[1]>$pars[0]</a>";
 173         }
 174         else
 175                 $preview_str = $label;
 176
 177  return $preview_str;
 178 }
 179
 180 function menu_link($url, $label, $id=null)
 181 {
 182
 183         $id = default_focus($id);
 184         $pars = access_string($label);
 185         return "<a href='$url' class='menu_option' id='$id' $pars[1]>$pars[0]</a>";
 186 }
 187
 188 function submenu_option($title, $url, $id=null)
 189 {
 190         global $path_to_root;
 191         display_note(menu_link($path_to_root . $url, $title, $id), 0, 1);
 192 }
 193
 194 function submenu_view($title, $type, $number, $id=null)
 195 {
 196         display_note(get_trans_view_str($type, $number, $title, false, 'menu_option', $id), 0, 1);
 197 }
 198
 199 function submenu_print($title, $type, $number, $id=null)
 200 {
 201         display_note(print_document_link($number, $title, true, $type, false, 'menu_option', $id), 0, 1);
 202 }
 203 //-----------------------------------------------------------------------------------
 204
 205 function hyperlink_params($target, $label, $params, $center=true)
 206 {
 207         $id = default_focus();
 208
 209         $pars = access_string($label);
 210         if ($target == '')
 211                 $target = $_SERVER['PHP_SELF'];
 212         if ($center)
 213                 echo "<br><center>";
 214         echo "<a id='$id' href='$target?$params'$pars[1]>$pars[0]</a>\n";
 215         if ($center)
 216                 echo "</center>";
 217 }
 218
 219 function hyperlink_params_td($target, $label, $params)
 220 {
 221         echo "<td>";
 222         hyperlink_params($target, $label, $params, false);
 223         echo "</td>\n";
 224 }
 225
 226 //-----------------------------------------------------------------------------------
 227
 228 function hyperlink_params_separate($target, $label, $params, $center=false)
 229 {
 230         $id = default_focus();
 231
 232         $pars = access_string($label);
 233         if ($center)
 234                 echo "<br><center>";
 235         echo "<a target='_blank' $id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
 236         if ($center)
 237                 echo "</center>";
 238 }
 239
 240 function hyperlink_params_separate_td($target, $label, $params)
 241 {
 242         echo "<td>";
 243         hyperlink_params_separate($target, $label, $params);
 244         echo "</td>\n";
 245 }
 246
 247 //--------------------------------------------------------------------------------------------------
 248
 249 function alt_table_row_color(&$k)
 250 {
 251         if ($k == 1)
 252         {
 253                 echo "<tr class='oddrow'>\n";
 254                 $k = 0;
 255         }
 256         else
 257         {
 258                 echo "<tr class='evenrow'>\n";
 259                 $k++;
 260         }
 261 }
 262
 263 function table_section_title($msg, $colspan=2)
 264 {
 265         echo "<tr><td colspan=$colspan class='tableheader'>$msg</td></tr>\n";
 266 }
 267
 268 function table_header($labels, $params='')
 269 {
 270         start_row();
 271         foreach ($labels as $label)
 272                 labelheader_cell($label, $params);
 273         end_row();
 274 }
 275 //-----------------------------------------------------------------------------------
 276
 277 function start_row($param="")
 278 {
 279         if ($param != "")
 280                 echo "<tr $param>\n";
 281         else
 282                 echo "<tr>\n";
 283 }
 284
 285 function end_row()
 286 {
 287         echo "</tr>\n";
 288 }
 289
 290 function br($num=1)
 291 {
 292         for ($i = 0; $i < $num; $i++)
 293                 echo "<br>";
 294 }
 295
 296 $ajax_divs = array();
 297
 298 function div_start($id='', $trigger=null, $non_ajax=false)
 299 {
 300     global $ajax_divs;
 301
 302         if ($non_ajax) { // div for non-ajax elements
 303                 array_push($ajax_divs, array($id, null));
 304                 echo "<div style='display:none' class='js_only' ".($id !='' ? "id='$id'" : '').">";
 305         } else { // ajax ready div
 306                 array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
 307                 echo "<div ". ($id !='' ? "id='$id'" : '').">";
 308                 ob_start();
 309         }
 310 }
 311
 312 function div_end()
 313 {
 314     global $ajax_divs, $Ajax;
 315
 316     if (count($ajax_divs))
 317     {
 318                 $div = array_pop($ajax_divs);
 319                 if ($div[1] !== null)
 320                         $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
 321                 echo "</div>";
 322     }
 323 }
 324
 325 /* Table editor interfaces. Key is editor type
 326         0 => url of editor page
 327         1 => hotkey code
 328         2 => context help
 329 */
 330 $popup_editors = array(
 331         'customer' => array('/sales/manage/customers.php?debtor_no=',
 332                 113,    _("Customers")),
 333         'branch' => array('/sales/manage/customer_branches.php?SelectedBranch=',
 334                 114, _("Branches")),
 335         'supplier' => array('/purchasing/manage/suppliers.php?supplier_id=',
 336                 113, _("Suppliers")),
 337         'item' => array('/inventory/manage/items.php?stock_id=',
 338                 115, _("Items"))
 339 );
 340 /*
 341         Bind editors for various selectors.
 342         $type - type of editor
 343         $input - name of related input field
 344         $caller - optional function key code (available values F1-F12: 112-123,
 345                 true: default)
 346 */
 347 function set_editor($type, $input, $caller=true)
 348 {
 349         global $path_to_root, $Editors, $popup_editors, $Pagehelp;
 350
 351         $key = $caller===true ? $popup_editors[$type][1] : $caller;
 352
 353         $Editors[$key] = array( $path_to_root . $popup_editors[$type][0], $input);
 354
 355         $help = 'F' . ($key - 111) . ' - ';
 356         $help .= $popup_editors[$type][2];
 357         $Pagehelp[] = $help;
 358 }
 359 //------------------------------------------------------------------------------
 360 // Procedures below are now obsolete. Preserved for eventual future use.
 361
 362 /*
 363         External page call with saving current context.
 364         $call - url of external page
 365         $ctx - optional. name of SESSION context object or array of names of POST
 366                 variables saved on call
 367 */
 368 function context_call($call, $ctx='')
 369 {
 370         if (is_array($ctx))
 371         {
 372                 foreach($ctx as $postname)
 373                 {
 374                         $context[$postname] = get_post($postname);
 375                 }
 376         } else
 377                 $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
 378
 379         array_unshift($_SESSION['Context'], array('name' => $ctx,
 380                 'ctx' => $context,
 381                 'caller' => $_SERVER['PHP_SELF'],
 382                 'ret' => array()));
 383         meta_forward($call);
 384 }
 385 /*
 386         Restores context after external page call and
 387         returns array of data passed by external page.
 388 */
 389 function context_restore()
 390 {
 391         if ( count($_SESSION['Context'])) {
 392                 if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
 393                         $ctx = array_shift($_SESSION['Context']);
 394                         if ($ctx) {
 395                                 if (is_array($ctx['ctx'])) {
 396                                         foreach($ctx['ctx'] as $name => $val)
 397                                         {
 398                                                 $_POST[$name] = $val;
 399                                         }
 400                                 } else
 401                                         if ($ctx['name']!='')
 402                                                 $_SESSION[$ctx['name']] = $ctx['ctx'];
 403                                 return $ctx['ret'];
 404                         }
 405                 }
 406         }
 407         return false;
 408 }
 409
 410 /*
 411         Return to caller page if the page was called from external context.
 412 */
 413 function context_return($ret)
 414 {
 415         if ( count($_SESSION['Context'])) {
 416                 $ctx = &$_SESSION['Context'][0];
 417                 $ctx['ret'] = $ret;
 418                 meta_forward( $ctx['caller'] );
 419         }
 420 }
 421 /*
 422         Clearing context stack after page cancel.
 423 */
 424 function context_reset()
 425 {
 426         $_SESSION['Context'] = array();
 427 }
 428 /*
 429         Context stack initialization
 430 */
 431 if (!isset($_SESSION['Context'])) {
 432                 context_reset();
 433 }
 434 /*
 435         Redirector for selector F4 calls.
 436         $sel_editors is array of selname=>editor_page
 437 */
 438 function editor_redirect($sel_editors, $save_fun='') {
 439         foreach ($sel_editors as $selname=>$editor)
 440                 if (isset($_POST['_'.$selname.'_editor'])) {
 441                         if (function_exists($save_fun))
 442                                 $save_fun();
 443                         unset($_POST['_'.$selname.'_editor']);
 444                         context_call($editor, array_keys($_POST));
 445                 }
 446 }
 447 /*
 448         Return procedure for selector F4 calls
 449 */
 450 function editor_return($vars, $restore_fun='') {
 451         if (function_exists($restore_fun))
 452                 $restore_fun();
 453
 454         if ($ret = context_restore()) {
 455                 foreach ($vars as $postname=>$retname)
 456                         if (isset($ret[$retname])) {
 457                                 $_POST[$postname] = $ret[$retname];
 458                                 set_focus($postname);
 459                         }
 460         }
 461 }
 462
 463 ?>