Class FormHandler

ModuleBase
   |
   +----FormHandler

Located in File: Program_Root/formhandler.inc.php


Main execution engine
 This module creates the different modules that need to be used. It
 contains the text to be used in the mail, display, etc. It distributes
 the variables entered in the form and it creates the runlevels and runs
 the different modules.
 

Class Variable Summary
$name
Default Value: ->"FormHandler"<-
$id
Default Value: ->FORMHANDLER<-
$opties
Default Value: ->array()<-
$vars
Default Value: ->array()<-
$content
Default Value: ->array()<-
$sorted_modules
Default Value: ->array()<-
$config
Default Value: -><-
$translator
Default Value: -><-

Method Summary
FormHandler ( $vars, $cookies )
Constructor
execlevel ( )
Return execlevel
translate ( $message, [$var1 = ""], [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""], [$var6 = ""], [$var7 = ""], [$var8 = ""], [$var9 = ""], [$var10 = ""], [$var11 = ""], [$var12 = ""] )
Translate
error ( $name, $level, $var1, [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""] )
exec_module ( $module, $action )
Exec module
runlevel ( $levelgroup )
Runlevel
config ( $option )
Config
addto_content ( $name, $content )
set_html ( [$html = true], [$type = CONTENT] )
convert_content ( $vars, [$type = CONTENT] )
set_content ( $new_content, [$type = CONTENT] )
addto_content ( $add_content, [$type = CONTENT] )
insert_content ( $ins_content, [$type = CONTENT] )
insert_content ( $ins_content )
get_content ( [$type = CONTENT], [$final = false], [$vars = ""] )
set_header ( $header, [$type = CONTENT] )
set_footer ( $footer, [$type = CONTENT] )
set_title ( $title, [$type = CONTENT] )
content ( )
isset_content ( [$type = CONTENT] )
get_vars ( [$type = VARS] )
set_vars ( $vars )
addto_vars ( $vars, [$replace = false] )
change_vars ( $name, $var_name, [$var_value = ""] )
del_vars ( $name, $var_name )
get_vars ( )
set_default_vars ( $config )
addto_vars ( $name, $value )
get_showvars ( )
del_var ( $key )
cookies ( )

Variable Detail

$name



$id



$opties



$vars



$content



$sorted_modules



$config



$translator




Function Detail

FormHandler

FormHandler ( $vars, $cookies )

Constructor

Function Parameters:
Function Info:

execlevel

execlevel ( )

Return execlevel
 For compatibility with other modules
 
Function Parameters:
Function Info:
Return - zero value

translate

translate ( $message, [$var1 = ""], [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""], [$var6 = ""], [$var7 = ""], [$var8 = ""], [$var9 = ""], [$var10 = ""], [$var11 = ""], [$var12 = ""] )

Translate
 Translation function
 
Function Parameters:
- $message: message
- $varx: variables that need to be substituted
Function Info:
Return - translated message

error

error ( $name, $level, $var1, [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""] )


Function Parameters:
Function Info:

exec_module

exec_module ( $module, $action )

Exec module
 Execute the modules in this action-step
 
Function Parameters:
- $module: the module that is executed
- $action: the action-step
Function Info:
Return - true if module is executed

runlevel

runlevel ( $levelgroup )

Runlevel
 Get the modules from one runlevel and execute them
 
Function Parameters:
- $levelgroep: runlevel
Function Info:

config

config ( $option )

Config
 Method to retrieve config-information
 
Function Parameters:
- $option: the optionname
Function Info:
Return - the optionvalue

addto_content

addto_content ( $name, $content )


Function Parameters:
Function Info:

set_html

set_html ( [$html = true], [$type = CONTENT] )


Function Parameters:
Function Info:

convert_content

convert_content ( $vars, [$type = CONTENT] )


Function Parameters:
Function Info:

set_content

set_content ( $new_content, [$type = CONTENT] )


Function Parameters:
Function Info:

addto_content

addto_content ( $add_content, [$type = CONTENT] )


Function Parameters:
Function Info:

insert_content

insert_content ( $ins_content, [$type = CONTENT] )


Function Parameters:
Function Info:

insert_content

insert_content ( $ins_content )


Function Parameters:
Function Info:

get_content

get_content ( [$type = CONTENT], [$final = false], [$vars = ""] )


Function Parameters:
Function Info:

set_header

set_header ( $header, [$type = CONTENT] )


Function Parameters:
Function Info:

set_footer

set_footer ( $footer, [$type = CONTENT] )


Function Parameters:
Function Info:

set_title

set_title ( $title, [$type = CONTENT] )


Function Parameters:
Function Info:

content

content ( )


Function Parameters:
Function Info:

isset_content

isset_content ( [$type = CONTENT] )


Function Parameters:
Function Info:

get_vars

get_vars ( [$type = VARS] )


Function Parameters:
Function Info:

set_vars

set_vars ( $vars )


Function Parameters:
Function Info:

addto_vars

addto_vars ( $vars, [$replace = false] )


Function Parameters:
Function Info:

change_vars

change_vars ( $name, $var_name, [$var_value = ""] )


Function Parameters:
Function Info:

del_vars

del_vars ( $name, $var_name )


Function Parameters:
Function Info:

get_vars

get_vars ( )


Function Parameters:
Function Info:

set_default_vars

set_default_vars ( $config )


Function Parameters:
Function Info:

addto_vars

addto_vars ( $name, $value )


Function Parameters:
Function Info:

get_showvars

get_showvars ( )


Function Parameters:
Function Info:

del_var

del_var ( $key )


Function Parameters:
Function Info:

cookies

cookies ( )


Function Parameters:
Function Info: