Class Html

$value

string value

$striptags

strip all html tags

$keep_bad

1 : neutralize tag anb content, 2 : remove tag and neutralize content

$value

or array

$value

or array

$time

date to convert

$format

null)

$time

datetime to convert

$format

null)

$string

input text

$url

URL

$value

or array

$string

string to resume

$length

resume length (default 255)

$string

string to resume

$length

resume length (default 255)

$value

string value

$number

Number to display

$edit

display number for edition ? (id edit use . in all case) (false by default)

$forcedecimal

Force decimal number (do not use default value) (default -1)

$time

timestamp

$display_sec

display seconds ? (true by default)

$use_days

use days for display ? (true by default)

$time

$value

value

$dest

Redirection destination

$http_response_code

Forces the HTTP response code to the specified value

$params

to add to URL (default '')

$ref_pic_link

to the image to display (default '')

$ref_pic_text

text of the icon (default '')

$ref_title

to display (default '')

$ref_btts

items to display array(link=>text...) (default '')

$request

request

$with_session

with session information (true by default)

$ajax

If we're called from ajax (false by default)

$url_in

optional url to return (without forcetab param), if empty, we will user HTTP_REFERER from server

$message

displayed before dying

$minimal

to true do not display app menu (false by default)

$string

to display or array of string for using multilines

$additionalactions

additional actions to do on success confirmation (default '')

$string

to display or array of string for using multilines

$additionalactions

additional actions to do on success confirmation (default '')

$id

ID of the progress bar

$options

progress status - create do we have to create it ? - message add or change the message - percent current level

$msg

message (under the bar) (default ' ')

$msg

under the bar (default ' ')

$crt

Value (less then $max)

$tot

Value

$msg

inside the bar (default is %) (default '')

$width

of the progress bar

$percent

of the progress bar

$options

of possible options: - title : string title to display (default Progesssion) - simple : display a simple progress bar (no title / only percent) - forcepadding : boolean force str_pad to force refresh (default true)

$title

title used for the page (default '')

$sector

in which the page displayed is (default 'none')

$item

corresponding to the page displayed (default 'none')

$option

corresponding to the page displayed (default '')

$force

do we need to force regeneration of $_SESSION['glpimenu']

$title

of the page

$url

used anymore (default '')

$sector

in which the page displayed is (default 'none')

$item

corresponding to the page displayed (default 'none')

$option

corresponding to the page displayed (default '')

$keepDB

closeDBConnections if false (false by default)

$title

of the page

$links

of links to display

$title

of the page

$url

used anymore (default '')

$title

of the page

$url

used anymore (default '')

$title

of the page

$url

used anymore (default '')

$iframed

if page loaded in iframe - css target (default false)

$menu

of menu items - key : plugin system name - value : array of options * id : html id attribute * default : defaul url * title : displayed label * content : menu sub items, array with theses options : - page : url - title : displayed label - shortcut : keyboard shortcut letter

$container_id

html of the container of checkboxes link to this check all checkbox

$rand

rand value to use (default is auto generated)(default '')

$options

of parameters: - tag_for_massive tag of the checkboxes to update - container_id if of the container of the checkboxes

javascript code for jquery criterion or empty string if it is not a massive update checkbox

$options

of parameters: - title its title - name its name - id its id - value the value to set when checked - readonly can we edit it ? - massive_tags the tag to set for massive checkbox update - checked is it checked or not ? - zero_on_empty do we send 0 on submit when it is not checked ? - specific_tags HTML5 tags to add - criterion the criterion for massive checkbox

$options

array

$itemtype

action itemtype

$id

of the item

$options

array

$itemtype

action itemtype

$id

of the item

$options

array

$name

name/id to the form (default '')

$name

name/id to the form (default '')

$options

of parameters must contains : - container : DOM ID of the container of the item checkboxes (since version 0.85) may contains : - num_displayed : integer number of displayed items. Permit to check suhosin limit. (default -1 not to check) - ontop : boolean true if displayed on top (default true) - fixed : boolean true if used with fixed table display (default true) - forcecreate : boolean force creation of modal window (default = false). Modal is automatically created when displayed the ontop item. If only a bottom one is displayed use it - check_itemtype : string alternate itemtype to check right if different from main itemtype (default empty) - check_items_id : integer ID of the alternate item used to check right / optional (default empty) - is_deleted : boolean is massive actions for deleted items ? - extraparams : string extra URL parameters to pass to massive actions (default empty) if ([extraparams]['hidden'] is set : add hidden fields to post) - specific_actions : array of specific actions (do not use standard one) - add_actions : array of actions to add (do not use standard one) - confirm : string of confirm message before massive action - item : CommonDBTM object that has to be passed to the actions - tag_to_send : the tag of the elements to send to the ajax window (default: common) - display : display or return the generated html (default true)

$name

of the element

$options

of possible options: - value : default value to display (default '') - maybeempty : may be empty ? (true by default) - canedit : could not modify element (true by default) - min : minimum allowed date (default '') - max : maximum allowed date (default '') - showyear : should we set/diplay the year? (true by default) - display : boolean display of return string (default true) - rand : specific rand value (default generated one) - yearrange : set a year range to show in drop-down (default '')

$name

of the element

$options

of possible options: - value : default value to display (default '') - display : boolean display or get string (default true) - rand : specific random value (default generated one)

$name

of the element

$options

of possible options: - value : default value to display (default '') - timestep : step for time in minute (-1 use default config) (default -1) - maybeempty : may be empty ? (true by default) - canedit : could not modify element (true by default) - mindate : minimum allowed date (default '') - maxdate : maximum allowed date (default '') - mintime : minimum allowed time (default '') - maxtime : maximum allowed time (default '') - showyear : should we set/diplay the year? (true by default) - display : boolean display or get string (default true) - rand : specific random value (default generated one) - required : required field (will add required attribute)

$element

of the html element

$value

value (default '')

$options

of possible options: - with_time display with time selection ? (default false) - with_future display with future date selection ? (default false) - with_days display specific days selection TODAY, BEGINMONTH, LASTMONDAY... ? (default true)

$options

of possible options: - with_time display with time selection ? (default false) - with_future display with future date selection ? (default false) - with_days display specific days selection TODAY, BEGINMONTH, LASTMONDAY... ? (default true)

$val

/ datetime value passed

$force_day

force computation in days (false by default)

$specifictime

set specific timestamp (default '')

$options

of possible options: - title, do we need to append an H2 title tag - dates, an array containing a collection of theses keys: * timestamp * class, supported: passed, checked, now * label - display, boolean to precise if we need to display (true) or return (false) the html - add_now, boolean to precise if we need to add to dates array, an entry for now time (with now class)

$target

of the form

$content

data to put in the tooltip

$options

of possible options: - applyto : string / id of the item to apply tooltip (default empty). If not set display an icon - title : string / title to display (default empty) - contentid : string / id for the content html container (default auto generated) (used for ajax) - link : string / link to put on displayed image if contentid is empty - linkid : string / html id to put to the link link (used for ajax) - linktarget : string / target for the link - popup : string / popup action : link not needed to use it - img : string / url of a specific img to use - display : boolean / display the item : false return the datas - autoclose : boolean / autoclose the item : default true (false permit to scroll)

$item

item object used for create dropdown

$field

field to search for autocompletion

$options

array of possible options: - name : string / name of the select (default is field parameter) - value : integer / preselected value (default value of the item object) - size : integer / size of the text field - entity : integer / restrict to a defined entity (default entity of the object if define) set to -1 not to take into account - user : integer / restrict to a defined user (default -1 : no restriction) - option : string / options to add to text field - display : boolean / if false get string - type : string / html5 field type (number, date, text, ...) defaults to 'text' - required: boolean / whether the field is required - rand : integer / pre-exsting random value - attrs : array of attributes to add (['name' => 'value']

$name

of the html textarea to use

$rand

of the html textarea to use (if empty no image paste system)(default '')

$display

display or get js script (true by default)

$readonly

editor will be readonly or not

$content

content to convert in html

$name

name of textarea

$content

content to convert in html

$rand

used for randomize tinymce dom id

$readonly

true will set editor in readonly mode

$title

displayed above

$start

from witch item we start

$numrows

total items

$additional_info

Additional information to display (default '')

$display

display if true, return the pager if false

$additional_params

Additional parameters to pass to tab reload request (default '')

$tab

array to display

$pad

used (default 0)

$jsexpand

using JS ? (default false)

$start

witch item we start

$numrows

items

$target

would be open when click on the option (last,previous etc)

$parameters

would be passed on the URL.

$item_type_output

type display - if >0 display export PDF et Sylk form (default 0)

$item_type_output_param

type parameter for export (default 0)

$additional_info

information to display (default '')

$action

page would be posted when change the value (URL + param) (default '')

$display

display the pager form if true, return it if false

$additional_params

Additional parameters to pass to tab reload request (default '')

ajax Pager will be displayed if empty

$string

text for title

$num

number of item displayed

$tot

number of item existing

$action

URL to call on submit

$btname

button name (maybe if name <> value)

$btlabel

button label

$fields

field name => field value

$btimage

button image uri (optional) (default '') If image name starts with "fa-", il will be turned into a font awesome element rather than an image.

$btoption

optional button option (default '')

$confirm

optional confirm message (default '')

$action

URL to call on submit

$btname

button name

$btlabel

button label

$fields

field name => field value

$btimage

button image uri (optional) (default '')

$btoption

optional button option (default '')

$confirm

optional confirm message (default '')

$display

Display or return string (default true)

$id

id of the dom element

$id

id of the dom element

$id

id of the dom element

$id

id of the dom element

$id

id of the dom element

$id

id of the dom element

$id

id of the dom element

$value

value to set

$id

id of the dom element

$id

id of the dom element

$params

of parameters

$name

$field_id

id of the dom element

$url

URL to get datas

$params

of parameters must contains : - 'value' : default value selected - 'valuename' : default name of selected value

$path

to the image file

$options

of HTML attributes - url If provided an image link will be generated and the link will point at $options['url'].

$text

content to be wrapped by a tags.

$url

parameter

$options

of HTML attributes: - confirm JavaScript confirmation message. - confirmaction optional action to do on confirmation

$fieldName

of a field

$options

of HTML attributes.

$fieldName

of a field

$options

of HTML attributes.

$name

$ame Name of the field

$values

Array of the options

$options

$selected Current selected option

$options,…

Array of HTML attributes

$caption

of the input

$options

of options. - image : will use a submit image input - confirm JavaScript confirmation message. - confirmaction optional action to do on confirmation

$options

of options.

$key

name of the attribute to create

$value

value of the attribute to create.

$script

script to wrap

$url

File to include (relative to GLPI_ROOT)

$options

Array of HTML attributes

$minify

Try to load minified file (defaults to true)

$url

File to include (relative to GLPI_ROOT)

$options

Array of HTML attributes

$minify

Try to load minified file (defaults to true)

$url

File to include (relative to GLPI_ROOT)

$options

Array of HTML attributes

$url

File to include (raltive to GLPI_ROOT)

$options

Array of HTML attributes

$options

theses following keys: - editor_id the dom id of the tinymce editor

$options

of options - name string field name (default filename) - onlyimages boolean restrict to image files (default false) - filecontainer string DOM ID of the container showing file uploaded: use selector to display - showfilesize boolean show file size with file name - showtitle boolean show the title above file list (with max upload size indication) - enable_richtext boolean switch to richtext fileupload - pasteZone string DOM ID of the paste zone - dropZone string DOM ID of the drop zone - rand string already computed rand value - display boolean display or return the generated html (default true)

$options

with these keys: - name (string): corresponding html attribute - filecontainer (string): dom id for the upload filelist - rand (string): random param to avoid overriding between textareas - editor_id (string): id attribute for the textarea - value (string): value attribute for the textarea - enable_richtext (bool): enable tinymce for this textarea - enable_fileupload (bool): enable the inline fileupload system - display (bool): display or return the generated html - cols (int): textarea cols attribute (witdh) - rows (int): textarea rows attribute (height)

$columns

of column field name => column label

$rows

of field name => array( 'label' the label of the row 'columns' an array of specific information regaring current row and given column indexed by column field_name * a string if only have to display a string * an array('value' => ???, 'readonly' => ???) that is used to Dropdown::showYesNo()

$options

possible: 'title' of the matrix 'first_cell' the content of the upper-left cell 'row_check_all' set to true to display a checkbox to check all elements of the row 'col_check_all' set to true to display a checkbox to check all elements of the col 'rand' random number to use for ids

$msg

message to be shown

$title

title for dialog box

$yesCallback

function that will be called when 'Yes' is pressed (default null)

$noCallback

function that will be called when 'No' is pressed (default null)

$msg

message to be shown

$title

title for dialog box

$okCallback

function that will be called when 'Ok' is pressed (default null)

$document_id

identifier of the document

$width

witdh of the final image

$height

height of the final image

$addLink

boolean, do we need to add an anchor link

$more_link

append to the link (ex &test=true)

$withVersion

include GLPI version ?

$name

Either a know name, or an array defining lib

$file_path

File path part

$url

Original URL (not prefixed)

$timer

The time (in minute) to refresh the page

$callback

A javascript callback function to execute on timer

$action

action to switch (should be actually 'getHtml' or 'getList')

$full

True for full interface, false otherwise

$full

True for full interface, false otherwise

$options

Option

$hexcolor

the color, you can pass hex color (prefixed or not by #) You can also pass a short css color (ex #FFF)

$bw

default true, should we invert the color or return black/white function of the input color

$sbw

$sb default true, should we soft the black/white to a dark/light grey

$args

Arguments. May contain: - v: version to append (will default to GLPI_VERSION) - debug: if present, will not use Crunched formatter - file: filerepresentation to load - reload: force reload and recache - nocache: do not use nor update cache