Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

  • AutoLogin
  • Component
  • ComponentUpdate
  • ConditionParser
  • Database
  • DateTimeExtended
  • Email
  • Folder
  • FormValidation
  • FunctionClass
  • Htaccess
  • HtmlDiv
  • HtmlElement
  • HtmlForm
  • HtmlFormBasic
  • HtmlFormInstallation
  • HtmlList
  • HtmlNavbar
  • HtmlPage
  • HtmlTable
  • HtmlTableBasic
  • Image
  • Inventory
  • InventoryFields
  • Language
  • LanguageData
  • ListConfiguration
  • Menu
  • Message
  • ModuleAnnouncements
  • ModuleDates
  • ModuleLists
  • ModuleMenu
  • ModuleMessages
  • Modules
  • ModuleWeblinks
  • MyFiles
  • Navigation
  • ntlm_sasl_client_class
  • Organization
  • Participants
  • PasswordHash
  • PasswordHashing
  • ProfileFields
  • RoleDependency
  • RolesRights
  • RSSfeed
  • Session
  • SystemMail
  • TableAccess
  • TableAnnouncement
  • TableCategory
  • TableDate
  • TableFile
  • TableFolder
  • TableGuestbook
  • TableGuestbookComment
  • TableInventory
  • TableInventoryField
  • TableLists
  • TableMembers
  • TableMessage
  • TablePhotos
  • TableRoles
  • TableRooms
  • TableText
  • TableUserField
  • TableUsers
  • TableWeblink
  • UploadHandlerDownload
  • UploadHandlerPhoto
  • User
  • UserRegistration

Exceptions

  • AdmException
  • WavFileException
  • WavFormatException

Functions

  • admFuncAutoload
  • admFuncGeneratePagination
  • admFuncGetBytesFromSize
  • admFuncGetDirectoryEntries
  • admFuncMaxUploadSize
  • admFuncProcessableImageSize
  • admFuncShowCreateChangeInfoById
  • admFuncShowCreateChangeInfoByName
  • admFuncVariableIsValid
  • admReadTemplateFile
  • admStrIsValidFileName
  • admStrStripTagsSpecial
  • admStrToLower
  • admStrToUpper
  • bzip2Version
  • checkDatabaseVersion
  • checkPhpVersion
  • EmailAttachment
  • FileSizeNiceDisplay
  • FormattedTimeRemaining
  • FunctionIsDisabled
  • getFormerRolesFromDatabase
  • getFutureRolesFromDatabase
  • getmicrotime
  • getRoleMemberships
  • getRolesFromDatabase
  • gzipVersion
  • hasRole
  • hl_attrval
  • hl_bal
  • hl_cmtcd
  • hl_ent
  • hl_prot
  • hl_regex
  • hl_spec
  • hl_tag
  • hl_tag2
  • hl_tidy
  • hl_version
  • htmLawed
  • HTMLFilter
  • isGroupLeader
  • isMember
  • kses
  • kses_hook
  • MySQLdumpVersion
  • OutputInformation
  • SafeExec
  • showNotice
  • strAddSlashesDeep
  • strNextLetter
  • strStripSlashesDeep
  • strStripTags
  • strValidCharacters
  • tln_body2div
  • tln_casenormalize
  • tln_deent
  • tln_defang
  • tln_findnxreg
  • tln_findnxstr
  • tln_fixatts
  • tln_fixstyle
  • tln_fixurl
  • tln_getnxtag
  • tln_sanitize
  • tln_skipspace
  • tln_tagprint
  • tln_unspace
  • version_compare_replacement
  • version_compare_replacement_sub

Class HtmlList

HtmlElement
Extended by HtmlList
Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Brief:

Create html lists

This class creates html list elements. Create a list object for ordered, unordered or data list an add the list items. The class supports data lists and lists and combination of nested lists and data lists. The parsed list object is returned as string.


Class: HtmlList
Code:

// Get instance $list = new HtmlList('dl', 'id_dl', 'class'); // Parameter for list type, id and class are optional ( Default list type = ul ) // In html strict a data list is determined to be nested in a list element if used in an ordered/unordered list $list->addListItem(); // add 2 list items term and description as string. Arrays are not supported! $list->addDataListItems('term_1', 'Listdata_1'); $list->addDataListItems('term_2', 'Listdata_2'); // get parsed datalist as string echo $list->getHtmlList();


Code:

// Get Instance $list = new HtmlList('ol', 'id_ol', 'class'); // Set type Attribute $list->addAttribute('type', 'square'); // Define a list element with ID "Item_0" and data "Listdata_1" as string $list->addListItem('Item_0', 'Listdata_1'); // Next list elements: Defining a term, a datalist is automatically nested in the list element $list->addListItem('Item_1', 'Listdata_2', 'term_2'); $list->addListItem('Item_2', 'Listdata_3', 'term_3'); $list->addListItem('Item_3', 'Listdata_4', 'term_4'); // Also manually configuration is possible // Define list element "li" with attribute ID = Item_5 $list->addListItem('Item_5'); // Define datalist in link element $list->addDataList(); // Define several term and description of the data list $list->addDataListItems('term_5', 'Listdata_5'); list->addDataListItems('term_5.1', 'Listdata_5.1'); list->addDataListItems('term_5.2', 'Listdata_5.2'); // get parsed datalist as string echo $list->getHtmlList();


Endcode
Endcode
Par: Example 1: Creating datalist
Par: Example 2: Creating ordered list
Located at htmllist.php

Methods summary

public
# __construct( string $list = 'ul', string $id = null, string $class = null )

Constructor creates the element

Constructor creates the element

Parameters

$list
List element ( ul/ol Default: ul)
$id
Id of the list
$class
Class name of the list

Overrides

HtmlElement::__construct
public
# addDataList( string $id = null, string $term = null, string $description = null )

Add datalist (dl).

Add datalist (dl).

Parameters

$id
id Attribute
$term
term as string for datalist
$description
description as string for data description
public
# addDataListItems( string $term, string $description )

Add term and description to datalist (dl).

Add term and description to datalist (dl).

Parameters

$term
Term as string for datalist
$description
Description as string for data
public
# addListItem( string $id = null, string $data = null, string $term = null )

Add list item (li).

Add list item (li).

Parameters

$id
id Attribute
$data
element data
$term
optional term as string for nested datalist
public string
# getHtmlList( )

Get the parsed html list

Get the parsed html list

Returns

string
Returns the validated html list as string

Methods inherited from HtmlElement

addAttribute(), addData(), addElement(), addHtml(), addParentElement(), closeParentElement(), getHtmlElement(), setAttributesFromArray()

Properties summary

Properties inherited from HtmlElement

$arrParentElements, $currentElement, $currentElementAttributes, $currentElementDataWritten, $htmlString, $mainElement, $mainElementAttributes, $mainElementWritten, $nesting, $parentFlag

Admidio API API documentation generated by ApiGen