eGroupWare 1.2.106-2 : Vue détaillée de class.html.inc.php

generates html with methods representing html-tags or higher widgets

Constructor: initialised the class-vars

inputColor($name,$value='',$title='') X-Ref

Created an input-field with an attached color-picker

Please note: it need to be called before the call to phpgw_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

tooltip($text,$do_lang=False,$options=False) X-Ref

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/boolean $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:
return: string to be included in any tag, like '<p'.$html->tooltip('Hello <b>Ralf</b>').'>Text with tooltip</p>'

activate_links($content) X-Ref

activates URLs in a text, URLs get replaced by html-links

param: string $content text containing URLs
return: string html with activated links

htmlspecialchars($str) X-Ref

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

select($name, $key, $arr=0,$no_lang=false,$options='',$multiple=0) X-Ref

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

checkbox_multiselect($name, $key, $arr=0,$no_lang=false,$options='',$multiple=3,$selected_first=true,$style='') X-Ref

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

select_option($value,$label,$selected,$no_lang=0,$title='') X-Ref

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

div($content,$options='',$class='',$style='') X-Ref

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

input_hidden($vars,$value='',$ignore_empty=True) X-Ref

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

textarea($name,$value='',$options='' ) X-Ref

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

htmlarea_availible() X-Ref

Checks if HTMLarea (or an other richtext editor) is availible for the used browser

return: boolean

htmlarea($name,$content='',$style='',$base_href='',$plugins='',$custom_toolbar='',$set_width_height_in_config=false) X-Ref

compability function for former used htmlarea. Please use function tinymce now!

creates a textarea inputfield for the htmlarea js-widget (returns the necessary html and js)

init_tinymce() X-Ref

init the tinymce js-widget by adding the js file in the head of the page

Please note: it need to be called before the call to phpgw_header() !!!

tinymce($name,$content='',$style='',$init_options='',$base_href='') X-Ref

creates a textarea inputfield for the tinymce js-widget (returns the necessary html and js)

Please note: if you did not run init_tinymce already you this function need to be called before the call to phpgw_header() !!!

param: string $name name and id of the input-field
param: string $content='' of the tinymce (will be run through htmlspecialchars !!!), default ''
param: string $style='' initial css for the style attribute
param: string $init_options='', see http://tinymce.moxiecode.com/ for all init options. mode and elements are allready set.
return: string the necessary html for the textarea

input($name,$value='',$type='',$options='' ) X-Ref

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

submit_button($name,$label,$onClick='',$no_lang=false,$options='',$image='',$app='phpgwapi') X-Ref

represents html's button (input type submit 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
return: string html

link($url,$vars='') X-Ref

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

checkbox($name,$checked=false,$value='True',$options='') X-Ref

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

form($content,$hidden_vars,$url,$url_vars='',$name='',$options='',$method='POST') X-Ref

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 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

form_1button($name,$label,$hidden_vars,$url,$url_vars='',$form_name='',$method='POST') X-Ref

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 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

table($rows,$options = '',$no_table_tr=False) X-Ref

creates table from array of rows

abstracts the html stuff for the table creation
Example: $rows = array (
'1' => array(
1 => 'cell1', '.1' => 'colspan=3',
2 => 'cell2',
3 => 'cell3', '.3' => 'width="10%"'
),'.1' => 'BGCOLOR="#0000FF"' );
table($rows,'width="100%"') = '<table width="100%"><tr><td colspan=3>cell1</td><td>cell2</td><td width="10%">cell3</td></tr></table>'

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

sbox_submit( $sbox,$no_script=false ) X-Ref

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

progressbar( $percent,$title='',$options='',$width='',$color='',$height='' ) X-Ref

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

image( $app,$name,$title='',$options='' ) X-Ref

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

a_href( $content,$url,$vars='',$options='') X-Ref

representates a html link

param: string $content of the link, if '' only the opening tag gets returned
param: string $url eGW relative URL, will be run through the link function
param: string/array $vars parameters for the URL, send to link function too
param: string $options attributes for the tag, default ''=none
return: string the html

bold($content) X-Ref

representates a b tab (bold)

param: string $content of the link, if '' only the opening tag gets returned
return: string the html

italic($content) X-Ref

representates a i tab (bold)

param: string $content of the link, if '' only the opening tag gets returned
return: string the html

hr($width='',$options='') X-Ref

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

formatOptions($options,$names) X-Ref

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

themeStyles() X-Ref

returns simple stylesheet (incl. <STYLE> tags) for nextmatch row-colors

return: string classes 'th' = nextmatch header, 'row_on'+'row_off' = alternating rows

theme2css() X-Ref

returns simple stylesheet for nextmatch row-colors

return: string classes 'th' = nextmatch header, 'row_on'+'row_off' = alternating rows

style($styles) X-Ref

html style tag (incl. type)

param: string $styles css-style definitions
return: string html

label($content,$id='',$accesskey='',$options='') X-Ref

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

fieldset($content,$legend='',$options='') X-Ref

html fieldset, eg. groups a group of radiobuttons

param: string $content the content
param: string $legend legend / label of the fieldset, default ''=none
param: string $options attributes for the tag, default ''=none
return: string the html

tree($_folders,$_selected,$_topFolder=false,$_onNodeSelect="null",$_divId='foldertree',$_divClass='',$_leafImage='',$_onCheckHandler=false,$delimiter='/') X-Ref

tree widget using dhtmlXtree

Code inspired by Lars's Felamimail uiwidgets::createFolderTree()

author: Lars Kneschke <lars-AT-kneschke.de> original code in felamimail
param: array $_folders array of folders: pairs path => node (string label or array with keys: label, (optional) image, (optional) title, (optional) checked)
param: string $_selected path of selected folder
param: mixed $_topFolder=false node of topFolder or false for none
param: string $_onNodeSelect='alert' js function to call if node gets selected
param: string $_divId='foldertree' id of the div
param: string $_divClass='' css class of the div
param: string $_leafImage='' default image of a leaf-node, ''=default of foldertree, set it eg. 'folderClosed.gif' to show leafs as folders
param: boolean/string $_onCheckHandler=false string with handler-name to display a checkbox for each folder, or false (default)
param: string $delimiter='/' path-delimiter, default /
return: string the html code, to be added into the template

Poids:	1185 lignes (41 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de eGroupWare 1.2.106-2

/phpgwapi/inc/ -> class.html.inc.php (sommaire)

Définit 1 class