7b518e57108cb567944bd59937a8809a52c18001
[fa-stable.git] / 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 /*
326         Bind editors for various selectors.
327         $type - type of editor
328         $input - array org_input => editor_input
329         $focus - focus after selection
330 */
331 function set_editor($type, $input, $focus=null) 
332 {
333         global $path_to_root, $Editors;
334         // table of table editor interfaces.
335         // key is editor type, values contain:
336         // 0 => url of editor page
337         // 1 => array of names of parameters returned back from editor interface
338         // 2 => hotkey code
339
340         if($focus === null) {
341                 $focus = $caller;
342         }
343         $urls = array(
344                 'customer' => array('/sales/manage/customers.php?debtor_no=', 
345                         113,    _("F2 - Customers")),
346                 'branch' => array('/sales/manage/customer_branches.php?SelectedBranch=', 
347                         114, _("F3 - Branches")),
348                 'supplier' => array('/purchasing/manage/suppliers.php?supplier_id=', 
349                         113, _("F2 - Suppliers")),
350                 'item' => array('/inventory/manage/items.php?stock_id=', 
351                         115, _("F4 - Items"))
352         );
353         $back = array();
354         $caller = $urls[$type][1];
355         $Editors[$caller] = array( $path_to_root . $urls[$type][0], $input, $focus);
356
357 // FIX status comments
358
359 }
360 //------------------------------------------------------------------------------
361 // Procedures below are now obsolete. Preserved for eventual future use.
362
363 /*
364         External page call with saving current context.
365         $call - url of external page
366         $ctx - optional. name of SESSION context object or array of names of POST 
367                 variables saved on call
368 */
369 function context_call($call, $ctx='')
370 {
371         if (is_array($ctx)) 
372         {
373                 foreach($ctx as $postname)
374                 {
375                         $context[$postname] = get_post($postname);
376                 }
377         } else 
378                 $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
379
380         array_unshift($_SESSION['Context'], array('name' => $ctx, 
381                 'ctx' => $context,
382                 'caller' => $_SERVER['PHP_SELF'],
383                 'ret' => array()));
384         meta_forward($call);
385 }
386 /*
387         Restores context after external page call and
388         returns array of data passed by external page.
389 */
390 function context_restore()
391 {
392         if ( count($_SESSION['Context'])) {
393                 if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
394                         $ctx = array_shift($_SESSION['Context']);
395                         if ($ctx) {
396                                 if (is_array($ctx['ctx'])) {
397                                         foreach($ctx['ctx'] as $name => $val) 
398                                         {
399                                                 $_POST[$name] = $val;
400                                         }
401                                 } else
402                                         if ($ctx['name']!='')
403                                                 $_SESSION[$ctx['name']] = $ctx['ctx'];
404                                 return $ctx['ret'];
405                         }
406                 }
407         }
408         return false;
409 }
410
411 /*
412         Return to caller page if the page was called from external context.
413 */
414 function context_return($ret)
415 {
416         if ( count($_SESSION['Context'])) {
417                 $ctx = &$_SESSION['Context'][0];
418                 $ctx['ret'] = $ret;
419                 meta_forward( $ctx['caller'] );
420         }
421 }
422 /*
423         Clearing context stack after page cancel.
424 */
425 function context_reset()
426 {
427         $_SESSION['Context'] = array();
428 }
429 /*
430         Context stack initialization
431 */
432 if (!isset($_SESSION['Context'])) {
433                 context_reset();
434 }
435 /*
436         Redirector for selector F4 calls.
437         $sel_editors is array of selname=>editor_page
438 */
439 function editor_redirect($sel_editors, $save_fun='') {
440         foreach ($sel_editors as $selname=>$editor)
441                 if (isset($_POST['_'.$selname.'_editor'])) {
442                         if (function_exists($save_fun))
443                                 $save_fun();
444                         unset($_POST['_'.$selname.'_editor']);
445                         context_call($editor, array_keys($_POST));
446                 }
447 }
448 /*
449         Return procedure for selector F4 calls
450 */
451 function editor_return($vars, $restore_fun='') {
452         if (function_exists($restore_fun))
453                 $restore_fun();
454
455         if ($ret = context_restore()) {
456                 foreach ($vars as $postname=>$retname)
457                         if (isset($ret[$retname])) {
458                                 $_POST[$postname] = $ret[$retname];
459                                 set_focus($postname);
460                         }
461         }
462 }
463
464 ?>