Zikula Developer Documentation :: Docs For Class HtmlUtil

[ ] [ ] [ ] [ Todo List ]

Class: HtmlUtil

Source Location: /pnobjlib/HtmlUtil.class.php

Class Overview

HTMLUtil

Methods

Inherited Variables

Inherited Methods

Class Details

[line 19] HTMLUtil

[ Top ]

Class Methods

method buildCalendarInputBox [line 32]

The buildCalendarInputBox(
objectname
$objectname, htmlname
$htmlname, dateFormat
$dateFormat, [defaultString
$defaultString = ''], [defaultDate
$defaultDate = ''])

Return the HTML code for the specified date selector input box

Tags:

return:

resulting HTML string

Parameters:

objectname	$objectname	The name of the object the field will be placed in
htmlname	$htmlname	The html fieldname under which the date value will be submitted
dateFormat	$dateFormat	The dateformat to use for displaying the chosen date
defaultString	$defaultString	The String to display before a value has been selected
defaultDate	$defaultDate	The Date the calendar should to default to

[ Top ]

method FormSelectMultipleSubmit [line 968]

void FormSelectMultipleSubmit(

$fieldname, 
$data, 
$multiple, [
$size = 1], [
$selected = ''], [
$accesskey = ''], [
$onchange = ''])

Same as PN HTMLApi function but adds javascript form submit code to selector

Parameters:

	$fieldname
	$data
	$multiple
	$size
	$selected
	$accesskey
	$onchange

[ Top ]

method getCheckboxes_CategoryField [line 235]

The getCheckboxes_CategoryField(
categoryPath
$categoryPath, [values
$values = array()], [namePrefix
$namePrefix = ''], [excludeList
$excludeList = null], [disabled
$disabled = false])

Return the HTML code for the values in a given category

Tags:

return:

resulting dropdown data

Parameters:

categoryPath	$categoryPath	The identifying category path
values	$values	The values used to populate the defautl states (optional) (default=array())
namePrefix	$namePrefix	The path/object prefix to apply to the field name (optional) (default='')
excludeList	$excludeList	A (string) list of IDs to exclude (optional) (default=null)
disabled	$disabled	whether or not the checkboxes are to be disabled (optional) (default=false)

[ Top ]

method getSelectorData_Language [line 448]

The getSelectorData_Language(
[includeAll
$includeAll = true])

Return the dropdown data for the language selector

Tags:

return:

string representation for the selected value

Parameters:

includeAll

$includeAll

whether or not to include the 'All' choice

[ Top ]

method getSelectorValue_Permission [line 482]

The getSelectorValue_Permission(
value
$value)

Return the localized string for the given value

Tags:

return:

resulting HTML string

Parameters:

value

$value

The currently active/selected value

[ Top ]

method getSelectorValue_YesNo [line 431]

The getSelectorValue_YesNo(
val
$val)

Return the localized string for the specified yes/no value

Tags:

return:

string representation for the selected value

Parameters:

val

$val

The value for which we wish to obtain the string representation

[ Top ]

method getSelector_Categories [line 215]

The getSelector_Categories(
cats
$cats, name
$name, [field
$field = 'id'], [selectedValue
$selectedValue = '0'], defaultValue
$defaultValue, [defaultText
$defaultText = ''], allValue
$allValue, [allText
$allText = ''], [submit
$submit = false], [displayPath
$displayPath = false], [doReplaceRootCat
$doReplaceRootCat = true], [multipleSize
$multipleSize = 1])

Return the HTML selector code for the given category hierarchy, maps to CategoryUtil::getSelector_Categories()

Tags:

return:

HTML selector code for the given category hierarchy

Parameters:

cats	$cats	The category hierarchy to generate a HTML selector for
name	$name	The name of the selector field to generate (optional) (default='category[parent_id]')
field	$field	The field value to return (optional) (default='id')
selectedValue	$selectedValue	The selected category (optional) (default=0)
defaultValue	$defaultValue	The default value to present to the user (optional) (default=0)
defaultText	$defaultText	The default text to present to the user (optional) (default='')
allValue	$allValue	The value to assign for the "All" choice (optional) (default=0)
allText	$allText	The text to display for the "All" choice (optional) (default='')
submit	$submit	whether or not to submit the form upon change (optional) (default=false)
displayPath	$displayPath	If false, the path is simulated, if true, the full path is shown (optional) (default=false)
doReplaceRootCat	$doReplaceRootCat	Whether or not to replace the root category with a localized string (optional) (default=true)
multipleSize	$multipleSize	If > 1, a multiple selector box is built, otherwise a normal/single selector box is build (optional) (default=1)

[ Top ]

method getSelector_Countries [line 934]

The getSelector_Countries(
[name
$name = 'countries'], [selectedValue
$selectedValue = ''], defaultValue
$defaultValue, [defaultText
$defaultText = ''], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the country selector

Tags:

return:

generated HTML for the selector

Parameters:

name	$name	The name of the generated selector (default='countries') (optional)
selectedValue	$selectedValue	The value which is currently selected (default='') (optional)
defaultValue	$defaultValue	The default value to select (default='') (optional)
defaultText	$defaultText	The text for the default value (default='') (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_DatetimeDay [line 746]

The getSelector_DatetimeDay(
selected
$selected, [name
$name = 'day'], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the date day selector

Tags:

return:

generated HTML for the selector

Parameters:

selected	$selected	The value which should be selected (default=0) (optional)
name	$name	The name of the generated selector (default='day') (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_DatetimeHour [line 783]

The getSelector_DatetimeHour(
selected
$selected, [name
$name = 'hour'], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the date hour selector

Tags:

return:

generated HTML for the selector

Parameters:

selected	$selected	The value which should be selected (default=0) (optional)
name	$name	The name of the generated selector (default='hour') (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_DatetimeMinute [line 820]

The getSelector_DatetimeMinute(
selected
$selected, [name
$name = 'minute'], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the date minute selector

Tags:

return:

generated HTML for the selector

Parameters:

selected	$selected	The value which should be selected (default=0) (optional)
name	$name	The name of the generated selector (default='minute') (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_DatetimeMonth [line 857]

The getSelector_DatetimeMonth(
selected
$selected, [name
$name = 'month'], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the date month selector

Tags:

return:

generated HTML for the selector

Parameters:

selected	$selected	The value which should be selected (default=0) (optional)
name	$name	The name of the generated selector (default='month') (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_DatetimeYear [line 896]

The getSelector_DatetimeYear(
[selected
$selected = 2007], [name
$name = 'year'], [first
$first = 2003], [last
$last = 2008], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the HTML for the date year selector

Tags:

return:

generated HTML for the selector

Parameters:

selected	$selected	The value which should be selected (default=2003) (optional)
name	$name	The name of the generated selector (default='year') (optional)
first	$first	The start year for the selector (default=2003) (optional)
last	$last	The name of the generated selector (default=2007) (optional)
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_FieldArray [line 142]

void getSelector_FieldArray(

$modname, 
$tablekey, 
$name, [
$field = 'id'], [
$where = ''], [
$sort = ''], [
$selectedValue = ''], 
$defaultValue, [
$defaultText = ''], 
$allValue, [
$allText = ''], [
$assocKey = ''], [
$distinct = false], [
$submit = true], [
$disabled = false], 
$truncate, [
$multipleSize = 1])

Parameters:

	$modname
	$tablekey
	$name
	$field
	$where
	$sort
	$selectedValue
	$defaultValue
	$defaultText
	$allValue
	$allText
	$assocKey
	$distinct
	$submit
	$disabled
	$truncate
	$multipleSize

[ Top ]

method getSelector_ModuleTables [line 275]

void getSelector_ModuleTables(

$modname, 
$name, [
$selectedValue = ''], 
$defaultValue, [
$defaultText = ''], [
$submit = false], [
$remove = ''], [
$disabled = false], 
$nStripChars, [
$multipleSize = 1])

Parameters:

	$modname
	$name
	$selectedValue
	$defaultValue
	$defaultText
	$submit
	$remove
	$disabled
	$nStripChars
	$multipleSize

[ Top ]

method getSelector_ObjectArray [line 78]

void getSelector_ObjectArray(

$modname, 
$objectType, 
$name, [
$field = 'id'], [
$displayField = 'name'], [
$where = ''], [
$sort = ''], [
$selectedValue = ''], 
$defaultValue, [
$defaultText = ''], 
$allValue, [
$allText = ''], [
$displayField2 = null], [
$submit = true], [
$disabled = false], [
$fieldSeparator = ', '], [
$multipleSize = 1])

Parameters:

	$modname
	$objectType
	$name
	$field
	$displayField
	$where
	$sort
	$selectedValue
	$defaultValue
	$defaultText
	$allValue
	$allText
	$displayField2
	$submit
	$disabled
	$fieldSeparator
	$multipleSize

[ Top ]

method getSelector_Permission [line 502]

The getSelector_Permission(
[name
$name = 'permission'], [selected
$selected = 'U'])

Return the HTML code for the Permission dropdown

Tags:

return:

resulting HTML string

Parameters:

name	$name	The name of the generated selector (optional) (default='permission')
selected	$selected	The value which should be selected (optional) (default=2)

[ Top ]

method getSelector_PermissionLevel [line 540]

The getSelector_PermissionLevel(
[name
$name = 'permission'], [selected
$selected = '0'])

Return the HTML code for the Permission Level dropdown

Tags:

return:

resulting HTML string

Parameters:

name	$name	The name of the generated selector (optional) (default='permission')
selected	$selected	The value which should be selected (optional) (default=2)

[ Top ]

method getSelector_PNGroup [line 577]

The getSelector_PNGroup(
[name
$name = 'groupid'], selectedValue
$selectedValue, defaultValue
$defaultValue, [defaultText
$defaultText = ''], allValue
$allValue, [allText
$allText = ''], [excludeList
$excludeList = ''], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the html for the PN user group selector

Tags:

return:

html for the user group selector

Parameters:

name	$name	The selector name
selectedValue	$selectedValue	The currently selected value of the selector (optional) (default=0)
defaultValue	$defaultValue	The default value of the selector (optional) (default=0)
defaultText	$defaultText	The text of the default value (optional) (default='')
allValue	$allValue	The value to assign for the "All" choice (optional) (default=0)
allText	$allText	The text to display for the "All" choice (optional) (default='')
excludeList	$excludeList	A (string) list of IDs to exclude (optional) (default=null)
submit	$submit	Whether or not to auto-submit the selector (optional) (default=false)
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_PNModule [line 697]

The getSelector_PNModule(
[name
$name = 'moduleName'], selectedValue
$selectedValue, defaultValue
$defaultValue, [defaultText
$defaultText = ''], allValue
$allValue, [allText
$allText = ''], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return the html for the PNModule selector

Tags:

return:

string for the user group selector

Parameters:

name	$name	The selector name
selectedValue	$selectedValue	The currently selected value of the selector (optional) (default=0)
defaultValue	$defaultValue	The default value of the selector (optional) (default=0)
defaultText	$defaultText	The text of the default value (optional) (default='')
allValue	$allValue	The value to assign the "All" choice (optional) (default=0)
allText	$allText	The text to display for the "All" choice (optional) (default='')
submit	$submit	Whether or not to auto-submit the selector
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_PNUser [line 634]

The getSelector_PNUser(
[name
$name = 'userid'], [gid
$gid = null], selectedValue
$selectedValue, defaultValue
$defaultValue, [defaultText
$defaultText = ''], allValue
$allValue, [allText
$allText = ''], [excludeList
$excludeList = ''], [submit
$submit = false], [disabled
$disabled = false], [multipleSize
$multipleSize = 1])

Return a PN array strcuture for the PN user dropdown box

Tags:

return:

string for the user group selector

Parameters:

name	$name	The selector name
gid	$gid	The group ID to get users for (optional) (default=null)
selectedValue	$selectedValue	The currently selected value of the selector (optional) (default=0)
defaultValue	$defaultValue	The default value of the selector (optional) (default=0)
defaultText	$defaultText	The text of the default value (optional) (default='')
allValue	$allValue	The value to assign for the "All" choice (optional) (default='')
allText	$allText	The text to display for the "All" choice (optional) (default='')
excludeList	$excludeList	A (string) list of IDs to exclude (optional) (default=null)
submit	$submit	Whether or not to auto-submit the selector (optional) (default=false)
disabled	$disabled	Whether or not to disable selector (optional) (default=false)
multipleSize	$multipleSize	The size to use for a multiple selector, 1 produces a normal/single selector (optional (default=1)

[ Top ]

method getSelector_TableFields [line 334]

void getSelector_TableFields(

$modname, 
$tablename, 
$name, [
$selectedValue = ''], 
$defaultValue, [
$defaultText = ''], [
$submit = false], [
$showSystemColumns = false], [
$disabled = false], [
$multipleSize = 1])

Parameters:

	$modname
	$tablename
	$name
	$selectedValue
	$defaultValue
	$defaultText
	$submit
	$showSystemColumns
	$disabled
	$multipleSize

[ Top ]

method getSelector_YesNo [line 401]

The getSelector_YesNo(
[selected
$selected = '1'], [name
$name = ''])

Return the HTML code for the Yes/No dropdown

Tags:

return:

resulting HTML string

Parameters:

selected	$selected	The value which should be selected (default=1) (optional)
name	$name	The name of the generated selector (optional)

[ Top ]

Docs For Class HtmlUtil

Class: HtmlUtil

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Class Methods

method buildCalendarInputBox [line 32]

Tags:

Parameters:

method FormSelectMultipleSubmit [line 968]

Parameters:

method getCheckboxes_CategoryField [line 235]

Tags:

Parameters:

method getSelectorData_Language [line 448]

Tags:

Parameters:

method getSelectorValue_Permission [line 482]

Tags:

Parameters:

method getSelectorValue_YesNo [line 431]

Tags:

Parameters:

method getSelector_Categories [line 215]

Tags:

Parameters:

method getSelector_Countries [line 934]

Tags:

Parameters:

method getSelector_DatetimeDay [line 746]

Tags:

Parameters:

method getSelector_DatetimeHour [line 783]

Tags:

Parameters:

method getSelector_DatetimeMinute [line 820]

Tags:

Parameters:

method getSelector_DatetimeMonth [line 857]

Tags:

Parameters:

method getSelector_DatetimeYear [line 896]

Tags:

Parameters:

method getSelector_FieldArray [line 142]

Parameters:

method getSelector_ModuleTables [line 275]

Parameters:

method getSelector_ObjectArray [line 78]

Parameters:

method getSelector_Permission [line 502]

Tags:

Parameters:

method getSelector_PermissionLevel [line 540]

Tags:

Parameters:

method getSelector_PNGroup [line 577]

Tags:

Parameters:

method getSelector_PNModule [line 697]

Tags:

Parameters:

method getSelector_PNUser [line 634]

Tags:

Parameters:

method getSelector_TableFields [line 334]

Parameters:

method getSelector_YesNo [line 401]

Tags:

Parameters:

Packages:

Files:

Classes: