egroupware/etemplate/inc/class.uietemplate.inc.php

901 lines
32 KiB
PHP
Raw Normal View History

2002-02-06 10:03:11 +01:00
<?php
/**************************************************************************\
* phpGroupWare - EditableTemplates - HTML User Interface *
* http://www.phpgroupware.org *
* Written by Ralf Becker <RalfBecker@outdoor-training.de> *
* -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the *
* Free Software Foundation; either version 2 of the License, or (at your *
* option) any later version. *
\**************************************************************************/
/* $Id$ */
include(PHPGW_API_INC . '/../../etemplate/inc/class.boetemplate.inc.php');
/*!
@class etemplate
@author ralfbecker
2002-02-06 10:03:11 +01:00
@abstract creates dialogs / HTML-forms from eTemplate descriptions
@discussion etemplate or uietemplate extends boetemplate, all vars and public functions are inherited
@example $tmpl = CreateObject('etemplate.etemplate','app.template.name');
@example $tmpl->exec('app.class.callback',$content_to_show);
@example This creates a form from the eTemplate 'app.template.name' and takes care that
@example the method / public function 'callback' in (bo)class 'class' of 'app' gets called
@example if the user submitts the form. Vor the complete param's see the description of exec.
@param $debug enables debug messages: 0=no, 1=calls to show and process_show, 2=content of process_show
@param 3=calls to show_cell OR template- or cell-type name
@param $html,$sbox instances of html and sbox2 class used to generate the html
*/
class etemplate extends boetemplate
{
var $debug; // 1=calls to show and process_show, 2=content after process_show,
// 3=calls to show_cell and process_show_cell, or template-name or cell-type
2002-02-06 10:03:11 +01:00
var $html,$sbox; // instance of html / sbox2-class
var $loop = 0; // set by process_show if an other Exec-ProcessExec loop is needed
2002-02-06 10:03:11 +01:00
/*!
@function etemplate
@abstract constructor of etemplate class, reads an eTemplate if $name is given
@param as soetemplate.read
*/
function etemplate($name='',$template='default',$lang='default',$group=0,$version='',$rows=2,$cols=2)
{
$this->public_functions += array(
'exec' => True,
'process_exec' => True,
'show' => True,
'process_show' => True,
2002-02-06 10:03:11 +01:00
);
$this->boetemplate();
$this->html = CreateObject('etemplate.html'); // should be in the api (older version in infolog)
$this->sbox = CreateObject('etemplate.sbox2'); // older version is in the api
2002-02-06 10:03:11 +01:00
if (!$this->read($name,$template,$lang,$group,$version))
{
$this->init($name,$template,$lang,$group,$version,$rows,$cols);
return False;
}
return True;
}
/*!
@function exec
@abstract Generats a Dialog from an eTemplate - abstract the UI-layer
@discussion This is the only function an application should use, all other are INTERNAL and
@discussion do NOT abstract the UI-layer, because they return HTML.
@discussion Generates a webpage with a form from the template and puts process_exec in the
@discussion form as submit-url to call process_show for the template before it
@discussion ExecuteMethod's the given $methode of the caller.
@param $methode Methode (e.g. 'etemplate.editor.edit') to be called if form is submitted
@param $content Array with content to fill the input-fields of template, eg. the text-field
@param with name 'name' gets its content from $content['name']
@param $sel_options Array or arrays with the options for each select-field, keys are the
@param field-names, eg. array('name' => array(1 => 'one',2 => 'two')) set the
@param options for field 'name'. ($content['options-name'] is possible too !!!)
@param $readonlys Array with field-names as keys for fields with should be readonly
@param (eg. to implement ACL grants on field-level or to remove buttons not applicable)
@param $preserv Array with vars which should be transported to the $method-call (eg. an id) array('id' => $id) sets $HTTP_POST_VARS['id'] for the $method-call
@result nothing
2002-02-06 10:03:11 +01:00
*/
function exec($method,$content,$sel_options='',$readonlys='',$preserv='',$changes='')
2002-02-06 10:03:11 +01:00
{
//echo "<br>globals[java_script] = '".$GLOBALS['phpgw_info']['etemplate']['java_script']."', this->java_script() = '".$this->java_script()."'\n";
if (!$sel_options)
2002-02-06 10:03:11 +01:00
{
$sel_options = array();
}
if (!$readonlys)
2002-02-06 10:03:11 +01:00
{
$readonlys = array();
}
if (!$preserv)
2002-02-06 10:03:11 +01:00
{
$preserv = array();
}
if (!$changes)
{
$changes = array();
}
2002-02-06 10:03:11 +01:00
$GLOBALS['phpgw']->common->phpgw_header();
$id = $this->appsession_id();
$GLOBALS['phpgw_info']['etemplate']['form_options'] = ''; // might be set in show
$html .= $this->html->nextMatchStyles($this->style)."\n\n". // so they get included once
$this->html->form($this->include_java_script() .
$this->show($this->complete_array_merge($content,$changes),$sel_options,$readonlys,'exec'),
array('etemplate_exec_id' => $id),
'/index.php?menuaction=etemplate.etemplate.process_exec','','eTemplate',
$GLOBALS['phpgw_info']['etemplate']['form_options']);
$id = $this->save_appsession($this->as_array(1) + array(
'readonlys' => $readonlys,
'content' => $content,
'changes' => $changes,
'sel_options' => $sel_options,
'preserv' => $preserv,
'extension_data' => $GLOBALS['phpgw_info']['etemplate']['extension_data'],
'java_script' => $GLOBALS['phpgw_info']['etemplate']['java_script'],
'method' => $method
),$id);
list($a,$b,$c,$d) = explode('.',$GLOBALS['phpgw_info']['server']['versions']['phpgwapi']);
//echo "Version: $a.$b.$c.$d\n";
if ($a <= 0 && $b <= 9 && $c <= 14)
{
echo parse_navbar() . $html;
}
else
{
echo $html;
// this removes {} eg.'${test}' -> '$' $GLOBALS['phpgw']->template->set_var('phpgw_body',$html);
}
2002-02-06 10:03:11 +01:00
}
/*!
@function process_exec
@abstract Makes the necessary adjustments to HTTP_POST_VARS before it calls the app's method
@discussion This function is only to submit forms to, create with exec.
@discussion All eTemplates / forms executed with exec are submited to this function
@discussion (via the global index.php and menuaction). It then calls process_show
@discussion for the eTemplate (to adjust the content of the HTTP_POST_VARS) and
@discussion ExecMethod's the given callback from the app with the content of the form as first argument.
2002-02-06 10:03:11 +01:00
*/
function process_exec()
{
//echo "process_exec: HTTP_POST_VARS ="; _debug_array($GLOBALS['HTTP_POST_VARS']);
$session_data = $this->get_appsession($GLOBALS['HTTP_POST_VARS']['etemplate_exec_id']);
//echo "<p>process_exec: session_data ="; _debug_array($session_data);
2002-02-06 10:03:11 +01:00
$content = $GLOBALS['HTTP_POST_VARS']['exec'];
if (!is_array($content))
{
$content = array();
}
$this->init($session_data);
$GLOBALS['phpgw_info']['etemplate']['extension_data'] = $session_data['extension_data'];
$GLOBALS['phpgw_info']['etemplate']['java_script'] = $session_data['java_script'] || $GLOBALS['HTTP_POST_VARS']['java_script'];
//echo "globals[java_script] = '".$GLOBALS['phpgw_info']['etemplate']['java_script']."', session_data[java_script] = '".$session_data['java_script']."', HTTP_POST_VARS[java_script] = '".$GLOBALS['HTTP_POST_VARS']['java_script']."'\n";
//echo "process_exec($this->name) content ="; _debug_array($content);
$this->process_show($content,$session_data['readonlys']);
2002-02-06 10:03:11 +01:00
//echo "process_exec($this->name) process_show(content) ="; _debug_array($content);
//echo "process_exec($this->name) session_data[changes] ="; _debug_array($session_data['changes']);
$content = $this->complete_array_merge($session_data['changes'],$content);
//echo "process_exec($this->name) merge(changes,content) ="; _debug_array($content);
2002-02-06 10:03:11 +01:00
if ($this->loop)
{
//echo "<p>process_exec($this->name): <font color=red>loop is set</font>, content=</p>\n"; _debug_array($content);
$this->exec($session_data['method'],$session_data['content'],$session_data['sel_options'],
$session_data['readonlys'],$session_data['preserv'],$content);
}
else
{
// set application name so that lang, etc. works
list($GLOBALS['phpgw_info']['flags']['currentapp']) = explode('.',$session_data['method']);
ExecMethod($session_data['method'],$this->complete_array_merge($content,$session_data['preserv']));
}
2002-02-06 10:03:11 +01:00
}
/*!
@function show
@abstract creates HTML from an eTemplate
@discussion This is done by calling show_cell for each cell in the form. show_cell itself
@discussion calls show recursivly for each included eTemplate.
@discussion You can use it in the UI-layer of an app, just make shure to call process_show !!!
@discussion This is intended as internal function and should NOT be called by new app's direct,
@discussion as it deals with HTML and is so UI-dependent, use exec instead.
@param $content array with content for the cells, keys are the names given in the cells/form elements
@param $sel_options array with options for the selectboxes, keys are the name of the selectbox
@param $readonlys array with names of cells/form-elements to be not allowed to change
@param This is to facilitate complex ACL's which denies access on field-level !!!
@param $cname basename of names for form-elements, means index in $HTTP_POST_VARS
@param eg. $cname='cont', element-name = 'name' returned content in $HTTP_POST_VARS['cont']['name']
@param $show_xxx row,col name/index for name expansion
@result the generated HTML
2002-02-06 10:03:11 +01:00
*/
function show($content,$sel_options='',$readonlys='',$cname='cont',$show_c=0,$show_row=0)
2002-02-06 10:03:11 +01:00
{
if (!$sel_options)
2002-02-06 10:03:11 +01:00
{
$sel_options = array();
}
if (!$readonlys)
2002-02-06 10:03:11 +01:00
{
$readonlys = array();
}
if ($this->debug >= 1 || $this->debug == $this->name && $this->name)
{
echo "<p>etemplate.show($this->name): $cname =\n"; _debug_array($content);
}
if (!is_array($content))
{
$content = array(); // happens if incl. template has no content
}
$content += array( // for var-expansion in names in show_cell
'.c' => $show_c,
2002-02-06 10:03:11 +01:00
'.col' => $this->num2chrs($show_c-1),
'.row' => $show_row
2002-02-06 10:03:11 +01:00
);
reset($this->data);
2002-02-06 10:03:11 +01:00
if (isset($this->data[0]))
{
list($nul,$width) = each($this->data);
}
else
{
$width = array();
}
for ($r = 0; $row = 1+$r /*list($row,$cols) = each($this->data)*/; ++$r)
{
$old_cols = $cols; $old_class = $class; $old_height = $height;
if (!(list($nul,$cols) = each($this->data))) // no further row
{
$cols = $old_cols; $class = $old_class; $height = $old_height;
list($nul,$cell) = each($cols); reset($cols);
if (!($this->autorepeat_idx($cols['A'],0,$r,$idx,$idx_cname) && $idx_cname) &&
!($this->autorepeat_idx($cols['B'],1,$r,$idx,$idx_cname) && $idx_cname) ||
!$this->isset_array($content,$idx))
2002-02-06 10:03:11 +01:00
{
break; // no auto-row-repeat
2002-02-06 10:03:11 +01:00
}
}
else
{
$height = $this->data[0]["h$row"];
$class = $this->data[0]["c$row"];
}
$row_data = array();
for ($c = 0; True /*list($col,$cell) = each($cols)*/; ++$c)
{
$old_cell = $cell;
if (!(list($nul,$cell) = each($cols))) // no further cols
2002-02-06 10:03:11 +01:00
{
$cell = $old_cell;
if (!$this->autorepeat_idx($cell,$c,$r,$idx,$idx_cname,True) ||
!$this->isset_array($content,$idx))
2002-02-06 10:03:11 +01:00
{
break; // no auto-col-repeat
}
}
$col = $this->num2chrs($c);
$row_data[$col] = $this->show_cell($cell,$content,$sel_options,$readonlys,$cname,
$c,$r,$span);
2002-02-06 10:03:11 +01:00
if ($row_data[$col] == '' && $this->rows == 1)
{
unset($row_data[$col]); // omit empty/disabled cells if only one row
continue;
}
$colspan = $span == 'all' ? $this->cols-$c : 0+$span;
if ($colspan > 1)
{
$row_data[".$col"] .= " COLSPAN=$colspan";
for ($i = 1; $i < $colspan; ++$i,++$c)
{
each($cols); // skip next cell(s)
}
}
elseif ($width[$col]) // width only once for a non colspan cell
{
$row_data[".$col"] .= ' WIDTH='.$width[$col];
$width[$col] = 0;
}
$row_data[".$col"] .= $this->html->formatOptions($cell['align'],'ALIGN');
$row_data[".$col"] .= $this->html->formatOptions($cell['span'],',CLASS');
}
$rows[$row] = $row_data;
$rows[".$row"] .= $this->html->formatOptions($height,'HEIGHT');
list($cl) = explode(',',$class);
if ($cl == 'nmr')
{
$cl .= $nmr_alternate++ & 1; // alternate color
}
$rows[".$row"] .= $this->html->formatOptions($cl,'CLASS');
$rows[".$row"] .= $this->html->formatOptions($class,',VALIGN');
}
if (!$GLOBALS['phpgw_info']['etemplate']['styles_included'][$this->name])
{
$style = $this->html->style($this->style);
$GLOBALS['phpgw_info']['etemplate']['styles_included'][$this->name] = True;
}
list(,,$border) = explode(',',$this->size);
2002-02-06 10:03:11 +01:00
return "\n\n<!-- BEGIN $this->name -->\n$style\n".
$this->html->table($rows,$this->html->formatOptions($this->size,'WIDTH,HEIGHT,BORDER,CLASS,CELLSPACING,CELLPADDING')).
"<!-- END $this->name -->\n\n";
2002-02-06 10:03:11 +01:00
}
/*!
@function show_cell
@abstract generates HTML for 1 input-field / cell
@discussion calls show to generate included eTemplates. Again only an INTERMAL function.
@param $cell array with data of the cell: name, type, ...
@param for rest see show
@result the generated HTML
2002-02-06 10:03:11 +01:00
*/
function show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span)
{
if ($this->debug >= 3 || $this->debug == $cell['type'])
{
echo "<p>etemplate.show_cell($this->name,name='${cell['name']}',type='${cell['type']}',cname='$cname')</p>\n";
}
list($span) = explode(',',$cell['span']); // evtl. overriten later for type template
if ($cell['name'][0] == '@')
{
$cell['name'] = $this->get_array($content,substr($cell['name'],1));
}
2002-02-06 10:03:11 +01:00
$name = $this->expand_name($cell['name'],$show_c,$show_row,$content['.c'],$content['.row'],$content);
if (strstr($name,'|')) // extension which uses whole content array
{
$value = $content;
}
elseif (ereg('^([^[]*)(\\[.*\\])$',$name,$regs)) // name contains array-index
2002-02-06 10:03:11 +01:00
{
$form_name = $cname == '' ? $name : $cname.'['.$regs[1].']'.$regs[2];
eval(str_replace(']',"']",str_replace('[',"['",'$value = $content['.$regs[1].']'.$regs[2].';')));
$org_name = substr($regs[2],1,-1);
2002-02-06 10:03:11 +01:00
}
else
{
$form_name = $cname == '' ? $name : $cname.'['.$name.']';
$value = $content[$name];
$org_name = $name;
2002-02-06 10:03:11 +01:00
}
if ($readonly = $cell['readonly'] || $readonlys[$name] || $readonlys['__ALL__'])
{
$options .= ' READONLY';
}
if ($cell['disabled'] || $readonly && $cell['type'] == 'button' && !strstr($cell['size'],','))
2002-02-06 10:03:11 +01:00
{
if ($this->rows == 1) {
2002-02-06 10:03:11 +01:00
return ''; // if only one row omit cell
}
$cell = $this->empty_cell(); // show nothing
$value = '';
}
$extra_label = True;
if (!$this->types[$cell['type']] &&
(isset($this->extension[$cell['type']]) || $this->loadExtension($cell['type'],$this)))
{
$extra_label = $this->extension[$cell['type']]->pre_process($cell,$value,$this);
if (strstr($name,'|'))
{
$content = $this->complete_array_merge($content,$value);
}
elseif (!$regs)
{
$content[$name] = $value; // set result for template
}
else
{
eval(str_replace(']',"']",str_replace('[',"['",'$content['.$regs[1].']'.$regs[2].' = $value;')));
}
}
$label = $cell['label'];
if ($label[0] == '@')
{
$label = $this->get_array($content,substr($label,1));
}
$help = $cell['help'];
if ($help[0] == '@')
{
$help = $this->get_array($content,substr($help,1));
}
if ($this->java_script())
2002-02-06 10:03:11 +01:00
{
if ($help)
{
$options .= " onFocus=\"self.status='".addslashes(lang($help))."'; return true;\"";
$options .= " onBlur=\"self.status=''; return true;\"";
if ($cell['type'] == 'button') // for button additionally when mouse over button
{
$options .= " onMouseOver=\"self.status='".addslashes(lang($help))."'; return true;\"";
$options .= " onMouseOut=\"self.status=''; return true;\"";
}
}
if ($cell['onchange'] && $cell['type'] != 'button') // values != '1' can only set by a program (not in the editor so far)
2002-02-06 10:03:11 +01:00
{
$options .= ' onChange="'.($cell['onchange']=='1'?'this.form.submit();':$cell['onchange']).'"';
2002-02-06 10:03:11 +01:00
}
}
switch ($cell['type'])
{
case 'label': // size: [[b]old][[i]talic]
$value = strlen($value) > 1 && !$cell['no_lang'] ? lang($value) : $value;
if ($value != '' && strstr($cell['size'],'b')) $value = $this->html->bold($value);
if ($value != '' && strstr($cell['size'],'i')) $value = $this->html->italic($value);
2002-02-06 10:03:11 +01:00
$html .= $value;
break;
case 'raw':
$html .= $value;
break;
case 'int': // size: [min][,[max][,len]]
case 'float':
list($min,$max,$cell['size']) = explode(',',$cell['size']);
if ($cell['size'] == '')
{
$cell['size'] = $cell['type'] == 'int' ? 5 : 8;
}
// fall-through
2002-02-06 10:03:11 +01:00
case 'text': // size: [length][,maxLength]
if ($readonly)
{
$html .= $this->html->bold($value);
}
else
{
$html .= $this->html->input($form_name,$value,'',
$options.$this->html->formatOptions($cell['size'],'SIZE,MAXLENGTH'));
2002-02-06 10:03:11 +01:00
}
break;
case 'textarea': // Multiline Text Input, size: [rows][,cols]
$html .= $this->html->textarea($form_name,$value,
$options.$this->html->formatOptions($cell['size'],'ROWS,COLS'));
2002-02-06 10:03:11 +01:00
break;
case 'checkbox':
if ($value)
{
$options .= ' CHECKED';
}
$html .= $this->html->input($form_name,'1','CHECKBOX',$options);
break;
case 'radio': // size: value if checked
if ($value == $cell['size'])
{
$options .= ' CHECKED';
}
$html .= $this->html->input($form_name,$cell['size'],'RADIO',$options);
break;
case 'button':
if ($this->java_script() && $cell['onchange'])
{
$html .= $this->html->input_hidden($form_name,'',False) . "\n";
$html .= '<a href="" onClick="set_element(document.eTemplate,\''.$form_name.'\',\'pressed\'); document.eTemplate.submit(); return false;">' .
(strlen($label) <= 1 || $cell['no_lang'] ? $label : lang($label)) . '</a>';
}
else
{
list($img,$ro_img) = explode(',',$cell['size']);
$html .= !$readonly ? $this->html->submit_button($form_name,$label,'',
strlen($label) <= 1 || $cell['no_lang'],$options,$img) :
$this->html->image(substr($this->name,0,strpos($this->name,'.')),$ro_img);
}
$extra_label = False;
2002-02-06 10:03:11 +01:00
break;
case 'hrule':
$html .= $this->html->hr($cell['size']);
break;
case 'template': // size: index in content-array (if not full content is past further on)
if ($this->autorepeat_idx($cell,$show_c,$show_row,$idx,$idx_cname) || $cell['size'] != '')
{
if ($span == '' && isset($content[$idx]['span']))
{ // this allows a colspan in autorepeated cells like the editor
2002-02-06 10:03:11 +01:00
$span = explode(',',$content[$idx]['span']); $span = $span[0];
if ($span == 'all')
{
$span = 1 + $content['cols'] - $show_c;
}
}
$readonlys = $this->get_array($readonlys,$idx); //$readonlys[$idx];
$content = $this->get_array($content,$idx); // $content[$idx];
2002-02-06 10:03:11 +01:00
if ($idx_cname != '')
{
$cname .= $cname == '' ? $idx_cname : '['.str_replace('[','][',str_replace(']','',$idx_cname)).']';
2002-02-06 10:03:11 +01:00
}
//echo "<p>show_cell-autorepeat($name,$show_c,$show_row,cname='$cname',idx='$idx',idx_cname='$idx_cname',span='$span'): content ="; _debug_array($content);
2002-02-06 10:03:11 +01:00
}
if ($readonly)
{
$readonlys['__ALL__'] = True;
}
$templ = is_object($cell['name']) ? $cell['name'] : new etemplate($cell['name']);
2002-02-06 10:03:11 +01:00
$html .= $templ->show($content,$sel_options,$readonlys,$cname,$show_c,$show_row);
break;
case 'select': // size:[linesOnMultiselect]
if (isset($sel_options[$name]))
{
$sel_options = $sel_options[$name];
}
elseif (isset($sel_options[$org_name]))
{
$sel_options = $sel_options[$org_name];
} elseif (isset($content["options-$name"]))
2002-02-06 10:03:11 +01:00
{
$sel_options = $content["options-$name"];
}
$html .= $this->sbox->getArrayItem($form_name.'[]',$value,$sel_options,$cell['no_lang'],
$options,$cell['size']);
2002-02-06 10:03:11 +01:00
break;
case 'select-percent':
$html .= $this->sbox->getPercentage($form_name,$value,$options);
break;
case 'select-priority':
$html .= $this->sbox->getPriority($form_name,$value,$options);
break;
case 'select-access':
$html .= $this->sbox->getAccessList($form_name,$value,$options);
break;
case 'select-country':
$html .= $this->sbox->getCountry($form_name,$value,$options);
break;
case 'select-state':
$html .= $this->sbox->list_states($form_name,$value); // no helptext - old Function!!!
break;
case 'select-cat':
$html .= $this->sbox->getCategory($form_name.'[]',$value,$cell['size'] >= 0,
False,$cell['size'],$options);
break;
case 'select-account':
$type = substr(strstr($cell['size'],','),1);
if ($type == '')
{
$type = 'accounts'; // default is accounts
}
$html .= $this->sbox->getAccount($form_name.'[]',$value,2,$type,0+$cell['size'],$options);
break;
case 'image':
$image = $this->html->image(substr($this->name,0,strpos($this->name,'.')),
$label,lang($help),'BORDER=0');
2002-02-06 10:03:11 +01:00
$html .= $name == '' ? $image : $this->html->a_href($image,$name);
$extra_label = False;
2002-02-06 10:03:11 +01:00
break;
case 'file':
$html .= $this->html->input_hidden($path = str_replace($name,$name.'_path',$form_name),'.');
$html .= $this->html->input($form_name,'','file');
$GLOBALS['phpgw_info']['etemplate']['form_options'] =
"enctype=\"multipart/form-data\" onSubmit=\"set_element2(this,'$path','$form_name')\"";
break;
2002-02-06 10:03:11 +01:00
default:
if (!isset($this->extension[$cell['type']]))
{
$html .= "<i>unknown type '$cell[type]'</i>";
}
else
{
$html .= $this->extension[$cell['type']]->render($cell,$form_name,$value,$readonly);
}
2002-02-06 10:03:11 +01:00
break;
}
if ($extra_label && ($label != '' || $html == ''))
2002-02-06 10:03:11 +01:00
{
if (strlen($label) > 1 && !$cell['no_lang'])
2002-02-06 10:03:11 +01:00
{
$label = lang($label);
}
$html_label = $html != '' && $label != '';
if (strstr($label,'%s'))
{
$html = str_replace('%s',$html,$label);
}
elseif (($html = $label . ' ' . $html) == ' ')
{
$html = '&nbsp;';
}
if ($html_label)
{
$html = $this->html->label($html);
}
}
return $html;
}
/*!
@function process_show
@abstract makes necessary adjustments on HTTP_POST_VARS after a eTemplate / form gots submitted
@discussion This is only an internal function, dont call it direct use only exec
@discussion process_show recursivly calls itself for the included eTemplates.
@param $vars HTTP_POST_VARS on first call, later (deeper recursions) subscripts of it
@param $readonly array with cell- / var-names which should NOT return content (this is to workaround browsers who not understand READONLY correct)
@param $cname basename of our returnt content (same as in call to show)
@result the adjusted content (by using the var-param &$content)
2002-02-06 10:03:11 +01:00
*/
function process_show(&$content,$readonlys='')
{
if (!$readonlys)
2002-02-06 10:03:11 +01:00
{
$readonlys = array();
2002-02-06 10:03:11 +01:00
}
if (!isset($content) || !is_array($content))
{
return;
}
if ($this->debug >= 1 || $this->debug == $this->name && $this->name)
{
echo "<p>process_show($this->name) start: content ="; _debug_array($content);
}
reset($this->data);
if (isset($this->data[0]))
{
each($this->data); // skip width
}
for ($r = 0; True /*list($row,$cols) = each($this->data)*/; ++$r)
{
$old_cols = $cols;
if (!(list($nul,$cols) = each($this->data))) // no further row
{
$cols = $old_cols;
list($nul,$cell) = each($cols); reset($cols);
if ((!$this->autorepeat_idx($cols['A'],0,$r,$idx,$idx_cname) ||
$idx_cname == '' || !$this->isset_array($content,$idx)) &&
2002-02-06 10:03:11 +01:00
(!$this->autorepeat_idx($cols['B'],1,$r,$idx,$idx_cname) ||
$idx_cname == '' || !$this->isset_array($content,$idx)))
2002-02-06 10:03:11 +01:00
{
break; // no auto-row-repeat
}
}
$row = 1+$r;
for ($c = 0; True /*list($col,$cell) = each($cols)*/; ++$c)
{
$old_cell = $cell;
if (!(list($nul,$cell) = each($cols))) // no further cols
2002-02-06 10:03:11 +01:00
{
$cell = $old_cell;
if (!$this->autorepeat_idx($cell,$c,$r,$idx,$idx_cname,True) ||
$idx_cname == '' || !$this->isset_array($content,$idx))
2002-02-06 10:03:11 +01:00
{
break; // no auto-col-repeat
}
}
else
{
$this->autorepeat_idx($cell,$c,$r,$idx,$idx_cname,True); // get idx_cname
}
$col = $this->num2chrs($c);
$name = $this->expand_name($cell['name'],$c,$r);
$readonly = $cell['readonly'] || $readonlys[$name] || $readonlys['__ALL__'] ||
$cell['type'] == 'label' || $cell['type'] == 'image' || $cell['type'] == 'raw' ||
$cell['type'] == 'hrule';
2002-02-06 10:03:11 +01:00
if ($idx_cname == '' && $cell['type'] == 'template' || strstr($name,'|')) // only templates or extensions
2002-02-06 10:03:11 +01:00
{
if ($readonly && !isset($readonlys['__ALL__'])) // can't unset whole content!!!
2002-02-06 10:03:11 +01:00
{
$readonlys['__ALL__'] = True;
$this->process_show_cell($cell,$name,$c,$r,$readonlys,$content);
unset($readonlys['__ALL__']); // unset it after or everything gets set readonly
}
else
{
$this->process_show_cell($cell,$name,$c,$r,$readonlys,$content);
2002-02-06 10:03:11 +01:00
}
}
elseif (ereg('^([^[]*)\\[(.*)\\]$',$idx_cname,$regs)) // name contains array-index
{
/* Attention: the unsets here and in the next else are vor two reasons:
* 1) some browsers does NOT understand the READONLY-tag and sent content back
* this has to be unset, as we only report no-readonly fields
* 2) php has a fault / feature :-) that it set unset array-elements passed as
* variable / changeable (&$var) to a function, this messes up a lot, as we
* depend on the fact variables are set or not for the autorepeat. To work
* around that, process_show_cell reports back if a variable is set or not
* via the returnvalue and we unset it or even the parent if is was not set.
*/
$parent_isset = isset($content[$regs[1]]);
if ($readonly || !$this->process_show_cell($cell,$name,$c,$r,
$readonlys[$regs[1]][$regs[2]],$content[$regs[1]][$regs[2]]))
2002-02-06 10:03:11 +01:00
{
if (!$parent_isset)
{
unset($content[$regs[1]]);
}
else
{
unset($content[$regs[1]][$regs[2]]);
}
}
}
else
{
if ($readonly || !$this->process_show_cell($cell,$name,$c,$r,
$readonlys[$idx_cname],$content[$idx_cname]))
2002-02-06 10:03:11 +01:00
{
unset($content[$idx_cname]);
}
}
}
}
if ($this->debug >= 2 || $this->debug == $this->name && $this->name)
{
echo "<p>process_show($this->name) end: content ="; _debug_array($content);
}
}
/*!
@function process_show_cell
@syntax process_show_cell( $cell,$name,$c,$r,$readonlys,&$value )
@author ralfbecker
2002-02-06 10:03:11 +01:00
@abstract makes necessary adjustments on $value eTemplate / form gots submitted
@discussion This is only an internal function, dont call it direct use only exec
@discussion process_show recursivly calls itself for the included eTemplates.
@param $cell processed cell
@param $name expanded name of cell
@param $c,$r col,row index
@param $readonlys readonlys-array to pass on for templates
@param &$value value to change
@result if $value is set
2002-02-06 10:03:11 +01:00
*/
function process_show_cell($cell,$name,$c,$r,$readonlys,&$value)
{
if (is_array($cell['type']))
{
$cell['type'] = $cell['type'][0];
}
if ($this->debug >= 3 || $this->debug == $this->name || $this->debug == $cell['type'])
{
if (is_object($name))
{
$name = $name->name;
}
echo "<p>process_show_cell(c=$c, r=$r, name='$name',type='${cell['type']}') start: isset(value)=".(0+isset($value)).", value=";
2002-02-06 10:03:11 +01:00
if (is_array($value))
{
_debug_array($value);
}
else
{
echo "'$value'</p>\n";
}
}
if ((isset($this->extension[$cell['type']]) || $this->loadExtension($cell['type'],$this)) &&
isset($this->extension[$cell['type']]->public_functions['post_process']))
{
if ($this->debug > 1 || $this->debug && $this->debug == $this->name)
{
echo "<p>value for $cell[type]::post_process: "; _debug_array($value);
}
$this->extension[$cell['type']]->post_process($cell,$value,$this);
if ($this->debug > 1 || $this->debug && $this->debug == $this->name)
{
echo "<p>value after $cell[type]::post_process: ";
if (is_array($value))
{
_debug_array($value);
}
else
{
echo "'$value'</p>";
}
}
}
2002-02-06 10:03:11 +01:00
switch ($cell['type'])
{
case 'int':
case 'float':
list($min,$max) = explode(',',$cell['size']);
/*
* TO DO: number- and range-check, if not enshured by java-script
*/
break;
2002-02-06 10:03:11 +01:00
case 'text':
case 'textarea':
if (isset($value))
{
$value = stripslashes($value);
}
break;
case 'checkbox':
if (!isset($value)) // checkbox was not checked
2002-02-06 10:03:11 +01:00
{
$value = 0; // need to be reported too
}
break;
case 'template':
$templ = is_object($cell['name']) ? $cell['name'] : new etemplate($name);
2002-02-06 10:03:11 +01:00
$templ->process_show($value,$readonlys);
if ($templ->loop)
{
$this->loop = True;
//echo "<p>".$this->name.": loop set in process_show(".$templ->name.")</p>\n";
}
2002-02-06 10:03:11 +01:00
break;
case 'select':
case 'select-cat':
case 'select-account':
if (is_array($value))
{
$value = count($value) <= 1 ? $value[0] : implode(',',$value);
}
break;
default: // do nothing, $value is correct as is
}
if ($this->debug >= 3 || $this->debug == $this->name || $this->debug == $cell['type'])
{
echo "<p>process_show_cell(name='$name',type='${cell['type']}) end: isset(value)=".(0+isset($value)).", value=";
if (is_array($value))
{
_debug_array($value);
}
else
{
echo "'$value'</p>\n";
}
}
return isset($value);
}
/*!
@function java_script
@syntax java_script( $consider_not_tested_as_enabled = True )
@author ralfbecker
@abstract is javascript enabled?
@discussion this should be tested by the api at login
@result true if javascript is enabled or not yet tested
*/
function java_script($consider_not_tested_as_enabled = True)
{
return !!$GLOBALS['phpgw_info']['etemplate']['java_script'] ||
$consider_not_tested_as_enabled &&
(!isset($GLOBALS['phpgw_info']['etemplate']['java_script']) ||
$GLOBALS['phpgw_info']['etemplate']['java_script'].'' == '');
}
/*!
@function include_java_script
@syntax include_java_script( )
@author ralfbecker
@abstract returns the javascript to be included by exec
*/
function include_java_script()
{
// this is to test if javascript is enabled
if (!isset($GLOBALS['phpgw_info']['etemplate']['java_script']))
{
$js = '<script language="javascript">
document.write(\''.str_replace("\n",'',$this->html->input_hidden('java_script','1')).'\');
</script>
';
}
// here are going all the necesarry functions if javascript is definitve enabled
if ($this->java_script(False))
{
$js .= '<script language="JavaScript">
function set_element(form,name,value)
{
'. /* ' alert("set_element: "+name+"="+value);'. */ '
for (i = 0; i < form.length; i++)
{
if (form.elements[i].name == name)
{
form.elements[i].value = value;
}
}
}
function set_element2(form,name,vname)
{
'. /* ' alert("set_element2: "+name+"="+vname);'. */ '
for (i = 0; i < form.length; i++)
{
if (form.elements[i].name == vname)
{
value = form.elements[i].value;
}
}
'. /* ' alert("set_element2: "+name+"="+value);'. */ '
for (i = 0; i < form.length; i++)
{
if (form.elements[i].name == name)
{
form.elements[i].value = value;
}
}
}
</script>
';
}
return $js;
}
};