• Home
• Html

PHP Class Html, glpi

Show file Open project: glpi-project/glpi Class Usage Examples

Public Methods

Method	Description
addConfirmationOnAction ( $string, $additionalactions = '' ) : nothing	Add confirmation on button or link before action
ajaxFooter ( )	Display Ajax Footer for debug
ajaxForm ( $selector, $success = "console.log(html);" )	This function provides a mecanism to send html form by ajax
autocompletionTextField ( CommonDBTM $item, $field, $options = [] ) : nothing	Show div with auto completion
back ( ) : nothing	Redirection to $_SERVER['HTTP_REFERER'] page
changeProgressBarMessage ( $msg = " " ) : nothing	Change the Message under the Progress Bar
changeProgressBarPosition ( $crt, $tot, $msg = "" ) : nothing	Change the Progress Bar Position
checkAllAsCheckbox ( $container_id, $rand = '' ) : nothing	Display "check All as" checkbox
clean ( $value, $striptags = true, $keep_bad = 2 ) : clean	Clean display value deleting html tags
cleanId ( $id ) : String	Clean ID used for HTML elements
cleanInputText ( $string ) : clean	Clean string for input text field
cleanParametersURL ( $url ) : clean	Clean all parameters of an URL. Get a clean URL
cleanPostForTextArea ( $value ) : clean	Clean post value for display in textarea
cleanSQLDisplay ( $request )	Clean Display of Request
closeArrowMassives ( $actions, $confirm = [] )	show arrow for massives actions : closing
closeForm ( $display = true ) : String	Create a close form part including CSRF token
computeGenericDateTimeSearch ( $val, $force_day = false, $specifictime = '' ) : computed	Compute date / datetime value resulting of showGenericDateTimeSearch
convDate ( $time, $format = null )	Convert a date YY-MM-DD to DD-MM-YY for calendar
convDateTime ( $time, $format = null )	Convert a date YY-MM-DD HH:MM to DD-MM-YY HH:MM for display in a html table
createProgressBar ( $msg = " " ) : nothing	Create a Dynamic Progress Bar
css ( $url, $options = [] ) : string	Creates a link element for CSS stylesheets.
displayAjaxMessageAfterRedirect ( )
displayBackLink ( )	Display a Link to the last page using http_referer if available else use history.back
displayDebugInfos ( $with_session = true, $ajax = false )	Display Debug Information
displayErrorAndDie ( $message, $minimal = false ) : nothing	Simple Error message page
displayMenuAll ( $menu = [] )	Display responsive menu
displayMessageAfterRedirect ( )	Display a div containing messages set in session in the previous page
displayNotFoundError ( ) : Nothing	Display common message for item not found
displayProgressBar ( $width, $percent, $options = [] ) : nothing	Display a simple progress bar
displayRightError ( ) : Nothing	Display common message for privileges errors
displayTitle ( $ref_pic_link = "", $ref_pic_text = "", $ref_title = "", $ref_btts = "" ) : nothing	Common Title Function
entities_deep ( $value ) : array	Recursivly execute htmlentities on an Array
entity_decode_deep ( $value ) : array	Recursivly execute html_entity_decode on an Array
file ( $options = [] ) : string	Creates an input file field. Send file names in _$name field as array.
fileScript ( $options = [] ) : nothing	fileScript : file upload script
footer ( $keepDB = false )	Print footer for every page
formatAttribute ( $key, $value ) : string	Formats an individual attribute, and returns the string value of the composed attribute.
formatNumber ( $number, $edit = false, $forcedecimal ) : formatted	Convert a number to correct display
generateImageName ( ) : string
getCheckAllAsCheckbox ( $container_id, $rand = '' ) : Get	Get "check All as" checkbox
getCheckbox ( array $options ) : the	Get a checkbox.
getConfirmationOnActionScript ( $string, $additionalactions = '' ) : confirmation	Get confirmation on button or link before action
getCopyrightMessage ( ) : text	Get copyright message as HTML (used in footers)
getCriterionForMassiveCheckboxes ( array $options ) : the	Get the jquery criterion for massive checkbox update We can filter checkboxes by a container or by a tag. We can also select checkboxes that have a given tag and that are contained inside a container
getGenericDateTimeSearchItems ( $options ) : array	Get items to display for showGenericDateTimeSearch
getMassiveActionCheckBox ( $itemtype, $id, array $options = [] ) : get	Get the massive action checkbox
getMenuInfos ( ) : string
getOpenMassiveActionsForm ( $name = '' ) : open	Get open form for massive action string
getSimpleForm ( $action, $btname, $btlabel, array $fields = [], $btimage = '', $btoption = '', $confirm = '' )	create a minimal form for simple action
glpi_flush ( )	Flush the current displayed items (do not works really fine)
header ( $title, $url = '', $sector = "none", $item = "none", $option = "" )	Print a nice HTML head for every page
header_nocache ( )	Set page not to use the cache
helpFooter ( )	Print footer for help page
helpHeader ( $title, $url = '' )	Print a nice HTML head for help page
hidden ( $fieldName, $options = [] ) : string	Creates a hidden input field.
image ( $path, $options = [] ) : string	Creates a formatted IMG element.
imagePaste ( $options = [] ) : nothing	imagePaste : Show image paste for an item, with TinyMce
includeHeader ( $title = '' ) : nothing	Include common HTML headers
initEditorSystem ( $name, $rand = '', $display = true ) : nothing	Init the Editor System to a textarea
initImagePasteSystem ( $name, $rand ) : nothing	Init the Image paste System for tiny mce
input ( $fieldName, $options = [] ) : string	Creates a text input field.
jsAdaptDropdown ( $id, $params = [] ) : String	Adapt dropdown to clean JS
jsAjaxDropdown ( $name, $field_id, $url, $params = [] ) : String	Create Ajax dropdown to clean JS
jsAlertCallback ( $msg, $title, $okCallback = null )	Summary of jsAlertCallback Is a replacement for Javascript native alert function Beware that native alert is synchronous by nature (will block browser waiting an answer from user, but that this is emulating the alert behaviour by using a callback function when user presses 'Ok' button.
jsConfirmCallback ( $msg, $title, $yesCallback = null, $noCallback = null )	Summary of confirmCallback Is a replacement for Javascript native confirm function Beware that native confirm is synchronous by nature (will block browser waiting an answer from user, but that this is emulating the confirm behaviour by using callbacks functions when user presses 'Yes' or 'No' buttons.
jsDisable ( $id ) : String	Get javascript code for disable an item
jsEnable ( $id ) : String	Get javascript code for enable an item
jsGetDropdownValue ( $id ) : string	Get item value
jsGetElementbyID ( $id ) : String	Get javascript code to get item by id
jsHide ( $id ) : String	Get javascript code for hide an item
jsSetDropdownValue ( $id, $value ) : string	Set dropdown value
jsShow ( $id ) : String	Get javascript code for hide an item
link ( $text, $url, $options = [] ) : string	Creates an HTML link.
makeTitle ( $string, $num, $tot ) : String	Create a title for list, as "List (5 on 35)"
nl2br_deep ( $value ) : array	Recursivly execute nl2br on an Array
nullFooter ( )	Print footer for null page
nullHeader ( $title, $url = '' )	Print a nice HTML head with no controls
openArrowMassives ( $formname, $fixed = false, $ontop = false, $onright = false )	show arrow for massives actions : opening
openMassiveActionsForm ( $name = '' ) : nothing	Display open form for massive action
parseAttributes ( $options = [] ) : string	Returns a space-delimited string with items of the $options array.
popFooter ( )	Print footer for a modal window
popHeader ( $title, $url = '', $iframed = false )	Print a nice HTML head for modal window (nothing to display)
printAjaxPager ( $title, $start, $numrows, $additional_info = '' ) : nothing	Print Ajax pager for list in tab panel
printCleanArray ( $tab, $pad, $jsexpand = false ) : nothing	Clean Printing of and array in a table ONLY FOR DEBUG
printPager ( $start, $numrows, $target, $parameters, $item_type_output, $item_type_output_param, $additional_info = '' ) : nothing	Print pager for search option (first/previous/next/last)
printPagerForm ( $action = "" ) : nothing	Display the list_limit combo choice
progressBar ( $id, array $options = [] ) : nothing	Manage progresse bars
redefineAlert ( )	In this function, we redefine 'window.alert' javascript function by a jquery-ui dialog equivalent (but prettier).
redefineConfirm ( )	In this function, we redefine 'window.confirm' javascript function by a jquery-ui dialog equivalent (but prettier).
redirect ( $dest ) : nothing	Redirection hack
redirectToLogin ( $params = '' ) : nothing	Redirection to Login page
resume_name ( $string, $length = 255 ) : cut	Resume a name for display
resume_text ( $string, $length = 255 ) : cut	Resume text for followup
script ( $url ) : String	Returns one or many script tags depending on the number of scripts given.
scriptBlock ( $script ) : string	Wrap $script in a script tag.
scriptEnd ( ) : mixed	End a Buffered section of Javascript capturing.
scriptStart ( )	Begin a script block that captures output until HtmlHelper::scriptEnd() is called. This capturing block will capture all output between the methods and create a scriptBlock from it.
showCheckbox ( array $options = [] ) : nothing
showCheckboxMatrix ( array $columns, array $rows, array $options = [] ) : random	Display choice matrix
showColorField ( $name, $options = [] )	Display Color field
showDateField ( $name, $options = [] ) : rand	Display Date form with calendar
showDateFormItem ( $element, $value = '', $maybeempty = true, $can_edit = true, $minDate = '', $maxDate = '', $displayYear = true ) : rand	Display Date form with calendar
showDateTimeField ( $name, $options = [] ) : rand	Display DateTime form with calendar
showDateTimeFormItem ( $element, $value = '', $time_step, $maybeempty = true, $can_edit = true, $minDate = '', $maxDate = '', $minTime = '', $maxTime = '' ) : rand	Display DateTime form with calendar
showGenericDateTimeSearch ( $element, $value = '', $options = [] ) : rand	Show generic date search
showMassiveActionCheckBox ( $itemtype, $id, array $options = [] ) : show	Show the massive action checkbox
showMassiveActions ( $options = [] ) : nothing	Display massive actions
showProfileSelecter ( $target ) : nothing	Print the form used to select profile if several are available
showSimpleForm ( $action, $btname, $btlabel, array $fields = [], $btimage = '', $btoption = '', $confirm = '' )	create a minimal form for simple action
showToolTip ( $content, $options = [] ) : nothing	Show a tooltip on an item
simpleHeader ( $title, $links = [] )	Print a simple HTML head with links
submit ( $caption, $options = [] ) : string	Creates a submit button element. This method will generate input elements that can be used to submit, and reset forms by using $options. Image submits can be created by supplying an image option
timestampToString ( $time, $display_sec = true, $use_days = true ) : string	Make a good string from the unix timestamp $sec
weblink_extract ( $value ) : clean	Extract url from web link

Method Details