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