2002-09-17 23:31:45 +02:00
< ? php
2006-04-20 19:12:30 +02:00
/**
* eGroupWare eTemplate Extension - Nextmatch Widget
*
* @ license http :// opensource . org / licenses / gpl - license . php GPL - GNU General Public License
* @ package etemplate
* @ link http :// www . egroupware . org
* @ author Ralf Becker < RalfBecker @ outdoor - training . de >
* @ version $Id $
*/
2002-09-17 23:31:45 +02:00
2006-10-21 22:16:25 +02:00
require_once ( EGW_INCLUDE_ROOT . '/etemplate/inc/class.etemplate.inc.php' );
2005-02-18 23:44:42 +01:00
/**
* eTemplate Extension : Widget that show only a certain number of data - rows and allows to modifiy the rows shown ( scroll ) .
*
* This widget replaces the old nextmatch - class . It is independent of the UI ,
* as it only uses etemplate - widgets and has therefor no render - function
*
2005-02-21 10:21:48 +01:00
* $content [ $id ] = array ( // I = value set by the app, 0 = value on return / output
* 'get_rows' => // I method/callback to request the data for the rows eg. 'notes.bo.get_rows'
* 'filter_label' => // I label for filter (optional)
* 'filter_help' => // I help-msg for filter (optional)
* 'no_filter' => True // I disable the 1. filter
* 'no_filter2' => True // I disable the 2. filter (params are the same as for filter)
* 'no_cat' => True // I disable the cat-selectbox
2006-12-04 15:39:22 +01:00
* 'cat_app' => // I application the cat's should be from, default app in get_rows
2005-02-21 10:21:48 +01:00
* 'template' => // I template to use for the rows, if not set via options
* 'header_left' => // I template to show left of the range-value, left-aligned (optional)
* 'header_right' => // I template to show right of the range-value, right-aligned (optional)
* 'bottom_too' => True // I show the nextmatch-line (arrows, filters, search, ...) again after the rows
2005-07-13 10:39:42 +02:00
* 'never_hide' => True // I never hide the nextmatch-line if less then maxmatch entries
2006-04-23 16:44:44 +02:00
* 'lettersearch' => True // I show a lettersearch
* 'searchletter' => // I0 active letter of the lettersearch or false for [all]
2005-02-21 10:21:48 +01:00
* 'start' => // IO position in list
2006-03-27 17:08:47 +02:00
* 'num_rows' => // IO number of rows to show, defaults to maxmatches from the general prefs
2005-02-21 10:21:48 +01:00
* 'cat_id' => // IO category, if not 'no_cat' => True
* 'search' => // IO search pattern
* 'order' => // IO name of the column to sort after (optional for the sortheaders)
* 'sort' => // IO direction of the sort: 'ASC' or 'DESC'
* 'col_filter' => // IO array of column-name value pairs (optional for the filterheaders)
* 'filter' => // IO filter, if not 'no_filter' => True
* 'filter_no_lang' => True // I set no_lang for filter (=dont translate the options)
2006-03-21 23:13:46 +01:00
* 'filter_onchange' => 'this.form.submit();' // I onChange action for filter, default: this.form.submit();
2005-02-21 10:21:48 +01:00
* 'filter2' => // IO filter2, if not 'no_filter2' => True
* 'filter2_no_lang' => True // I set no_lang for filter2 (=dont translate the options)
2006-03-21 23:13:46 +01:00
* 'filter2_onchange' => 'this.form.submit();' // I onChange action for filter2, default: this.form.submit();
2005-02-21 10:21:48 +01:00
* 'rows' => // O content set by callback
* 'total' => // O the total number of entries
2005-03-14 00:38:37 +01:00
* 'sel_options' => // O additional or changed sel_options set by the callback and merged into $tmpl->sel_options
2007-09-22 17:03:03 +02:00
* 'no_columnselection' => // I turns off the columnselection completly, turned on by default
* 'columnselection-pref' => // I name of the preference (plus 'nextmatch-' prefix), default = template-name
* 'default_cols' => // I columns to use if there's no user or default pref (! as first char uses all but the named columns), default all columns
* 'options-selectcols' => // I array with name/label pairs for the column-selection, this gets autodetected by default. A name => false suppresses a column completly.
2007-01-22 08:06:15 +01:00
* 'return' => // IO allows to return something from the get_rows function if $query is a var-param!
2007-09-22 17:03:03 +02:00
* 'csv_fields' => // I false=disable csv export, true or unset=enable it with auto-detected fieldnames,
* or array with name => label or name => array ( 'label' => label , 'type' => type ) pairs ( type is a eT widget - type )
2005-02-21 10:21:48 +01:00
* );
2005-02-18 23:44:42 +01:00
* @ package etemplate
* @ subpackage extensions
* @ author RalfBecker - AT - outdoor - training . de
* @ license GPL
*/
2002-09-17 23:31:45 +02:00
class nextmatch_widget
{
2005-02-18 23:44:42 +01:00
/**
* exported methods of this class
* @ var array
*/
2002-09-17 23:31:45 +02:00
var $public_functions = array (
'pre_process' => True ,
2006-10-21 22:16:25 +02:00
'post_process' => True ,
2002-09-17 23:31:45 +02:00
);
2005-02-18 23:44:42 +01:00
/**
* availible extensions and there names for the editor
* @ var array
*/
2003-12-09 01:03:41 +01:00
var $human_name = array (
2006-09-12 17:14:39 +02:00
'nextmatch' => 'Nextmatch' ,
'nextmatch-sortheader' => 'Nextmatch Sortheader' ,
'nextmatch-filterheader' => 'Nextmatch Filterheader' ,
2005-07-14 08:47:14 +02:00
'nextmatch-accountfilter' => 'Nextmatch Accountfilter' ,
2006-09-12 17:14:39 +02:00
'nextmatch-customfilter' => 'Nextmatch Custom Filterheader' ,
2007-03-07 13:30:17 +01:00
'nextmatch-header' => 'Nextmatch Header' ,
2003-12-09 01:03:41 +01:00
);
2007-06-21 12:01:02 +02:00
/**
* Turn on debug messages ( mostly in post_process )
*
* @ var boolean
*/
var $debug = false ;
2002-09-17 23:31:45 +02:00
2005-02-18 23:44:42 +01:00
/**
* Constructor of the extension
*
* @ param string $ui '' for html
*/
2002-09-17 23:31:45 +02:00
function nextmatch_widget ( $ui )
{
}
2005-02-18 23:44:42 +01:00
/**
* returns last part of a form - name
2007-03-07 13:30:17 +01:00
*
* @ internal
* @ return string
2005-02-18 23:44:42 +01:00
*/
2003-12-09 01:03:41 +01:00
function last_part ( $name )
{
$parts = explode ( '[' , str_replace ( ']' , '' , $name ));
return $parts [ count ( $parts ) - 1 ];
}
2005-02-18 23:44:42 +01:00
/**
* pre - processing of the extension
*
* This function is called before the extension gets rendered
*
* @ param string $name form - name of the control
* @ param mixed & $value value / existing content , can be modified
* @ param array & $cell array with the widget , can be modified for ui - independent widgets
* @ param array & $readonlys names of widgets as key , to be made readonly
* @ param mixed & $extension_data data the extension can store persisten between pre - and post - process
2007-03-07 13:30:17 +01:00
* @ param etemplate & $tmpl reference to the template we belong too
2005-02-18 23:44:42 +01:00
* @ return boolean true if extra label is allowed , false otherwise
*/
2002-10-01 20:26:30 +02:00
function pre_process ( $name , & $value , & $cell , & $readonlys , & $extension_data , & $tmpl )
2002-09-17 23:31:45 +02:00
{
2005-11-09 21:50:45 +01:00
$nm_global = & $GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'nextmatch' ];
2003-12-10 02:21:31 +01:00
//echo "<p>nextmatch_widget.pre_process(name='$name',type='$cell[type]'): value = "; _debug_array($value);
//echo "<p>nextmatch_widget.pre_process(name='$name',type='$cell[type]'): nm_global = "; _debug_array($nm_global);
2002-09-17 23:31:45 +02:00
2003-12-09 01:03:41 +01:00
$extension_data = array (
'type' => $cell [ 'type' ]
);
switch ( $cell [ 'type' ])
{
2007-03-07 13:30:17 +01:00
case 'nextmatch-header' :
$cell [ 'type' ] = 'label' ;
return true ; // false = no extra label
2005-07-17 23:42:11 +02:00
case 'nextmatch-sortheader' : // Option: default sort: ASC(default) or DESC
2007-03-07 13:30:17 +01:00
$extension_data [ 'default_sort' ] = $cell [ 'size' ] && preg_match ( '/^(ASC|DESC)/i' , $cell [ 'size' ], $matches ) ? strtoupper ( $matches [ 1 ]) : 'ASC' ;
2003-12-09 01:03:41 +01:00
$cell [ 'type' ] = 'button' ;
$cell [ 'onchange' ] = True ;
if ( ! $cell [ 'help' ])
{
$cell [ 'help' ] = 'click to order after that criteria' ;
}
if ( $this -> last_part ( $name ) == $nm_global [ 'order' ]) // we're the active column
{
$cell [ 1 ] = $cell ;
2006-04-05 17:28:48 +02:00
unset ( $cell [ 1 ][ 'align' ]);
2003-12-10 02:21:31 +01:00
$cell [ 2 ] = $tmpl -> empty_cell ( 'image' , $nm_global [ 'sort' ] != 'DESC' ? 'down' : 'up' );
2003-12-09 01:03:41 +01:00
$cell [ 'type' ] = 'hbox' ;
2007-03-07 13:30:17 +01:00
$cell [ 'size' ] = '2,,0,0' ;
2006-09-25 15:11:00 +02:00
$class = 'activ_sortcolumn' ;
2003-12-09 01:03:41 +01:00
$cell [ 'name' ] = $cell [ 'label' ] = '' ;
}
else
{
2006-09-25 15:11:00 +02:00
$class = 'inactiv_sortcolumn' ;
2003-12-09 01:03:41 +01:00
}
2006-09-25 15:11:00 +02:00
$parts = explode ( ',' , $cell [ 'span' ]);
$parts [ 1 ] .= ( $parts [ 1 ] ? ' ' : '' ) . $class ;
$cell [ 'span' ] = implode ( ',' , $parts );
2003-12-09 01:03:41 +01:00
return True ;
2006-09-12 17:14:39 +02:00
case 'nextmatch-accountfilter' : // Option: as for selectbox: [extra-label(default ALL)[,#lines(default 1)]]
$cell [ 'size' ] = 'select-account,' . $cell [ 'size' ];
// fall through
case 'nextmatch-customfilter' : // Option: widget-name, options as for selectbox
list ( $type , $cell [ 'size' ]) = explode ( ',' , $cell [ 'size' ], 2 );
// fall through
2005-07-17 23:42:11 +02:00
case 'nextmatch-filterheader' : // Option: as for selectbox: [extra-label(default ALL)[,#lines(default 1)]]
2006-09-12 17:14:39 +02:00
if ( ! $type ) $type = 'select' ;
$cell [ 'type' ] = $type ;
2003-12-09 01:03:41 +01:00
if ( ! $cell [ 'size' ])
{
$cell [ 'size' ] = 'All' ;
}
if ( ! $cell [ 'help' ])
{
$cell [ 'help' ] = 'select which values to show' ;
}
2006-03-27 00:17:55 +02:00
$cell [ 'onchange' ] = $cell [ 'noprint' ] = True ;
2006-09-25 15:11:00 +02:00
$parts = explode ( ',' , $cell [ 'span' ]);
$parts [ 1 ] .= ( $parts [ 1 ] ? ' ' : '' ) . 'filterheader' ;
$cell [ 'span' ] = implode ( ',' , $parts );
2003-12-09 01:03:41 +01:00
$extension_data [ 'old_value' ] = $value = $nm_global [ 'col_filter' ][ $this -> last_part ( $name )];
return True ;
}
2006-03-27 17:08:47 +02:00
// presetting the selectboxes with their default values, to NOT loop, because post-process thinks they changed
if ( ! isset ( $value [ 'cat_id' ])) $value [ 'cat_id' ] = '' ;
if ( ! isset ( $value [ 'search' ])) $value [ 'search' ] = '' ;
foreach ( array ( 'filter' , 'filter2' ) as $f )
{
if ( ! isset ( $value [ $f ]))
{
list ( $value [ $f ]) = isset ( $tmpl -> sel_options [ $f ]) ? @ each ( $tmpl -> sel_options [ $f ]) : @ each ( $value [ 'options-' . $f ]);
2006-04-05 17:28:48 +02:00
if ( ! is_string ( $value [ $f ])) $value [ $f ] = ( string ) $value [ $f ];
2006-03-27 17:08:47 +02:00
}
}
2007-05-23 20:06:21 +02:00
// save values in persistent extension_data to be able use it in post_process
$extension_data += $value ;
2007-09-22 17:03:03 +02:00
$value [ 'no_csv_export' ] = $value [ 'csv_fields' ] === false ||
$GLOBALS [ 'egw_info' ][ 'server' ][ 'export_limit' ] && ! is_numeric ( $GLOBALS [ 'egw_info' ][ 'server' ][ 'export_limit' ]);
2007-05-23 20:06:21 +02:00
if ( ! $value [ 'filter_onchange' ]) $value [ 'filter_onchange' ] = 'this.form.submit();' ;
if ( ! $value [ 'filter2_onchange' ]) $value [ 'filter2_onchange' ] = 'this.form.submit();' ;
2002-09-24 19:28:45 +02:00
list ( $app , $class , $method ) = explode ( '.' , $value [ 'get_rows' ]);
2005-03-05 10:25:17 +01:00
if ( $app && $class )
{
2005-03-14 00:38:37 +01:00
if ( is_object ( $GLOBALS [ $class ])) // use existing instance (put there by a previous CreateObject)
{
$obj =& $GLOBALS [ $class ];
}
else
{
$obj =& CreateObject ( $app . '.' . $class );
}
2005-03-05 10:25:17 +01:00
}
2006-12-04 15:39:22 +01:00
if ( ! isset ( $value [ 'cat_app' ])) $value [ 'cat_app' ] = $app ; // if no cat_app set, use the app from the get_rows func
2007-06-08 10:54:04 +02:00
if ( ! ( $max = ( int ) $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'maxmatchs' ])) $max = 15 ;
2006-03-27 00:17:55 +02:00
$row_options = array ();
foreach ( array ( 5 , 12 , 25 , 50 , 100 , 200 , 500 , 999 ) as $n )
{
if ( $n - 5 <= $max && $max <= $n + 5 ) $n = $max ;
$row_options [ $n ] = $n ;
}
if ( ! isset ( $row_options [ $max ]))
{
$row_options [ $max ] = $max ;
ksort ( $row_options );
}
$value [ 'options-num_rows' ] =& $row_options ;
2007-06-21 12:01:02 +02:00
if ( ! isset ( $value [ 'num_rows' ])) $extension_data [ 'num_rows' ] = $value [ 'num_rows' ] = $max ;
2006-03-27 00:17:55 +02:00
if ( $value [ 'num_rows' ] != $max )
{
2007-05-25 14:18:00 +02:00
$GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'maxmatchs' ] = $max = ( int ) $value [ 'num_rows' ];
2006-03-27 00:17:55 +02:00
}
2007-03-07 13:30:17 +01:00
if ( ! $value [ 'no_columnselection' ])
{
// presetting the options for selectcols empty, so the get_rows function can set it
$value [ 'options-selectcols' ] = array ();
}
2003-12-09 01:03:41 +01:00
if ( ! is_object ( $obj ) || ! method_exists ( $obj , $method ))
2002-10-01 20:26:30 +02:00
{
2005-11-09 21:50:45 +01:00
$GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'validation_errors' ][ $name ] = " nextmatch_widget::pre_process( $cell[name] ): ' $value[get_rows] ' is no valid method !!! " ;
2002-10-16 16:11:36 +02:00
}
else
{
2007-02-14 08:11:42 +01:00
if ( ! is_array ( $readonlys )) $readonlys = array ();
2007-06-21 12:01:02 +02:00
$total = $extension_data [ 'total' ] = $value [ 'total' ] = $obj -> $method ( $value , $value [ 'rows' ], $readonlys [ 'rows' ]);
2007-02-14 08:11:42 +01:00
2005-03-14 00:38:37 +01:00
// allow the get_rows function to override / set sel_options
if ( isset ( $value [ 'rows' ][ 'sel_options' ]) && is_array ( $value [ 'rows' ][ 'sel_options' ]))
{
$tmpl -> sel_options = array_merge ( $tmpl -> sel_options , $value [ 'rows' ][ 'sel_options' ]);
unset ( $value [ 'rows' ][ 'sel_options' ]);
}
2002-10-01 20:26:30 +02:00
}
2006-10-19 21:05:48 +02:00
if ( $method && $total && $value [ 'start' ] >= $total )
2002-09-17 23:31:45 +02:00
{
2002-10-01 20:26:30 +02:00
$value [ 'start' ] = 0 ;
2007-06-21 12:01:02 +02:00
$total = $extension_data [ 'total' ] = $value [ 'total' ] = $obj -> $method ( $value , $value [ 'rows' ], $readonlys [ 'rows' ]);
2002-09-17 23:31:45 +02:00
}
2005-02-27 22:32:06 +01:00
if ( is_array ( $value [ 'rows' ][ 0 ])) // fixed 0 based arrays
{
array_unshift ( $value [ 'rows' ], false );
}
2002-10-16 16:11:36 +02:00
list ( $template , $options ) = explode ( ',' , $cell [ 'size' ]);
2006-04-30 09:10:42 +02:00
if ( ! $value [ 'template' ] && $template ) // template name can be supplied either in $value['template'] or the options-field
2002-09-17 23:31:45 +02:00
{
2002-10-16 16:11:36 +02:00
$value [ 'template' ] = $template ;
2002-09-17 23:31:45 +02:00
}
2002-10-01 20:26:30 +02:00
if ( ! is_object ( $value [ 'template' ]))
{
2005-03-14 00:38:37 +01:00
$value [ 'template' ] =& new etemplate ( $value [ 'template' ], $tmpl -> as_array ());
2002-10-01 20:26:30 +02:00
}
2007-05-26 20:45:08 +02:00
$extension_data [ 'template' ] = $value [ 'template' ] -> name ; // used for the column-selection, and might be set in get_rows()
$extension_data [ 'columnselection_pref' ] = $value [ 'columnselection_pref' ];
2005-06-11 22:15:02 +02:00
if ( $total < 1 && $value [ 'template' ] -> rows > 1 )
2002-09-22 11:30:29 +02:00
{
2005-04-15 00:13:42 +02:00
$value [ 'template' ] -> data [ 0 ][ 'h' . $value [ 'template' ] -> rows ] .= ',1' ; // disable the last data row
2002-09-22 11:30:29 +02:00
}
2005-07-13 10:39:42 +02:00
if ( ! $value [ 'never_hide' ] && $total <= $max && $options && $value [ 'search' ] == '' &&
2002-10-16 16:11:36 +02:00
( $value [ 'no_cat' ] || ! $value [ 'cat_id' ]) &&
( $value [ 'no_filter' ] || ! $value [ 'filter' ] || $value [ 'filter' ] == 'none' ) &&
( $value [ 'no_filter2' ] || ! $value [ 'filter2' ] || $value [ 'filter2' ] == 'none' ))
{ // disable whole nextmatch line if no scrolling necessary
2003-06-29 19:00:05 +02:00
if ( $value [ 'header_left' ] || $value [ 'header_right' ])
{
2005-11-09 21:50:45 +01:00
$nextmatch =& new etemplate ( 'etemplate.nextmatch_widget.header_only' );
2003-06-29 19:00:05 +02:00
$cell [ 'size' ] = $cell [ 'name' ];
$cell [ 'obj' ] = & $nextmatch ;
$cell [ 'name' ] = $nextmatch -> name ;
}
else
{
$cell [ 'size' ] = $cell [ 'name' ] . '[rows]' ;
$cell [ 'obj' ] = & $value [ 'template' ];
$cell [ 'name' ] = $value [ 'template' ] -> name ;
}
2002-09-17 23:31:45 +02:00
}
2002-10-16 16:11:36 +02:00
else
2002-09-17 23:31:45 +02:00
{
2005-02-16 00:22:10 +01:00
$nextmatch =& new etemplate ( 'etemplate.nextmatch_widget' );
// keep the editor away from the generated tmpls
2006-04-23 16:44:44 +02:00
$nextmatch -> no_onclick = true ;
2005-11-02 17:46:34 +01:00
2006-04-23 16:44:44 +02:00
if ( $value [ 'lettersearch' ])
{
$lettersearch =& $nextmatch -> get_widget_by_name ( 'lettersearch' ); // hbox for the letters
if (( $alphabet = lang ( 'alphabet' )) == 'alphabet*' ) $alphabet = 'a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z' ;
$alphabet = explode ( ',' , $alphabet );
$alphabet [ 'all' ] = lang ( 'all' );
foreach ( $alphabet as $key => $letter )
{
// make each letter internally behave like a button
$form_name = $name . '[searchletter][' . ( $key === 'all' ? $key : $letter ) . ']' ;
$GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'to_process' ][ $form_name ] = 'button' ;
if ( ! $key ) $letterbox =& $lettersearch [ 1 ]; // to re-use the first child
$letterbox = etemplate :: empty_cell ( 'label' , $letter , array (
'label' => $letter ,
'span' => ',lettersearch' . ( $letter == ( string ) $value [ 'searchletter' ] ||
$key === 'all' && ! $value [ 'searchletter' ] ? '_active' : '' ),
'no_lang' => 2 ,
'align' => $key == 'all' ? 'right' : '' ,
'onclick' => " return submitit( $tmpl->name_form ,' $form_name '); " ,
));
// if not the first (re-used) child, add it to the parent
if ( $key ) etemplate :: add_child ( $lettersearch , $letterbox );
unset ( $letterbox );
}
//_debug_array($GLOBALS['egw_info']['etemplate']['to_process']);
}
2005-11-02 17:46:34 +01:00
if ( isset ( $value [ 'no_search' ])) $value [ 'no_start_search' ] = $value [ 'no_search' ];
foreach ( array ( 'no_cat' => 'cat_id' , 'no_filter' => 'filter' , 'no_filter2' => 'filter2' , 'no_search' => 'search' , 'no_start_search' => 'start_search' ) as $val_name => $cell_name )
2002-10-16 16:11:36 +02:00
{
2005-04-24 19:14:41 +02:00
if ( isset ( $value [ $val_name ])) $nextmatch -> disable_cells ( $cell_name , $value [ $val_name ]);
}
foreach ( array ( 'header_left' , 'header_right' ) as $name )
{
if ( ! $value [ $name ]) $nextmatch -> disable_cells ( '@' . $name );
2002-10-16 16:11:36 +02:00
}
2005-02-21 10:21:48 +01:00
foreach ( array ( 'filter' , 'filter2' ) as $cell_name )
2002-10-16 16:11:36 +02:00
{
2005-02-21 10:21:48 +01:00
if ( isset ( $value [ $cell_name . '_no_lang' ])) $nextmatch -> set_cell_attribute ( $cell_name , 'no_lang' , $value [ $cell_name . '_no_lang' ]);
2002-10-16 16:11:36 +02:00
}
$start = $value [ 'start' ];
$end = $start + $max > $total ? $total : $start + $max ;
$value [ 'range' ] = $total ? ( 1 + $start ) . ' - ' . $end : '0' ;
$nextmatch -> set_cell_attribute ( 'first' , 'readonly' , $start <= 0 );
$nextmatch -> set_cell_attribute ( 'left' , 'readonly' , $start <= 0 );
$nextmatch -> set_cell_attribute ( 'right' , 'readonly' , $start + $max >= $total );
$nextmatch -> set_cell_attribute ( 'last' , 'readonly' , $start + $max >= $total );
2002-09-17 23:31:45 +02:00
2002-10-16 16:11:36 +02:00
$cell [ 'size' ] = $cell [ 'name' ];
$cell [ 'obj' ] = & $nextmatch ;
$cell [ 'name' ] = $nextmatch -> name ;
}
2007-03-07 13:30:17 +01:00
// preset everything for the column selection
2007-05-13 08:19:11 +02:00
if ( ! $value [ 'no_columnselection' ] && // fetching column-names & -labels from the template
$this -> _cols_from_tpl ( $value [ 'template' ], $value [ 'options-selectcols' ], $name2col , $value [ 'rows' ]))
2007-03-07 13:30:17 +01:00
{
//_debug_array($name2col);
//_debug_array($value['options-selectcols']);
// getting the selected colums from the prefs (or if not set a given default or all)
$name = is_object ( $value [ 'template' ]) ? $value [ 'template' ] -> name : $value [ 'template' ];
list ( $app ) = explode ( '.' , $name );
if ( isset ( $value [ 'columnselection_pref' ])) $name = $value [ 'columnselection_pref' ];
if ( ! ( $value [ 'selectcols' ] = $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ $app ][ 'nextmatch-' . $name ]))
{
$value [ 'selectcols' ] = array_keys ( $value [ 'options-selectcols' ]);
if ( isset ( $value [ 'default_cols' ]))
{
if ( $value [ 'default_cols' ]{ 0 } == '!' )
{
$value [ 'selectcols' ] = array_diff ( $value [ 'selectcols' ], explode ( ',' , substr ( $value [ 'default_cols' ], 1 )));
}
else
{
$value [ 'selectcols' ] = $value [ 'default_cols' ];
}
}
}
if ( ! is_array ( $value [ 'selectcols' ])) $value [ 'selectcols' ] = explode ( ',' , $value [ 'selectcols' ]);
foreach ( array_keys ( $value [ 'options-selectcols' ]) as $name )
{
// set 'no_'.$col for each column-name to true, if the column is not selected
// (and the value is not set be the get_rows function / programmer!)
if ( ! isset ( $value [ 'rows' ][ 'no_' . $name ])) $value [ 'rows' ][ 'no_' . $name ] = ! in_array ( $name , $value [ 'selectcols' ]);
// setting '@no_'.$name as disabled attr for each column, that has only a single nextmatch-header
if ( is_object ( $value [ 'template' ]))
{
$col = $name2col [ $name ];
list (, $disabled ) = $value [ 'template' ] -> set_column_attributes ( $col );
//echo "<p>$col: $name: $disabled</p>\n";
if ( ! isset ( $disabled )) $value [ 'template' ] -> set_column_attributes ( $col , 0 , '@no_' . $name );
}
}
//_debug_array($value);
if ( is_object ( $nextmatch ))
{
$size =& $nextmatch -> get_cell_attribute ( 'selectcols' , 'size' );
if ( $size > count ( $value [ 'options-selectcols' ])) $size = '0' . count ( $value [ 'options-selectcols' ]);
if ( ! $GLOBALS [ 'egw_info' ][ 'user' ][ 'apps' ][ 'admin' ])
{
$nextmatch -> disable_cells ( 'default_prefs' );
}
}
// should reset on each submit
unset ( $value [ 'default_prefs' ]);
}
2002-09-17 23:31:45 +02:00
$cell [ 'type' ] = 'template' ;
$cell [ 'label' ] = $cell [ 'help' ] = '' ;
2003-12-09 01:03:41 +01:00
foreach ( array ( 'sort' , 'order' , 'col_filter' ) as $n ) // save them for the sortheader
{
$nm_global [ $n ] = $value [ $n ];
}
2003-06-29 19:00:05 +02:00
$value [ 'bottom' ] = $value ; // copy the values for the bottom-bar
2002-10-01 20:26:30 +02:00
2002-09-17 23:31:45 +02:00
return False ; // NO extra Label
}
2007-03-07 13:30:17 +01:00
/**
* Extract the column names and labels from the template
*
* @ param etemplate & $tmpl
* @ param array & $cols here we add the column - name /- label
* @ param array & $name2col
* @ param array $content nextmatch content , to be able to resolve labels with @ name
2007-05-13 08:19:11 +02:00
* @ return int columns found , count ( $cols )
2007-03-07 13:30:17 +01:00
*/
function _cols_from_tpl ( & $tmpl , & $cols , & $name2col , & $content )
{
//_debug_array($cols);
// fetching column-names & -labels from the template
$cols [ '__content__' ] =& $content ;
$tmpl -> widget_tree_walk ( array ( $this , '_cols_from_tpl_walker' ), $cols );
unset ( $cols [ '__content__' ]);
2007-05-13 08:19:11 +02:00
$name2col = is_array ( $cols [ 'name2col' ]) ? $cols [ 'name2col' ] : array (); unset ( $cols [ 'name2col' ]);
2007-03-07 13:30:17 +01:00
//_debug_array($cols);
foreach ( $cols as $name => $label )
{
if ( ! $label ) unset ( $cols [ $name ]);
}
//_debug_array($cols);
//_debug_array($name2col);
// now we check if a column of the grid has more then one header
$col2names = array ();
foreach ( $name2col as $name => $col )
{
if ( $name != $col ) $col2names [ $col ][] = $name ;
}
//_debug_array($col2names);
$cols2 = $cols ;
$cols = array ();
foreach ( $cols2 as $name => $label )
{
$col = $name ;
// and replace the column letter then with the name concatinated by an underscore
if ( is_array ( $col2names [ $name ]))
{
$name = implode ( '_' , $col2names [ $name ]);
$name2col [ $name ] = $col ;
}
$cols [ $name ] = $label ;
}
2007-05-13 08:19:11 +02:00
//_debug_array($cols);
return count ( $cols );
2007-03-07 13:30:17 +01:00
}
/**
* Extract the column names and labels from the template ( callback for etemplate :: widget_tree_walk ())
*
* @ param array & $widget
* @ param array & $cols here we add the column - name /- label
* @ param string $path
*/
function _cols_from_tpl_walker ( & $widget , & $cols , $path )
{
list ( $type , $subtype ) = explode ( '-' , $widget [ 'type' ]);
if ( $type != 'nextmatch' || ! $subtype || ! $widget [ 'name' ] || $widget [ 'disabled' ])
{
return ;
}
$options = explode ( ',' , $widget [ 'size' ]);
if ( ! ( $label = $widget [ 'label' ]) || in_array ( $subtype , array ( 'header' , 'sortheader' )) && $options [ 1 ])
{
if ( in_array ( $subtype , array ( 'customfilter' , 'sortheader' ))) $subtype = array_shift ( $options );
$label = $options [ 0 ];
}
list (,, $col , $sub ) = explode ( '/' , $path );
$row = ( int ) $col ;
$col = substr ( $col , $row > 9 ? 2 : 1 );
if (( $label { 0 } == '@' || strchr ( $lable , '$' ) !== false ) && is_array ( $cols [ '__content__' ]))
{
$label = etemplate :: expand_name ( $label , $col , $row , '' , '' , $cols [ '__content__' ]);
}
if ( ! isset ( $cols [ $widget [ 'name' ]]) && $label )
{
$label = substr ( $label , - 3 ) == '...' ? lang ( substr ( $label , 0 , - 3 )) : lang ( $label );
if ( ! $sub )
{
$cols [ $widget [ 'name' ]] = $label ;
}
2007-04-29 16:18:08 +02:00
elseif ( strpos ( $cols [ $col ], $label ) === false )
2007-03-07 13:30:17 +01:00
{
$cols [ $col ] .= ( $cols [ $col ] ? ', ' : '' ) . $label ;
$cols [ 'name2col' ][ $col ] = $col ;
}
}
$cols [ 'name2col' ][ $widget [ 'name' ]] = $col ;
//echo "<p>$path: $widget[name] $label</p>\n";
}
2002-09-17 23:31:45 +02:00
2005-02-18 23:44:42 +01:00
/**
* postprocessing method , called after the submission of the form
*
* It has to copy the allowed / valid data from $value_in to $value , otherwise the widget
* will return no data ( if it has a preprocessing method ) . The framework insures that
* the post - processing of all contained widget has been done before .
*
* Only used by select - dow so far
*
* @ param string $name form - name of the widget
* @ param mixed & $value the extension returns here it 's input, if there' s any
* @ param mixed & $extension_data persistent storage between calls or pre - and post - process
* @ param boolean & $loop can be set to true to request a re - submision of the form / dialog
* @ param object & $tmpl the eTemplate the widget belongs too
* @ param mixed & value_in the posted values ( already striped of magic - quotes )
* @ return boolean true if $value has valid content , on false no content will be returned !
*/
2003-12-09 01:03:41 +01:00
function post_process ( $name , & $value , & $extension_data , & $loop , & $tmpl , $value_in )
2002-09-17 23:31:45 +02:00
{
2005-11-09 21:50:45 +01:00
$nm_global = & $GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'nextmatch' ];
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) { echo " <p>nextmatch_widget.post_process(type=' $extension_data[type] ', name=' $name ',value_in= " . print_r ( $value_in , true ) . " ,order=' $nm_global[order] '): value = " ; _debug_array ( $value ); }
2003-12-09 01:03:41 +01:00
switch ( $extension_data [ 'type' ])
{
2006-09-12 17:14:39 +02:00
case 'nextmatch' :
break ;
2007-03-07 13:30:17 +01:00
2003-12-09 01:03:41 +01:00
case 'nextmatch-sortheader' :
if ( $value_in )
{
$nm_global [ 'order' ] = $this -> last_part ( $name );
2005-07-17 23:42:11 +02:00
$nm_global [ 'default_sort' ] = $extension_data [ 'default_sort' ];
2003-12-09 01:03:41 +01:00
}
return False ; // dont report value back, as it's in the wrong location (rows)
2006-09-12 17:14:39 +02:00
default :
2005-07-14 08:47:14 +02:00
case 'select-account' : // used by nextmatch-accountfilter
2003-12-09 01:03:41 +01:00
case 'nextmatch-filterheader' :
2006-09-12 17:14:39 +02:00
if (( string ) $value_in != ( string ) $extension_data [ 'old_value' ])
2003-12-09 01:03:41 +01:00
{
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) echo " <p>setting nm_global[filter][ " . $this -> last_part ( $name ) . " ]=' $value_in ' (was ' $extension_data[old_value] ')</p> \n " ;
2003-12-09 01:03:41 +01:00
$nm_global [ 'filter' ][ $this -> last_part ( $name )] = $value_in ;
}
return False ; // dont report value back, as it's in the wrong location (rows)
2007-03-07 13:30:17 +01:00
case 'nextmatch-header' :
return False ; // nothing to report
2003-12-09 01:03:41 +01:00
}
2002-09-24 23:57:15 +02:00
$old_value = $extension_data ;
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) { echo " old_value= " ; _debug_array ( $old_value ); }
2002-09-17 23:31:45 +02:00
2002-10-16 17:22:06 +02:00
$value [ 'start' ] = $old_value [ 'start' ]; // need to be set, to be reported back
2007-01-22 08:06:15 +01:00
$value [ 'return' ] = $old_value [ 'return' ];
2002-10-16 17:22:06 +02:00
2003-06-29 19:00:05 +02:00
if ( is_array ( $value [ 'bottom' ])) // we have a second bottom-bar
{
2006-03-27 00:17:55 +02:00
$inputs = array ( 'search' , 'cat_id' , 'filter' , 'filter2' , 'num_rows' );
2003-06-29 19:00:05 +02:00
foreach ( $inputs as $name )
{
2005-04-27 22:48:53 +02:00
if ( isset ( $value [ 'bottom' ][ $name ]) && $value [ $name ] == $old_value [ $name ])
2003-06-29 19:00:05 +02:00
{
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) echo " value[ $name ] overwritten by bottom-value[ $name ]=' " . $value [ 'bottom' ][ $name ] . " ', old_value[ $name ]=' " . $old_value [ $name ] . " '<br> \n " ;
2003-06-29 19:00:05 +02:00
$value [ $name ] = $value [ 'bottom' ][ $name ];
}
}
2007-09-22 17:03:03 +02:00
$buttons = array ( 'start_search' , 'first' , 'left' , 'right' , 'last' , 'export' );
2003-06-29 19:00:05 +02:00
foreach ( $buttons as $name )
{
if ( isset ( $value [ 'bottom' ][ $name ]) && $value [ 'bottom' ][ $name ])
{
$value [ $name ] = $value [ 'bottom' ][ $name ];
}
}
2007-03-07 13:30:17 +01:00
if ( $value [ 'bottom' ][ 'savecols' ])
{
$value [ 'selectcols' ] = $value [ 'bottom' ][ 'selectcols' ];
$value [ 'default_prefs' ] = $value [ 'bottom' ][ 'default_prefs' ];
}
2003-06-29 19:00:05 +02:00
unset ( $value [ 'bottom' ]);
}
2006-04-05 17:28:48 +02:00
if ( isset ( $old_value [ 'num_rows' ]) && ! is_null ( $value [ 'num_rows' ]) && $value [ 'num_rows' ] != $old_value [ 'num_rows' ])
2006-03-27 00:17:55 +02:00
{
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) echo " <p>nextmatch_widget::post_process() num_rows changed { $old_value [ 'num_rows' ] } --> { $value [ 'num_rows' ] } ==> looping</p> \n " ;
2006-03-27 00:17:55 +02:00
$loop = true ; // num_rows changed
}
2007-06-08 10:54:04 +02:00
// num_rows: use old value in extension data, if $value['num_rows'] is not set because nm-header is not shown
$value [ 'num_rows' ] = isset ( $value [ 'num_rows' ]) ? ( int ) $value [ 'num_rows' ] : ( int ) $extension_data [ 'num_rows' ];
2007-05-25 14:18:00 +02:00
$max = $value [ 'num_rows' ] ? $value [ 'num_rows' ] : ( int ) $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'maxmatchs' ];
2006-10-21 22:16:25 +02:00
if ( strpos ( $value [ 'search' ], 'xjxquery' )) {
// We deal with advancedsearch
$aXml = $value [ 'search' ];
$value [ 'search' ] = '' ;
$aXml = str_replace ( " <xjxquery><q> " , " & " , $aXml );
$aXml = str_replace ( " </q></xjxquery> " , " " , $aXml );
$value [ 'advsearch_cont' ] = explode ( '&' , $aXml );
//$GLOBALS['egw']->boetemplate = &CreateObject('etemplate.boetemplate');
//print_r($GLOBALS['egw']->boetemplate->get_array($value['advsearch_cont'],'exec[]',true));
//$value['advsearch_cont'] = preg_replace("/exec\[ (.*)/",'$1',$value['advsearch_cont']);
//$value['advsearch_cont'] = preg_replace("\]",'',$value['advsearch_cont']);
//print_r($value['advsearch_cont']);
}
2006-03-27 17:08:47 +02:00
if ( $value [ 'start_search' ] || $value [ 'search' ] != $old_value [ 'search' ] ||
2006-03-27 00:17:55 +02:00
isset ( $value [ 'cat_id' ]) && $value [ 'cat_id' ] != $old_value [ 'cat_id' ] ||
isset ( $value [ 'filter' ]) && $value [ 'filter' ] != $old_value [ 'filter' ] ||
2006-03-27 17:08:47 +02:00
isset ( $value [ 'filter2' ]) && $value [ 'filter2' ] != $old_value [ 'filter2' ])
2002-09-17 23:31:45 +02:00
{
2007-06-21 12:01:02 +02:00
if ( $this -> debug )
{
echo " <p>search=' $old_value[search] '->' $value[search] ', filter=' $old_value[filter] '->' $value[filter] ', filter2=' $old_value[filter2] '->' $value[filter2] '<br> " ;
echo " new filter --> loop</p> " ;
echo " value = " ; _debug_array ( $value );
echo " old_value = " ; _debug_array ( $old_value );
}
2002-09-24 23:57:15 +02:00
$loop = True ;
2002-09-17 23:31:45 +02:00
}
2006-03-27 00:17:55 +02:00
elseif ( $value [ 'first' ] || $value [ 'left' ] && $old_value [ 'start' ] < $max )
2002-09-17 23:31:45 +02:00
{
$value [ 'start' ] = 0 ;
2005-03-05 15:55:38 +01:00
unset ( $value [ 'first' ]);
2002-09-24 23:57:15 +02:00
$loop = True ;
2002-09-17 23:31:45 +02:00
}
elseif ( $value [ 'left' ])
{
2002-09-22 11:30:29 +02:00
$value [ 'start' ] = $old_value [ 'start' ] - $max ;
2005-03-05 15:55:38 +01:00
unset ( $value [ 'left' ]);
2002-09-24 23:57:15 +02:00
$loop = True ;
2002-09-17 23:31:45 +02:00
}
elseif ( $value [ 'right' ])
{
2002-09-22 11:30:29 +02:00
$value [ 'start' ] = $old_value [ 'start' ] + $max ;
2005-03-05 15:55:38 +01:00
unset ( $value [ 'right' ]);
2002-09-24 23:57:15 +02:00
$loop = True ;
2002-09-22 11:30:29 +02:00
}
elseif ( $value [ 'last' ])
{
2006-10-17 19:27:15 +02:00
$value [ 'start' ] = ( int ) (( $old_value [ 'total' ] - 1 ) / $max ) * $max ;
2005-03-05 15:55:38 +01:00
unset ( $value [ 'last' ]);
2002-09-24 23:57:15 +02:00
$loop = True ;
2002-09-17 23:31:45 +02:00
}
2003-12-09 01:03:41 +01:00
elseif ( $nm_global [ 'order' ])
{
$value [ 'order' ] = $nm_global [ 'order' ];
2005-07-17 23:42:11 +02:00
if ( $old_value [ 'order' ] != $value [ 'order' ])
{
$value [ 'sort' ] = $nm_global [ 'default_sort' ];
}
else
{
$value [ 'sort' ] = $old_value [ 'sort' ] != 'DESC' ? 'DESC' : 'ASC' ;
}
2007-06-21 12:01:02 +02:00
if ( $this -> debug ) echo " <p>old_value= $old_value[order] / $old_value[sort] ==> $value[order] / $value[sort] </p> \n " ;
2003-12-09 01:03:41 +01:00
$loop = True ;
}
elseif ( $nm_global [ 'filter' ])
{
if ( ! is_array ( $value [ 'col_filter' ])) $value [ 'col_filter' ] = array ();
2005-07-14 08:47:14 +02:00
2003-12-09 01:03:41 +01:00
$value [ 'col_filter' ] += $nm_global [ 'filter' ];
$loop = True ;
}
2006-04-23 16:44:44 +02:00
elseif ( isset ( $value [ 'searchletter' ]))
{
list ( $value [ 'searchletter' ]) = @ each ( $value [ 'searchletter' ]);
if ( $value [ 'searchletter' ] === 'all' ) $value [ 'searchletter' ] = false ;
$loop = True ;
}
2007-03-07 13:30:17 +01:00
if ( $value [ 'savecols' ])
{
$name = is_object ( $extension_data [ 'template' ]) ? $extension_data [ 'template' ] -> name : $extension_data [ 'template' ];
list ( $app ) = explode ( '.' , $name );
if ( isset ( $extension_data [ 'columnselection_pref' ])) $name = $extension_data [ 'columnselection_pref' ];
$pref = ! $GLOBALS [ 'egw_info' ][ 'user' ][ 'apps' ][ 'admin' ] && $value [ 'default_prefs' ] ? 'default' : 'user' ;
$GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ] = $GLOBALS [ 'egw' ] -> preferences -> add ( $app , 'nextmatch-' . $name , is_array ( $value [ 'selectcols' ]) ?
implode ( ',' , $value [ 'selectcols' ]) : $value [ 'selectcols' ], $pref );
$GLOBALS [ 'egw' ] -> preferences -> save_repository ( false , $pref );
$loop = True ;
}
2007-09-22 17:03:03 +02:00
if ( $value [ 'export' ])
{
$this -> _csv_export ( $extension_data );
}
2002-09-17 23:31:45 +02:00
return True ;
}
2007-09-22 17:03:03 +02:00
var $separator = ';' ;
var $charset_out ;
var $charset ;
/**
* Export the list as csv file download
*
* @ param array $value content of the nextmatch widget
* @ param boolean false = error , eg . get_rows callback does not exits , true = nothing to export , otherwise we do NOT return !
*/
function _csv_export ( & $value )
{
if ( ! isset ( $GLOBALS [ 'egw_info' ][ 'user' ][ 'apps' ][ 'admin' ]))
{
$export_limit = $GLOBALS [ 'egw_info' ][ 'server' ][ 'export_limit' ];
}
list ( $app , $class , $method ) = explode ( '.' , $value [ 'get_rows' ]);
if ( $app && $class )
{
if ( is_object ( $GLOBALS [ $class ])) // use existing instance (put there by a previous CreateObject)
{
$obj =& $GLOBALS [ $class ];
}
else
{
$obj =& CreateObject ( $app . '.' . $class );
}
}
if ( ! is_object ( $obj ) || ! method_exists ( $obj , $method ))
{
$GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'validation_errors' ][ $name ] = " nextmatch_widget::pre_process( $cell[name] ): ' $value[get_rows] ' is no valid method !!! " ;
return false ;
}
$this -> charset = $this -> charset_out = $GLOBALS [ 'egw' ] -> translation -> charset ();
if ( isset ( $value [ 'csv_charset' ]))
{
$this -> charset_out = $value [ 'csv_charset' ];
}
elseif ( $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'csv_charset' ])
{
$this -> charset_out = $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'csv_charset' ];
}
$backup_start = $value [ 'start' ];
$backup_num_rows = $value [ 'num_rows' ];
$value [ 'start' ] = 0 ;
$value [ 'num_rows' ] = 500 ;
$value [ 'csv_export' ] = true ; // so get_rows method _can_ produce different content or not store state in the session
do
{
if ( ! ( $total = $obj -> $method ( $value , $rows , $readonlys = array ())))
{
break ; // nothing to export
}
if ( $export_limit && ( ! is_numeric ( $export_limit ) || $export_limit < $total ))
{
$GLOBALS [ 'egw_info' ][ 'etemplate' ][ 'validation_errors' ][ $name ] = lang ( 'You are not allowed to export more then %1 entries!' , $export_limit );
return false ;
}
if ( ! isset ( $value [ 'no_csv_support' ])) $value [ 'no_csv_support' ] = ! is_array ( $value [ 'csv_fields' ]);
//echo "<p>start=$value[start], num_rows=$value[num_rows]: total=$total, count(\$rows)=".count($rows)."</p>\n";
if ( ! $value [ 'start' ]) // send the neccessary headers
{
$fp = $this -> _csv_open ( $rows [ 0 ], $value [ 'csv_fields' ], $app );
}
//_debug_array($rows);
foreach ( $rows as $key => $row )
{
if ( ! is_numeric ( $key )) continue ; // not a real rows
fwrite ( $fp , $this -> _csv_encode ( $row , $value [ 'csv_fields' ]) . " \n " );
}
$value [ 'start' ] += $value [ 'num_rows' ];
@ set_time_limit ( 10 ); // 10 more seconds
}
while ( $total > $value [ 'start' ]);
unset ( $value [ 'csv_export' ]);
$value [ 'start' ] = $backup_start ;
$value [ 'num_rows' ] = $backup_num_rows ;
if ( $value [ 'no_csv_support' ]) // we need to call the get_rows method in case start&num_rows are stored in the session
{
$obj -> $method ( $value , $rows , $readonlys = array ());
}
if ( $fp )
{
fclose ( $fp );
$GLOBALS [ 'egw' ] -> common -> egw_exit ();
}
return true ;
}
/**
* Opens the csv output ( download ) and writes the header line
*
* @ param array $row0 first row to guess the available fields
* @ param array $fields name => label or name => array ( 'lable' => label , 'type' => type ) pairs
* @ param string $app app - name
* @ return FILE
*/
function _csv_open ( $row0 , & $fields , $app )
{
if ( ! is_array ( $fields ) || ! count ( $fields ))
{
$fields = $this -> _autodetect_fields ( $row0 , $app );
}
$browser =& CreateObject ( 'phpgwapi.browser' );
$browser -> content_header ( 'export.csv' , 'text/comma-separated-values' );
//echo "<pre>";
if (( $fp = fopen ( 'php://output' , 'w' )))
{
$labels = array ();
foreach ( $fields as $field => $label )
{
if ( is_array ( $label )) $label = $label [ 'label' ];
$labels [ $field ] = $label ? $label : $field ;
}
fwrite ( $fp , $this -> _csv_encode ( $labels , $fields , false ) . " \n " );
}
return $fp ;
}
/**
* CSV encode a single row , including some basic type conversation
*
* @ param array $data
* @ param array $fields
* @ param boolean $use_type = true
* @ return string
*/
function _csv_encode ( $data , $fields , $use_type = true )
{
static $date_format , $time_format ;
if ( is_null ( $date_format ))
{
$time_format = $date_format = $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'dateformat' ];
$time_format .= ' ' . ( $GLOBALS [ 'egw_info' ][ 'user' ][ 'preferences' ][ 'common' ][ 'timeformat' ] == 12 ? 'h:ia' : 'H:i' );
}
$out = array ();
foreach ( $fields as $field => $label )
{
$value = ( array ) $data [ $field ];
if ( $use_type && is_array ( $label ) && in_array ( $label [ 'type' ], array ( 'select-account' , 'select-cat' , 'date-time' , 'date' )))
{
foreach ( $value as $key => $val )
{
switch ( $label [ 'type' ])
{
case 'select-account' :
if ( $val ) $value [ $key ] = $GLOBALS [ 'egw' ] -> common -> grab_owner_name ( $val );
break ;
case 'select-cat' :
if ( $val )
{
if ( ! is_object ( $GLOBALS [ 'egw' ] -> categories ))
{
$GLOBALS [ 'egw' ] -> categories =& CreateObject ( 'phpgwapi.categories' );
}
$value [ $key ] = $GLOBALS [ 'egw' ] -> categories -> id2name ( $val );
}
break ;
case 'date-time' :
if ( $val ) $value [ $key ] = date ( $time_format , $val );
break ;
case 'date' :
if ( $val ) $value [ $key ] = date ( $date_format , $val );
break ;
}
}
}
$value = implode ( ', ' , $value );
if ( strpos ( $value , $this -> separator ) !== false || strpos ( $value , " \n " ) !== false || strpos ( $value , " \r " ) !== false )
{
$value = '"' . str_replace ( array ( '\\' , '"' ), array ( '\\\\' , '\\"' ), $value ) . '"' ;
}
$out [] = $value ;
}
$out = implode ( $this -> separator , $out );
if ( $this -> charset_out && $this -> charset != $this -> charset_out )
{
$out = $GLOBALS [ 'egw' ] -> translation -> convert ( $out , $this -> charset , $this -> charset_out );
}
return $out ;
}
/**
* Try to autodetect the fields from the first data - row and the app - name
*
* @ param array $row0 first data - row
* @ param string $app
*/
function _autodetect_fields ( $row0 , $app )
{
$fields = array_combine ( array_keys ( $row0 ), array_keys ( $row0 ));
foreach ( $fields as $name => $label )
{
// try to guess field-type from the fieldname
if ( preg_match ( '/(modified|created|start|end)/' , $name ) && strpos ( $name , 'by' ) === false &&
( ! $row0 [ $name ] || is_numeric ( $row0 [ $name ]))) // only use for real timestamps
{
$fields [ $name ] = array ( 'label' => $label , 'type' => 'date-time' );
}
elseif ( preg_match ( '/(cat_id|category|cat)/' , $name ))
{
$fields [ $name ] = array ( 'label' => $label , 'type' => 'select-cat' );
}
elseif ( preg_match ( '/(owner|creator|modifier|assigned|by|coordinator|responsible)/' , $name ))
{
$fields [ $name ] = array ( 'label' => $label , 'type' => 'select-account' );
}
elseif ( preg_match ( '/(jpeg|photo)/' , $name ))
{
unset ( $fields [ $name ]);
}
}
if ( $app )
{
include_once ( EGW_API_INC . '/class.config.inc.php' );
$config =& new config ( $app );
$config -> read_repository ();
$customfields = isset ( $config -> config_data [ 'customfields' ]) ? $config -> config_data [ 'customfields' ] : $config -> config_data [ 'custom_fields' ];
if ( is_array ( $customfields ))
{
foreach ( $customfields as $name => $data )
{
$fields [ '#' . $name ] = array (
'label' => $data [ 'label' ],
'type' => $data [ 'type' ],
);
}
}
}
//_debug_array($fields);
return $fields ;
}
2002-10-16 16:11:36 +02:00
}