complete rewrite in 6/2006 and earlier modifications
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @author RalfBecker-AT-outdoor-training.de
* @copyright 2001-2009 by RalfBecker@outdoor-training.de
* @package api
* @subpackage html
* @version $Id$
*/
/**
* Generates html with methods representing html-tags or higher widgets
*
* The class has only static methods now, so there's no need to instanciate as object anymore!
*/
class html
{
/**
* user-agent: 'firefox', 'msie', 'safari' (incl. iPhone, Chrome), 'opera', 'konqueror', 'mozilla'
* @var string
*/
static $user_agent;
/**
* version of user-agent as specified by browser
* @var string
*/
static $ua_version;
/**
* what attribute to use for the title of an image: 'title' for everything but netscape4='alt'
* @var string
*/
static $netscape4;
static private $prefered_img_title;
/**
* charset used by the page, as returned by $GLOBALS['egw']->translation->charset()
* @var string
*/
static $charset;
/**
* URL (NOT path) of the js directory in the api
* @var string
*/
static $api_js_url;
/**
* do we need to set the wz_tooltip class, to be included at the end of the page
* @var boolean
*/
static private $wz_tooltip_included = False;
/**
* initialise our static vars
*/
static function _init_static()
{
// should be Ok for all HTML 4 compatible browsers
if(!preg_match('/compatible; ([a-z]+)[\/ ]+([0-9.]+)/i',$_SERVER['HTTP_USER_AGENT'],$parts))
{
preg_match_all('/([a-z]+)\/([0-9.]+)/i',$_SERVER['HTTP_USER_AGENT'],$parts,PREG_SET_ORDER);
$parts = array_pop($parts);
}
list(,self::$user_agent,self::$ua_version) = $parts;
if ((self::$user_agent = strtolower(self::$user_agent)) == 'version') self::$user_agent = 'opera';
self::$netscape4 = self::$user_agent == 'mozilla' && self::$ua_version < 5;
self::$prefered_img_title = self::$netscape4 ? 'alt' : 'title';
//echo "
\n";
if ($GLOBALS['egw']->translation)
{
self::$charset = $GLOBALS['egw']->translation->charset();
}
self::$api_js_url = $GLOBALS['egw_info']['server']['webserver_url'].'/phpgwapi/js';
}
/**
* Created an input-field with an attached color-picker
*
* Please note: it need to be called before the call to egw_header() !!!
*
* @param string $name the name of the input-field
* @param string $value the actual value for the input-field, default ''
* @param string $title tooltip/title for the picker-activation-icon
* @return string the html
*/
static function inputColor($name,$value='',$title='')
{
$id = str_replace(array('[',']'),array('_',''),$name).'_colorpicker';
$onclick = "javascript:window.open('".self::$api_js_url.'/colorpicker/select_color.html?id='.urlencode($id)."&color='+encodeURIComponent(document.getElementById('$id').value),'colorPicker','width=240,height=187,scrollbars=no,resizable=no,toolbar=no');";
return ' '.
''.
'";
}
/**
* Handles tooltips via the wz_tooltip class from Walter Zorn
*
* Note: The wz_tooltip.js file gets automaticaly loaded at the end of the page
*
* @param string $text text or html for the tooltip, all chars allowed, they will be quoted approperiate
* @param boolean $do_lang (default False) should the text be run though lang()
* @param array $options param/value pairs, eg. 'TITLE' => 'I am the title'. Some common parameters:
* title (string) gives extra title-row, width (int,'auto') , padding (int), above (bool), bgcolor (color), bgimg (URL)
* For a complete list and description see http://www.walterzorn.com/tooltip/tooltip_e.htm
* @return string to be included in any tag, like 'Ralf').'>Text with tooltip'
*/
static function tooltip($text,$do_lang=False,$options=False)
{
if ($do_lang) $text = lang($text);
$ttip = ' onmouseover="Tip(\''.str_replace(array("\n","\r","'",'"'),array('','',"\\'",'"'),$text).'\'';
$sticky = false;
if (is_array($options))
{
foreach($options as $option => $value)
{
$option = strtoupper($option);
if ($option == 'STICKY') $sticky = (bool)$value;
switch(gettype($value))
{
case 'boolean':
$value = $value ? 'true' : 'false';
break;
case 'string':
if (stripos($value,"'")===false) $value = "'$value'";
break;
}
$ttip .= ','.$option.','.$value;
}
}
$ttip .= ')"';
$ttip .= ' onmouseout="UnTip()"';
return $ttip;
}
/**
* activates URLs in a text, URLs get replaced by html-links
*
* @param string $content text containing URLs
* @return string html with activated links
*/
static function activate_links($content)
{
if (!$content || strlen($content) < 20) return $content; // performance
// Exclude everything which is already a link
$NotAnchor = '(?\\1 AT \\2 DOT \\3',
$content);
// First match things beginning with http:// (or other protocols)
$Protocol = '(http:\/\/|(ftp:\/\/|https:\/\/))'; // only http:// gets removed, other protocolls are shown
$Domain = '([\w-]+\.[\w-.]+)';
$Subdir = '([\w\-\.,@?^=%&;:\/~\+#]*[\w\-\@?^=%&\/~\+#])?';
$Expr = '/' . $NotAnchor . $Protocol . $Domain . $Subdir . '/i';
$result = preg_replace( $Expr, "$2$3$4", $result );
// Now match things beginning with www.
$NotHTTP = '(?)'; // avoid running again on http://www links already handled above
$Domain = 'www(\.[\w-.]+)';
$Subdir = '([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#])?';
$Expr = '/' . $NotAnchor . $NotHTTP . $Domain . $Subdir . '/i';
return preg_replace( $Expr, "$0", $result );
}
/**
* activates URLs in a text, URLs get replaced by html-links using htmlpurify
*
* @param string $content text containing URLs
* @return string html with activated links
*/
static function activateLinks($content)
{
if (!$content || strlen($content) < 20) return $content; // performance
// spamsaver emailaddress
$result = preg_replace('/'.$NotAnchor.'mailto:([a-z0-9._-]+)@([a-z0-9_-]+)\.([a-z0-9._-]+)/i',
'\\1 AT \\2 DOT \\3',
$content);
$config = self::purifyCreateDefaultConfig();
$config->set('Core.Encoding', (self::$charset?self::$charset:'UTF-8'));
// maybe the two following lines are useful for caching???
$config->set('HTML.DefinitionID', 'activatelinks');
$config->set('HTML.DefinitionRev', 1);
// doctype and tidylevel
$config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
$config->set('HTML.TidyLevel', 'light');
// EnableID is needed for anchor tags
$config->set('Attr.EnableID',true);
// actual allowed tags and attributes
$config->set('URI.AllowedSchemes', array('http'=>true, 'https'=>true, 'ftp'=>true, 'file'=>true, 'cid'=>true));
$config->set('AutoFormat.RemoveEmpty', true);
$config->set('HTML.Allowed', 'br,p[align],b,i,u,s,em,pre,tt,strong,strike,center,div[align|style],hr[class|style],'.
'font[size|color],'.
'ul[type],ol[type|start],li,'.
'h1,h2,h3,h4,h5,h6,'.
'span[class|style],'.
'table[class|border|cellpadding|cellspacing|width|style|align|bgcolor|align],'.
'tbody,thead,tfoot,colgroup,'.
'col[width|span],'.
'blockquote[class|cite|dir],'.
'tr[class|style|align|bgcolor|align|valign],'.
'td[class|colspan|rowspan|width|style|align|bgcolor|align|valign|nowrap],'.
'th[class|colspan|rowspan|width|style|align|bgcolor|align|valign|nowrap],'.
'a[href|target|name|title],'.
'img[src|alt|title|align|style|width|height]');
$config->set('Attr.DefaultInvalidImage', 'Image removed by htmlpurify');
$config->set('Cache.SerializerPath', ($GLOBALS['egw_info']['server']['temp_dir']?$GLOBALS['egw_info']['server']['temp_dir']:sys_get_temp_dir()));
$config->set('AutoFormat.Linkify',true);
return self::purify($result,$config);
}
/**
* deactivates URLs in a text, URLs get replaced by html-links using htmlpurify
*
* @param string $content text containing URLs
* @return string html with activated links
*/
static function deactivateLinks($_html)
{
$config = self::purifyCreateDefaultConfig();
$config->set('Core.Encoding', (self::$charset?self::$charset:'UTF-8'));
// maybe the two following lines are useful for caching???
$config->set('HTML.DefinitionID', 'deactivatelinks');
$config->set('HTML.DefinitionRev', 1);
// doctype and tidylevel
$config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
$config->set('HTML.TidyLevel', 'light');
// EnableID is needed for anchor tags
$config->set('Attr.EnableID',true);
// actual allowed tags and attributes
$config->set('URI.AllowedSchemes', array('http'=>true, 'https'=>true, 'ftp'=>true, 'file'=>true, 'cid'=>true));
$config->set('AutoFormat.RemoveEmpty', true);
$config->set('HTML.Allowed', 'br,p[align],b,i,u,s,em,pre,tt,strong,strike,center,div[align|style],hr[class|style],'.
'font[size|color],'.
'ul[type],ol[type|start],li,'.
'h1,h2,h3,h4,h5,h6,'.
'span[class|style],'.
'table[class|border|cellpadding|cellspacing|width|style|align|bgcolor|align],'.
'tbody,thead,tfoot,colgroup,'.
'col[width|span],'.
'blockquote[class|cite|dir],'.
'tr[class|style|align|bgcolor|align|valign],'.
'td[class|colspan|rowspan|width|style|align|bgcolor|align|valign|nowrap],'.
'th[class|colspan|rowspan|width|style|align|bgcolor|align|valign|nowrap],'.
'a[href|target|name|title],'.
'img[src|alt|title|align|style|width|height]');
$config->set('Attr.DefaultInvalidImage', 'Image removed by htmlpurify');
$config->set('Cache.SerializerPath', ($GLOBALS['egw_info']['server']['temp_dir']?$GLOBALS['egw_info']['server']['temp_dir']:sys_get_temp_dir()));
$config->set('AutoFormat.DisplayLinkURI',true);
$_html = self::purify($_html,$config);
return $_html;
}
/**
* escapes chars with special meaning in html as entities
*
* Allows to use and char in the html-output and prefents XSS attacks.
* Some entities are allowed and get NOT escaped:
* - &# some translations (AFAIK the arabic ones) need this
* - < > for convinience
*
* @param string $str string to escape
* @return string
*/
static function htmlspecialchars($str)
{
// add @ by lkneschke to supress warning about unknown charset
$str = @htmlspecialchars($str,ENT_COMPAT,self::$charset);
// we need '&#' unchanged, so we translate it back
$str = str_replace(array('&#',' ','<','>'),array('&#',' ','<','>'),$str);
return $str;
}
/**
* allows to show and select one item from an array
*
* @param string $name string with name of the submitted var which holds the key of the selected item form array
* @param string/array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
* @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
* @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
* @param string $options additional options (e.g. 'width')
* @param int $multiple number of lines for a multiselect, default 0 = no multiselect, < 0 sets size without multiple
* @return string to set for a template or to echo into html page
*/
static function select($name, $key, $arr=0,$no_lang=false,$options='',$multiple=0)
{
if (!is_array($arr))
{
$arr = array('no','yes');
}
if ((int)$multiple > 0)
{
$options .= ' multiple="1" size="'.(int)$multiple.'"';
if (substr($name,-2) != '[]')
{
$name .= '[]';
}
}
elseif($multiple < 0)
{
$options .= ' size="'.abs($multiple).'"';
}
// fix width for MSIE in/for selectboxes
if (self::$user_agent == 'msie')
{
if (stripos($options,'onfocus="') === false)
{
$options .= ' onfocus="window.dropdown_menu_hack(this);" ';
}
else
{
$options = str_ireplace('onfocus="','onfocus="window.dropdown_menu_hack(this);',$options);
}
}
$out = "\n";
return $out;
}
/**
* emulating a multiselectbox using checkboxes
*
* Unfortunaly this is not in all aspects like a multi-selectbox, eg. you cant select options via javascript
* in the same way. Therefor I made it an extra function.
*
* @param string $name string with name of the submitted var which holds the key of the selected item form array
* @param string/array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
* @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
* @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
* @param string $options additional options (e.g. 'width')
* @param int $multiple number of lines for a multiselect, default 3
* @param boolean $selected_first show the selected items before the not selected ones, default true
* @param string $style='' extra style settings like "width: 100%", default '' none
* @return string to set for a template or to echo into html page
*/
static function checkbox_multiselect($name, $key, $arr=0,$no_lang=false,$options='',$multiple=3,$selected_first=true,$style='')
{
//echo "
\n";
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 (!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($val,$key,!$val))
{
$selected[$val] = $label;
}
else
{
$not_selected[$val] = $label;
}
}
$arr = $selected + $not_selected;
}
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($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()
* @return string html
*/
static function select_option($value,$label,$selected,$no_lang=0,$title='')
{
// 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;
}
}
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 = serialize($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 string html
*/
static function textarea($name,$value='',$options='' )
{
return "\n";
}
/**
* Checks if HTMLarea (or an other richtext editor) is availible for the used browser
*
* @return boolean
*/
static function htmlarea_availible()
{
/* require_once(EGW_INCLUDE_ROOT.'/phpgwapi/js/fckeditor/fckeditor.php');
// use FCKeditor's own check
return FCKeditor_IsCompatibleBrowser();*/
//CKeditor3 will check availability for us
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 ? $style : 'extended'), 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
* @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)
{
if (!self::htmlarea_availible() || $_mode == 'ascii')
{
return self::textarea($_name,$_content,'style="width: '.$_width.'; height: '.$_height.';"');
}
// run content through htmlpurifier
if ($_purify && !empty($_content)) $_content = self::purify($_content);
$oCKeditor = self::initCKEditor($_height, $_mode, $_options);
/* Resize the editor to the actual size delivered by the $_height parameter once it is initialized */
$pxheight = (strpos('px', $_height) === false) ? (empty($_height)?400:$_height) : str_replace('px', '', $_height);
$events['instanceReady'] = 'function (ev) {
ev.editor.resize("100%", '.str_replace('px', '', $pxheight).');
}';
return $oCKeditor->editor($_name, $_content, null, $events);
}
static function &initCKEditor($_height, $_mode, $_options)
{
include_once(EGW_INCLUDE_ROOT."/phpgwapi/js/ckeditor3/ckeditor_php5.php");
// use the lang and country information to construct a possible lang info for CKEditor UI and scayt_slang
$lang = ($GLOBALS['egw_info']['user']['preferences']['common']['spellchecker_lang'] ? $GLOBALS['egw_info']['user']['preferences']['common']['spellchecker_lang']: $GLOBALS['egw_info']['user']['preferences']['common']['lang']);
$country = $GLOBALS['egw_info']['user']['preferences']['common']['country'];
if (!(strpos($lang,'-')===false)) list($lang,$country) = explode('-',$lang);
//Get the ckeditor base url
$basePath = $GLOBALS['egw_info']['server']['webserver_url'].'/phpgwapi/js/ckeditor3/';
$oCKeditor = new CKeditor($basePath);
$oCKeditor->returnOutput = true;
$oCKeditor->config['customConfig'] = 'ckeditor.egwconfig.js';
$oCKeditor->config['language'] = $lang;
$oCKeditor->config['resize_enabled'] = false;
//switching the encoding as html entities off, as we correctly handle charsets and it messes up the wiki totally
$oCKeditor->config['entities'] = true;
$oCKeditor->config['entities_latin'] = true;
$oCKeditor->config['entities_processNumerical'] = true;
$oCKeditor->config['editingBlock'] = true;
$oCKeditor->config['filebrowserBrowseUrl'] = 'index.php?menuaction=filemanager.filemanager_select.select&mode=open&method=ckeditor_return&path='.urlencode($_start_path);
$oCKeditor->config['filebrowserWindowWidth'] = 640;
$oCKeditor->config['filebrowserWindowHeight'] = 580;
//Only heights with "px" set are supported
$pxheight = (strpos('px', $_height) === false) ? (empty($_height)?400:$_height) : str_replace('px', '', $_height);
$oCKeditor->config['height'] = $pxheight;
// By default the editor start expanded
if ($_options['toolbar_expanded'] == 'false')
$oCKeditor->config['toolbarStartupExpanded'] = false;
// Now setting the admin settings
$spell = '';
if (isset($GLOBALS['egw_info']['server']['enabled_spellcheck']))
{
$spell = '_spellcheck';
if (!empty($GLOBALS['egw_info']['server']['aspell_path']) &&
is_executable($GLOBALS['egw_info']['server']['aspell_path']))
{
$spell = '_aspell';
$oCKeditor->config['extraPlugins'] = 'aspell';
}
$oCKeditor->config['scayt_autoStartup']=true;
$oCKeditor->config['scayt_sLang']=$lang.'_'.strtoupper($country);
}
$oCKeditor->config['disableNativeSpellChecker'] = true;
// Now setting the user preferences
if (isset($GLOBALS['egw_info']['user']['preferences']['common']['rte_enter_mode']))
{
switch ($GLOBALS['egw_info']['user']['preferences']['common']['rte_enter_mode'])
{
case 'p':
$oCKeditor->config['enterMode'] = 1;//'@@CKEDITOR.ENTER_P';
break;
case 'br':
$oCKeditor->config['enterMode'] = 2;//'@@CKEDITOR.ENTER_BR';
break;
case 'div':
$oCKeditor->config['enterMode'] = 3;//'@@CKEDITOR.ENTER_DIV';
break;
}
}
$skin = $GLOBALS['egw_info']['user']['preferences']['common']['rte_skin'];
//Convert old fckeditor skin names to new ones
switch ($skin)
{
case 'silver':
$skin = "v2";
break;
case 'default':
$skin = "kama";
break;
case 'office2003':
$skin = "office2003";
break;
}
//Check whether the skin actually exists, if not, switch to a default
if (!(file_exists($basePath.'skins/'.$skin) || file_exists($skin) || !empty($skin)))
$skin = "office2003";
$oCKeditor->config['skin'] = $skin;
switch($_mode) {
case 'simple':
$oCKeditor->config['toolbar'] = 'egw_simple'.$spell;
$oCKeditor->config['menu_groups'] = '';
break;
default:
case 'extended':
$oCKeditor->config['toolbar'] = 'egw_extended'.$spell;
break;
case 'advanced':
$oCKeditor->config['toolbar'] = 'egw_advanced'.$spell;
break;
}
return $oCKeditor;
}
/**
* 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
* @return string the necessary html for the textarea
*/
static function fckEditorQuick($_name, $_mode, $_content='', $_height='400px', $_width='100%',$_purify=true)
{
if (!self::htmlarea_availible() || $_mode == 'ascii')
{
return "";
}
else
{
return self::fckEditor($_name, $_content, $_mode, array(), $_height, $_width,'',$_purify);
}
}
/**
* 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='' )
{
if ($type)
{
$type = 'type="'.$type.'"';
}
return "\n";
}
/**
* 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 (self::$user_agent == 'msie')
{
$options .= ' style="cursor: pointer;"';
}
if ($image != '')
{
$image = str_replace(array('.gif','.GIF','.png','.PNG'),'',$image);
if (!($path = $GLOBALS['egw']->common->image($app,$image)))
{
$path = $image; // name may already contain absolut path
}
$image = ' src="'.$path.'"';
}
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).'"';
// ';
}
/**
* 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 phpgw-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='')
{
//echo "
\n";
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 $GLOBALS['egw']->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,'',$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
'
*
* @param array $rows with rows, each row is an array of the cols
* @param string $options options for the table-tag
* @param boolean $no_table_tr dont return the table- and outmost tr-tabs, default false=return table+tr
* @return string with html-code of the table
*/
static function table($rows,$options = '',$no_table_tr=False)
{
$html = $no_table_tr ? '' : "
\n";
$part = 0;
foreach($rows as $key => $row)
{
if (!is_array($row))
{
continue; // parameter
}
// get the current part from the optional 'h' or 'f' prefix of the key
$p = $key[0] == 'h' ? html::THEAD : ($key[0] == 'f' ? html::TFOOT : html::TBODY);
if ($part < $p && ($part || $p < self::TBODY)) // add only allowed and neccessary transitions
{
if ($part) $html .= '\n";
$html .= '<'.self::$part2tag[$part=$p].">\n";
}
$html .= $no_table_tr && $key == 1 ? '' : "\t
\n";
}
if ($part) // close current part
{
$html .= "\n";
}
$html .= "
\n";
if ($no_table_tr)
{
$html = substr($html,0,-16);
}
return $html;
}
/**
* changes a selectbox to submit the form if it gets changed, to be used with the sbox-class
*
* @param string $sbox html with the select-box
* @param boolean $no_script if true generate a submit-button if javascript is off
* @return string html
*/
static function sbox_submit( $sbox,$no_script=false )
{
$html = str_replace('').'';
}
return $html;
}
/**
* html-widget showing progessbar with a view div's (html4 only, textual percentage otherwise)
*
* @param mixed $percent percent-value, gets casted to int
* @param string $title title for the progressbar, default ''=the percentage itself
* @param string $options attributes for the outmost div (may include onclick="...")
* @param string $width width, default 30px
* @param string $color color, default '#D00000' (dark red)
* @param string $height height, default 5px
* @return string html
*/
static function progressbar( $percent,$title='',$options='',$width='',$color='',$height='' )
{
$percent = (int) $percent;
if (!$width) $width = '30px';
if (!$height)$height= '5px';
if (!$color) $color = '#D00000';
$title = $title ? self::htmlspecialchars($title) : $percent.'%';
if (self::$netscape4)
{
return $title;
}
return '
