checkbox_multiselect('$name',".array2string($key).",".array2string($arr).",$no_lang,'$options',$multiple,$selected_first,'$style')
\n"; if(is_null($enhanced)) $enhanced = (count($arr) > self::SELECT_ENHANCED_ROW_COUNT); if (!is_array($arr)) { $arr = array('no','yes'); } if ((int)$multiple <= 0) $multiple = 1; if (substr($name,-2) != '[]') { $name .= '[]'; } $base_name = substr($name,0,-2); if($enhanced) return self::select($name, $key, $arr,$no_lang,$options." style=\"$style\" ",$multiple,$enhanced); if (!is_array($key)) { // explode on ',' only if multiple values expected and the key contains just numbers and commas $key = preg_match('/^[,0-9]+$/',$key) ? explode(',',$key) : array($key); } $html = ''; $options_no_id = preg_replace('/id="[^"]+"/i','',$options); if ($selected_first) { $selected = $not_selected = array(); foreach($arr as $val => $label) { if (in_array((string)$val,$key)) { $selected[$val] = $label; } else { $not_selected[$val] = $label; } } $arr = $selected + $not_selected; } $max_len = 0; foreach($arr as $val => $label) { if (is_array($label)) { $title = $label['title']; $label = $label['label']; } else { $title = ''; } if ($label && !$no_lang) $label = lang($label); if ($title && !$no_lang) $title = lang($title); if (strlen($label) > $max_len) $max_len = strlen($label); $html .= self::label(self::checkbox($name,in_array((string)$val,$key),$val,$options_no_id. ' id="'.$base_name.'['.$val.']'.'"').self::htmlspecialchars($label), $base_name.'['.$val.']','',($title ? 'title="'.self::htmlspecialchars($title).'" ':''))."\n"; } if ($style && substr($style,-1) != ';') $style .= '; '; if (strpos($style,'height')===false) $style .= 'height: '.(1.7*$multiple).'em; '; if (strpos($style,'width')===false) $style .= 'width: '.(4+$max_len*($max_len < 15 ? 0.65 : 0.6)).'em; '; $style .= 'background-color: white; overflow: auto; border: lightgray 2px inset; text-align: left;'; return self::div($html,$options,'',$style); } /** * generates an option-tag for a selectbox * * @param string $value value * @param string $label label * @param mixed $selected value or array of values of options to mark as selected * @param boolean $no_lang NOT running the label through lang(), default false=use lang() * @param string $extra extra text, e.g.: style="", default: '' * @return string html */ static function select_option($value,$label,$selected,$no_lang=0,$title='',$extra='') { // the following compares strict as strings, to archive: '0' == 0 != '' // the first non-strict search via array_search, is for performance reasons, to not always search the whole array with php if (($found = ($key = array_search($value,$selected)) !== false) && (string) $value !== (string) $selected[$key]) { $found = false; foreach($selected as $sel) { if (($found = (((string) $value) === ((string) $selected[$key])))) break; } unset($sel); } return '\n"; } /** * generates a div-tag * * @param string $content of a div, or '' to generate only the opening tag * @param string $options to include in the tag, default ''=none * @param string $class css-class attribute, default ''=none * @param string $style css-styles attribute, default ''=none * @return string html */ static function div($content,$options='',$class='',$style='') { if ($class) $options .= ' class="'.$class.'"'; if ($style) $options .= ' style="'.$style.'"'; return "
\n".($content ? "$content
\n" : '');
}
/**
* generate one or more hidden input tag(s)
*
* @param array|string $vars var-name or array with name / value pairs
* @param string $value value if $vars is no array, default ''
* @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
* @param string html
*/
static function input_hidden($vars,$value='',$ignore_empty=True)
{
if (!is_array($vars))
{
$vars = array( $vars => $value );
}
foreach($vars as $name => $value)
{
if (is_array($value))
{
$value = json_encode($value);
}
if (!$ignore_empty || $value && !($name == 'filter' && $value == 'none')) // dont need to send all the empty vars
{
$html .= "\n";
}
}
return $html;
}
/**
* generate a textarea tag
*
* @param string $name name attr. of the tag
* @param string $value default
* @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
* @param boolean $double_encoding =false do we want double encoding or not, default no
* @param string html
*/
static function textarea($name,$value='',$options='',$double_encoding=false)
{
return "\n";
}
/**
* Checks if HTMLarea (or an other richtext editor) is availible for the used browser
*
* @return boolean
*/
static function htmlarea_availible()
{
// this one is for testing how it will turn out, if you do not have the device or agent ready at your fingertips
// if (stripos($_SERVER[HTTP_USER_AGENT],'mozilla') !== false) return false;
return true;
}
/**
* compability static function for former used htmlarea. Please use static function fckeditor now!
*
* creates a textarea inputfield for the htmlarea js-widget (returns the necessary html and js)
*/
static function htmlarea($name,$content='',$style='',$base_href=''/*,$plugins='',$custom_toolbar='',$set_width_height_in_config=false*/)
{
/*if (!self::htmlarea_availible())
{
return self::textarea($name,$content,'style="'.$style.'"');
}*/
return self::fckEditor($name, $content, $style, array('toolbar_expanded' =>'true'), '400px', '100%', $base_href);
}
/**
* this static function is a wrapper for fckEditor to create some reuseable layouts
*
* @param string $_name name and id of the input-field
* @param string $_content of the tinymce (will be run through htmlspecialchars !!!), default ''
* @param string $_mode display mode of the tinymce editor can be: simple, extended or advanced
* @param array $_options (toolbar_expanded true/false)
* @param string $_height ='400px'
* @param string $_width ='100%'
* @param string $_start_path ='' if passed activates the browser for image at absolute path passed
* @param boolean $_purify =true run $_content through htmlpurifier before handing it to fckEditor
* @param mixed (boolean/string) $_focusToBody=false USED only for CKEDIOR true means yes, focus on top, you may specify TOP or BOTTOM (to focus on the end of the editor area)
* @param string $_executeJSAfterInit ='' Javascript to be executed after InstanceReady of CKEditor
* @return string the necessary html for the textarea
*/
static function fckEditor($_name, $_content, $_mode, $_options=array('toolbar_expanded' =>'true'),
$_height='400px', $_width='100%',$_start_path='',$_purify=true, $_focusToBody=false, $_executeJSAfterInit='')
{
//not used anymore but defined in function signature
unset ($_options);
if (!self::htmlarea_availible() || $_mode == 'ascii')
{
return self::textarea($_name,$_content,'style="width: '.$_width.'; height: '.$_height.';" id="'.htmlspecialchars($_name).'"');
}
//include the ckeditor js file
Framework::includeJS('/api/js/tinymce/tinymce.min.js');
// run content through htmlpurifier
if ($_purify && !empty($_content))
$_content = self::purify($_content);
// User preferences
$font = $GLOBALS['egw_info']['user']['preferences']['common']['rte_font'];
$font_size = $GLOBALS['egw_info']['user']['preferences']['common']['rte_font_size'];
$font_size_unit = $GLOBALS['egw_info']['user']['preferences']['common']['rte_font_unit'];
$rte_menubar = $GLOBALS['egw_info']['user']['preferences']['common']['rte_menubar'];
$focusToBody = $_focusToBody ? "tinymce" : false;
ContentSecurityPolicy::add('script-src', 'unsafe-inline');
// we need to enable double encoding here, as ckEditor has to undo one level of encoding
// otherwise < and > chars eg. from html markup entered in regular (not source) input, will turn into html!
//error_log(__METHOD__.__LINE__.' '.Header\UserAgent::type().','.Header\UserAgent::version());
return self::textarea($_name,$_content,'id="'.htmlspecialchars($_name).'"',true). // true = double encoding
'
';
}
/**
* this static function is a wrapper for tinymce to create some reuseable layouts
*
* Please note: if you did not run init_tinymce already you this static function need to be called before the call to phpgw_header() !!!
*
* @param string $_name name and id of the input-field
* @param string $_mode display mode of the tinymce editor can be: simple, extended or advanced
* @param string $_content ='' of the tinymce (will be run through htmlspecialchars !!!), default ''
* @param string $_height ='400px'
* @param string $_width ='100%'
* @param boolean $_purify =true
* @param string $_border ='0px' NOT used for CKEditor
* @param mixed (boolean/string) $_focusToBody=false USED only for CKEDIOR true means yes, focus on top, you may specify TOP or BOTTOM (to focus on the end of the editor area)
* @param string $_executeJSAfterInit ='' Javascript to be executed after InstanceReady of CKEditor
* @return string the necessary html for the textarea
*/
static function fckEditorQuick($_name, $_mode, $_content='', $_height='400px', $_width='100%',$_purify=true, $_border='0px',$_focusToBody=false,$_executeJSAfterInit='')
{
if (!self::htmlarea_availible() || $_mode == 'ascii')
{
//TODO: use self::textarea
return "";
}
else
{
return self::fckEditor($_name, $_content, $_mode, array(), $_height, $_width,'',$_purify,$_focusToBody,$_executeJSAfterInit);
}
}
/**
* represents html's input tag
*
* @param string $name name
* @param string $value default value of the field
* @param string $type type, default ''=not specified = text
* @param string $options attributes for the tag, default ''=none
*/
static function input($name,$value='',$type='',$options='' )
{
switch ((string)$type)
{
case '';
break;
default:
$type = 'type="'.htmlspecialchars($type).'"';
}
return "\n";
}
static protected $default_background_images = array(
'save' => '/save(&|\]|$)/',
'apply' => '/apply(&|\]|$)/',
'cancel' => '/cancel(&|\]|$)/',
'delete' => '/delete(&|\]|$)/',
'edit' => '/edit(&|\]|$)/',
'next' => '/(next|continue)(&|\]|$)/',
'finish' => '/finish(&|\]|$)/',
'back' => '/(back|previous)(&|\]|$)/',
'copy' => '/copy(&|\]|$)/',
'more' => '/more(&|\]|$)/',
'check' => '/(yes|check)(&|\]|$)/',
'cancelled' => '/no(&|\]|$)/',
'ok' => '/ok(&|\]|$)/',
'close' => '/close(&|\]|$)/',
'add' => '/(add(&|\]|$)|create)/', // customfields use create*
);
static protected $default_classes = array(
'et2_button_cancel' => '/cancel(&|\]|$)/', // yellow
'et2_button_question' => '/(yes|no)(&|\]|$)/', // yellow
'et2_button_delete' => '/delete(&|\]|$)/' // red
);
/**
* represents html's button (input type submit or input type button or image)
*
* @param string $name name
* @param string $label label of the button
* @param string $onClick javascript to call, when button is clicked
* @param boolean $no_lang NOT running the label through lang(), default false=use lang()
* @param string $options attributes for the tag, default ''=none
* @param string $image to show instead of the label, default ''=none
* @param string $app app to search the image in
* @param string $buttontype which type of html button (button|submit), default ='submit'
* @return string html
*/
static function submit_button($name,$label,$onClick='',$no_lang=false,$options='',$image='',$app='phpgwapi', $buttontype='submit')
{
// workaround for idots and IE button problem (wrong cursor-image)
if (Header\UserAgent::type() == 'msie')
{
$options .= ' style="cursor: pointer;"';
}
// add et2_classes to "old" buttons
$classes = array('et2_button');
if ($image != '')
{
$image = str_replace(array('.gif','.GIF','.png','.PNG'),'',$image);
if (!($path = Image::find($app, $image)))
{
$path = $image; // name may already contain absolut path
}
$image = ' src="'.$path.'"';
$classes[] = 'image_button';
}
if (!$no_lang)
{
$label = lang($label);
}
if (($accesskey = @strstr($label,'&')) && $accesskey[1] != ' ' &&
(($pos = strpos($accesskey,';')) === false || $pos > 5))
{
$label_u = str_replace('&'.$accesskey[1],''.$accesskey[1].'',$label);
$label = str_replace('&','',$label);
$options .= ' accesskey="'.$accesskey[1].'" '.$options;
}
else
{
$accesskey = '';
$label_u = $label;
}
if ($onClick) $options .= ' onclick="'.str_replace('"','\\"',$onClick).'"';
// add default background-image to get et2 like buttons
foreach(self::$default_background_images as $img => $reg_exp)
{
if (preg_match($reg_exp, $name) && ($url = Image::find($GLOBALS['egw_info']['flags']['currentapp'], $img)))
{
$options .= ' style="background-image: url('.$url.');"';
$classes[] = 'et2_button_with_image et2_button_text';
break;
}
}
// add default class for cancel, delete or yes/no buttons
foreach(self::$default_classes as $class => $reg_exp)
{
if (preg_match($reg_exp, $name))
{
$classes[] = $class;
break;
}
}
if (strpos($options, 'class="') !== false)
{
$options = str_replace('class="', 'class="'.implode(' ', $classes).' ', $options);
}
else
{
$options .= ' class="'.implode(' ', $classes).'"';
}
return '';
}
/**
* creates an absolut link + the query / get-variables
*
* Example link('/index.php?menuaction=infolog.uiinfolog.get_list',array('info_id' => 123))
* gives 'http://domain/phpgw-path/index.php?menuaction=infolog.uiinfolog.get_list&info_id=123'
*
* @param string $_url egw-relative link, may include query / get-vars
* @param array|string $vars query or array ('name' => 'value', ...) with query
* @return string absolut link already run through $phpgw->link
*/
static function link($_url,$vars='')
{
if (!is_array($vars))
{
parse_str($vars,$vars);
}
list($url,$v) = explode('?', $_url); // url may contain additional vars
if ($v)
{
parse_str($v,$v);
$vars += $v;
}
return Framework::link($url,$vars);
}
/**
* represents html checkbox
*
* @param string $name name
* @param boolean $checked box checked on display
* @param string $value value the var should be set to, default 'True'
* @param string $options attributes for the tag, default ''=none
* @return string html
*/
static function checkbox($name,$checked=false,$value='True',$options='')
{
return '\n";
}
/**
* represents a html form
*
* @param string $content of the form, if '' only the opening tag gets returned
* @param array $hidden_vars array with name-value pairs for hidden input fields
* @param string $_url eGW relative URL, will be run through the link function, if empty the current url is used
* @param string|array $url_vars parameters for the URL, send to link static function too
* @param string $name name of the form, defaul ''=none
* @param string $options attributes for the tag, default ''=none
* @param string $method method of the form, default 'POST'
* @return string html
*/
static function form($content,$hidden_vars,$_url,$url_vars='',$name='',$options='',$method='POST')
{
$url = $_url ? self::link($_url, $url_vars) : $_SERVER['PHP_SELF'].'?'.$_SERVER['QUERY_STRING'];
$html = "\n";
}
return $html;
}
/**
* represents a html form with one button
*
* @param string $name name of the button
* @param string $label label of the button
* @param array $hidden_vars array with name-value pairs for hidden input fields
* @param string $url eGW relative URL, will be run through the link function
* @param string|array $url_vars parameters for the URL, send to link static function too
* @param string $options attributes for the tag, default ''=none
* @param string $form_name name of the form, defaul ''=none
* @param string $method method of the form, default 'POST'
* @return string html
*/
static function form_1button($name,$label,$hidden_vars,$url,$url_vars='',$form_name='',$method='POST')
{
return self::form(self::submit_button($name,$label),$hidden_vars,$url,$url_vars,$form_name,' style="display: inline-block"',$method);
}
const THEAD = 1;
const TFOOT = 2;
const TBODY = 3;
static $part2tag = array(
self::THEAD => 'thead',
self::TFOOT => 'tfoot',
self::TBODY => 'tbody',
);
/**
* creates table from array of rows
*
* abstracts the html stuff for the table creation
* Example: $rows = array (
* 'h1' => array( // optional header row(s)
* ),
* 'f1' => array( // optional footer row(s)
* ),
* '1' => array(
* 1 => 'cell1', '.1' => 'colspan=3',
* 2 => 'cell2',
* 3 => 'cell3', '.3' => 'width="10%"'
* ),'.1' => 'BGCOLOR="#0000FF"' );
* table($rows,'width="100%"') = '| cell1 | cell2 | cell3 | ||
'.$title.'
'."\n\t".
''."\n
\n";
}
/**
* representates a html img tag, output a picture
*
* If the name ends with a '%' and the rest is numeric, a progressionbar is shown instead of an image.
* The vfs:/ pseudo protocoll allows to access images in the vfs, eg. vfs:/home/ralf/me.png
* Instead of a name you specify an array with get-vars, it is passed to eGW's link function.
* This way session-information gets passed, eg. $name=array('menuaction'=>'myapp.class.image','id'=>123).
*
* @param string $app app-name to search the image
* @param string|array $name image-name or URL (incl. vfs:/) or array with get-vars
* @param string $title tooltip, default '' = none
* @param string $options further options for the tag, default '' = none
* @return string the html
*/
static function image( $app,$name,$title='',$options='' )
{
if (is_array($name)) // menuaction and other get-vars
{
$name = $GLOBALS['egw']->link('/index.php',$name);
}
if (substr($name,0,5) == 'vfs:/') // vfs pseudo protocoll
{
$name = Framework::link(Vfs::download_url(substr($name,4)));
}
if ($name[0] == '/' || substr($name,0,7) == 'http://' || substr($name,0,8) == 'https://' || stripos($name,'api/thumbnail.php') )
{
if (!($name[0] == '/' || substr($name,0,7) == 'http://' || substr($name,0,8) == 'https://')) $name = '/'.$name;
$url = $name;
}
else // no URL, so try searching the image
{
$name = str_replace(array('.gif','.GIF','.png','.PNG'),'',$name);
if (!($url = Image::find($app,$name)))
{
$url = $name; // name may already contain absolut path
}
if($GLOBALS['egw_info']['server']['webserver_url'])
{
list(,$path) = explode($GLOBALS['egw_info']['server']['webserver_url'],$url);
if (!is_null($path)) $path = EGW_SERVER_ROOT.$path;
}
else
{
$path = EGW_SERVER_ROOT.$url;
}
if (is_null($path) || (!@is_readable($path) && stripos($path,'webdav.php')===false))
{
// if the image-name is a percentage, use a progressbar
if (substr($name,-1) == '%' && is_numeric($percent = substr($name,0,-1)))
{
return self::progressbar($percent,$title);
}
return $title;
}
}
if ($title)
{
$options .= ' title="'.self::htmlspecialchars($title).'"';
}
// This block makes pngfix.js useless, adding a check on disable_pngfix to have pngfix.js do its thing
if (Header\UserAgent::type() == 'msie' && Header\UserAgent::version() < 7.0 && substr($url,-4) == '.png' && ($GLOBALS['egw_info']['user']['preferences']['common']['disable_pngfix'] || !isset($GLOBALS['egw_info']['user']['preferences']['common']['disable_pngfix'])))
{
$extra_styles = "display: inline-block; filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(src='$url',sizingMethod='image'); width: 1px; height: 1px;";
if (false!==strpos($options,'style="'))
{
$options = str_replace('style="','style="'.$extra_styles, $options);
}
else
{
$options .= ' style="'.$extra_styles.'"';
}
return "";
}
return "self::a_href('".self::htmlspecialchars($content)."','$url',".print_r($vars,True).") = ".self::link($url,$vars)."
"; return ''.$content.''; } /** * representates a b tag (bold) * * @param string $content of the link, if '' only the opening tag gets returned * @return string the html */ static function bold($content) { return ''.($content?$content.'':''); } /** * representates a hr tag (horizontal rule) * * @param string $width default ''=none given * @param string $options attributes for the tag, default ''=none * @return string the html */ static function hr($width='',$options='') { if ($width) $options .= " width=\"$width\""; return "\n"; } /** * formats option-string for most of the above functions * * Example: formatOptions('100%,,1','width,height,border') = ' width="100%" border="1"' * * @param mixed $options String (or Array) with option-values eg. '100%,,1' * @param mixed $names String (or Array) with the option-names eg. 'WIDTH,HEIGHT,BORDER' * @return string with options/attributes */ static function formatOptions($options,$names) { if (!is_array($options)) $options = explode(',',$options); if (!is_array($names)) $names = explode(',',$names); foreach($options as $n => $val) { if ($val != '' && $names[$n] != '') { $html .= ' '.strtolower($names[$n]).'="'.$val.'"'; } } return $html; } /** * html style tag (incl. type) * * @param string $styles css-style definitions * @return string html */ static function style($styles) { return $styles ? "" : ''; } /** * html label tag * * @param string $content the label * @param string $id for the for attribute, default ''=none * @param string $accesskey accesskey, default ''=none * @param string $options attributes for the tag, default ''=none * @return string the html */ static function label($content,$id='',$accesskey='',$options='') { if ($id != '') { $id = " for=\"$id\""; } if ($accesskey != '') { $accesskey = " accesskey=\"$accesskey\""; } return "
path=$path, _selected=".print_r($_selected,true).": $entryOptions
\n"; } // highlight current item elseif ((string)$_selected === (string)$path) { $entryOptions .= ',SELECT'; } $html .= "$tree.insertNewItem('".addslashes($parentName)."','".addslashes($path)."','".addslashes($label). "',$_onNodeSelect,$image1,$image2,$image3,'$entryOptions');\n"; if (isset($data['title'])) { $html .= "$tree.setItemText('".addslashes($path)."','".addslashes($label)."','".addslashes($data['title'])."');\n"; } ++$n; } } $html .= "$tree.closeAllItems(0);\n"; if ($_selected) { foreach(is_array($_selected)?$_selected:array($_selected) as $path) { $html .= "$tree.openItem('".addslashes($path)."');\n"; } } else { $html .= "$tree.openItem('$top');\n"; } $html .= "});"; $html .= "\n"; return $html; } /** * Runs HTMLPurifier over supplied html to remove malicious code * * @param string $html * @param array|string $config =null - config to influence the behavior of current purifying engine * @param array|string $spec =null - spec to influence the behavior of current purifying engine * The $spec argument can be used to disallow an otherwise legal attribute for an element, * or to restrict the attribute's values * @param boolean $_force =null - force the config passed to be used without merging to the default */ static function purify($html,$config=null,$spec=array(),$_force=false) { return Html\HtmLawed::purify($html, $config, $spec, $_force); } }