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 HtmlFormInstallation

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

Create the html script for an installation / update form

This class will create the complete html for a installation / update page. First you set the modus (update or installation) and then you can optional add custom text to the page. The main configuration part will be the form. You can use the complete methods of the Form class.


Class: HtmlFormInstallation
Code:

// create a simple installation form with a free text, a text field and a submit button $form = new HtmlFormInstallation('installation-form', 'next_html_page.php'); $form->setText('This is an example.'); $form->addSubmitButton('next_page', $gL10n->get('SYS_NEXT'), array('icon' => 'layout/forward.png', 'type' => 'button')); $form->show();


Endcode
Par: Examples
Located at htmlforminstallation.php

Methods summary

public
# __construct( string $id, string $action )

Constructor creates the form element

Constructor creates the form element

Parameters

$id
Id of the form
$action
Optional action attribute of the form

Overrides

HtmlForm::__construct
public
# setFormDescription( string $description, string $title = '' )

If the method is called then a text with an optional title will be displayed after the headline before the form will be displayed.

If the method is called then a text with an optional title will be displayed after the headline before the form will be displayed.

Parameters

$description
The (html) text that should be shown.
$title

The headline of the description. If set than this will be displayed before the description as h2

public
# setInstallationModus( )

Set the form in the installation modus. Therefore headline and title will be changed. This is the default modus and will be set automatically if not modus is set in the calling code.

Set the form in the installation modus. Therefore headline and title will be changed. This is the default modus and will be set automatically if not modus is set in the calling code.

public
# setUpdateModus( )

Set the form in the update modus. Therefore headline and title will be changed.

Set the form in the update modus. Therefore headline and title will be changed.

public string
# show( boolean $directOutput = true )

This method will create the whole html installation/update code. It will show the headline, text and the configured form. If no modus is set the installation modus will be set here.

This method will create the whole html installation/update code. It will show the headline, text and the configured form. If no modus is set the installation modus will be set here.

Parameters

$directOutput
This is only used for compatibility to show method of parent class HtmlForm

Returns

string
Return the html code of the form.

Overrides

HtmlForm::show

Methods inherited from HtmlForm

addButton(), addCaptcha(), addCheckbox(), addCustomContent(), addDescription(), addEditor(), addFileUpload(), addInput(), addLine(), addMultilineTextInput(), addRadioButton(), addSelectBox(), addSelectBoxForCategories(), addSelectBoxFromSql(), addSelectBoxFromXml(), addStaticControl(), addSubmitButton(), closeButtonGroup(), closeControlStructure(), closeGroupBox(), getHelpTextIcon(), openButtonGroup(), openControlStructure(), openGroupBox()

Methods inherited from HtmlFormBasic

addFieldSet(), addLabel(), addLegend(), addOption(), addOptionGroup(), addSelect(), addSimpleButton(), addSimpleInput(), addTextArea(), closeFieldSet(), closeOptionGroup(), closeSelect(), getHtmlForm()

Methods inherited from HtmlElement

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

Properties summary

private $descriptionTitle
#
private $descriptionText
#
private $headline
#
private $title
#

Properties inherited from HtmlForm

$buttonGroupOpen, $countElements, $datepickerInitialized, $flagFieldListOpen, $flagRequiredFields, $htmlPage, $id, $showRequiredFields, $type

Properties inherited from HtmlElement

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

Admidio API API documentation generated by ApiGen