Packageindex Classtrees Elementlist

File: /home/jerry/www/vb3/impex/ImpExDisplay.php
vB3 ImpEx Import system - ImpEx

ImpExDisplay

ImpExFunction
   |
  +-- ImpExDisplay

Display handeling, currently HTML output.

 

private class ImpExDisplay extends ImpExFunction

Display handeling, currently HTML output.

AuthorsJerry Hutchings <jerry.hutchings@vbulletin.com>
Version$Revision: 1.24 $
Copyrighthttp://www.vbulletin.com/license.html

 
Direct known subclasses: ImpExDisplayWrapper

Methods inherited from ImpExFunction

impexfunction, option2bin, over_ride_test, iif, unhtmlspecialchars, vb_parse_url, vb_file_get_contents, return_style_array, html_2_bb, parse_smilie_callback, all_your_posts_are_belong_to_us

Public Method Summary

void

ImpExDisplay()

Warning: documentation is missing.

Private Method Summary

boolean

update_html(string $html)

Retrives the values needed to define a ImpExData object
boolean

update_basic(string $name, string $status)

Retrives the values needed to define a ImpExData object
string

make_input_code(string $title, string $name, [ string $value, integer $htmlise, integer $size ])

HTML Page code - table text input
string

make_table_header(string $title)

HTML Page code - table header
void

get_row_bg()

TODO - remove this to a local variable
string

do_form_header(string $phpscript, string $action, [ integer $uploadform, integer $addtable ], string $name)

HTML Page code - form header
string

do_form_footer([ string $submitname, string $resetname, integer $colspan, string $goback ])

HTML Page code - form footer
string

make_description(string $text)

HTML Page code - form footer
string

make_hidden_code(string $name, [ string $value, integer $htmlise ])

HTML Page code - form footer
string

make_yesno_code(string $title, string $name, [ integer $value ])

HTML Page code - yes no
string

display_modules(object sessionobject &$sessionobject)

HTML Page code - displays table with the states of the current modules and buttons depending on
string

module_ver(int $file, $num, $Db_object)

Class version - Finds a module version by includeing the file and creating one then accessing the
string

choose_system(object sessionobject &$sessionobject)

Choose system - Lists the aviable systems to be imported from depending on what is in systems/
string

make_select(string $select_array, $select_name)

Outputs the content of the headder before index.php is called, ensures that
string

display_now(string $screentext)

Outputs the content of the headder before index.php is called, ensures that
string

page_header()

HTML Page code - returns the html page header code depending on the internal flag autosubmit
string

page_footer()

HTML Page code - returns the html page footer code
string

display(object sessionobject &$sessionobject)

Main display - returns the current HTML stored in the object
mixed

module_finished(string $modulestring, int $seconds, $successful, $failed)

Return the display string for the module complete
void

print_redirect( $gotopage, float $timeout)

Warning: documentation is missing.
void

exec_refresh()

Warning: documentation is missing.

Fields inherited from ImpExFunction

$_smilies

Private Field Summary

string

$_version

Class version
string

$_screenstring

Store for display HTML
array

$_screenbasic

Internal flags for the display functions

Included files Summary, Type: require_once

$modulepath Warning: documentation is missing.

Public Method Details

ImpExDisplay

public void ImpExDisplay( )

 

Warning: documentation is missing.

Returns void


Private Method Details

update_html

private boolean update_html( string $html )

  Retrives the values needed to define a ImpExData object

Parameter
string $html
An accessor that appends a string (HTML) onto the pageHTML
Returns boolean


update_basic

private boolean update_basic( string $name, string $status )

  Retrives the values needed to define a ImpExData object

Parameter
string $name
The name of the basic value or flag to update
string $status
The value to update it with
Returns boolean


make_input_code

private string make_input_code( string $title, string $name, [ string $value, integer $htmlise, integer $size ] )

  HTML Page code - table text input

Parameter
string $title
Input title
string $name
HTML element name
string $value = >>''<<
The default value
integer $htmlise = >>1<<
Calls htmlspecialchars on the value
integer $size = >>35<<
The size of the input
Returns string

mixed The formed HTML


make_table_header

private string make_table_header( string $title )

  HTML Page code - table header

Parameter
string $title
Table title
Returns string

mixed The formed HTML


get_row_bg

private void get_row_bg( )

  TODO - remove this to a local variable

Returns void


do_form_header

private string do_form_header( string $phpscript, string $action, [ integer $uploadform, integer $addtable ], string $name )

  HTML Page code - form header

Parameter
string $phpscript
The target of the form
string $action
The action value
integer $uploadform = >>0<<
0|1 whether to use = ENCTYPE=multipart/form-data
integer $addtable = >>1<<
0|1 whether to add the beginings of a table after the <form tag
string $name
Warning: documentation is missing.
Returns string

mixed The formed HTML


do_form_footer

private string do_form_footer( [ string $submitname, string $resetname, integer $colspan, string $goback ] )

  HTML Page code - form footer

Parameter
string $submitname = >>'Submit'<<
The submit name
string $resetname = >>'Reset'<<
The reset name
integer $colspan = >>2<<
The collum span width
string $goback = >>''<<
Text for the back button ( onclick="history.back(1)" )
Returns string

mixed The formed HTML


make_description

private string make_description( string $text )

  HTML Page code - form footer

Parameter
string $text
The submit name
Returns string

mixed The formed HTML


make_hidden_code

private string make_hidden_code( string $name, [ string $value, integer $htmlise ] )

  HTML Page code - form footer

Parameter
string $name
The hidden value name
string $value = >>''<<
The value
integer $htmlise = >>1<<
1|0 htmlspecialchars($value)
Returns string

mixed The formed HTML


make_yesno_code

private string make_yesno_code( string $title, string $name, [ integer $value ] )

  HTML Page code - yes no

Parameter
string $title
The title of the radio group
string $name
The name of the value
integer $value = >>1<<
1|0 The inital setting of the yes / no
Returns string

mixed The formed HTML


display_modules

private string display_modules( object sessionobject &$sessionobject )

  HTML Page code - displays table with the states of the current modules and buttons depending on
the state of the object (not run, running, run). If a object is running no like code is generated

Parameter
object sessionobject &$sessionobject
The current session object
Returns string

mixed The formed HTML


module_ver

private string module_ver( int $file, $num, $Db_object )

  Class version - Finds a module version by includeing the file and creating one then accessing the
local version number (need to be updated to use an accessor)

Parameter
int $file
A three digit number corrisponding to the module number that you are quering
$num
Warning: documentation is missing.
$Db_object
Warning: documentation is missing.
Returns string

|boolean mixed The formed HTML


choose_system

private string choose_system( object sessionobject &$sessionobject )

  Choose system - Lists the aviable systems to be imported from depending on what is in systems/
local version number (need to be updated to use an accessor)

Parameter
object sessionobject &$sessionobject
The current session object
Returns string

mixed The formed HTML


make_select

private string make_select( string $select_array, $select_name )

  Outputs the content of the headder before index.php is called, ensures that
the <html <head <body tags are out putted correctly and not disrupted by an echo() etcOutput is augmented by object state and internal flags

Parameter
string $select_array
The output to be displayed, usally the $_screenstring.
$select_name
Warning: documentation is missing.
Returns string

mixed The formed HTML


display_now

private string display_now( string $screentext )

  Outputs the content of the headder before index.php is called, ensures that
the <html <head <body tags are out putted correctly and not disrupted by an echo() etcOutput is augmented by object state and internal flags

Parameter
string $screentext
The output to be displayed, usally the $_screenstring.
Returns string

mixed The formed HTML


page_header

private string page_header( )

  HTML Page code - returns the html page header code depending on the internal flag autosubmit

Returns string

mixed The formed HTML


page_footer

private string page_footer( )

  HTML Page code - returns the html page footer code

Returns string

mixed The formed HTML


display

private string display( object sessionobject &$sessionobject )

  Main display - returns the current HTML stored in the object

Parameter
object sessionobject &$sessionobject
The current session object
Returns string

mixed The formed HTML


module_finished

private mixed module_finished( string $modulestring, int $seconds, $successful, $failed )

  Return the display string for the module complete

Parameter
string $modulestring
The name of the module
int $seconds
The seconds taken to complete
$successful
Warning: documentation is missing.
$failed
Warning: documentation is missing.
Returns mixed

string|NULL


print_redirect

private void print_redirect( $gotopage, float $timeout )

 

Warning: documentation is missing.

Parameter
$gotopage
Warning: documentation is missing.
float $timeout
Warning: documentation is missing.
Returns void


exec_refresh

private void exec_refresh( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$_version

private string $_version

>>'0.0.1'<<

Class version
This will allow the checking for interoprability of class version in diffrentversions of ImpEx


$_screenstring

private string $_screenstring

>>''<<

Store for display HTML
Hold all the HTML during the life of the object till display is called


$_screenbasic

private array $_screenbasic

>>array( 'title' => 'Import / Export', 'pageHTML' => '', 'showwarning' => 'TRUE', 'warning' => '', 'system' => 'NONE', 'choosesystem' => 'FALSE', 'displaylinks' => 'TRUE', 'autosubmit' => '0', 'donehead' => 'FALSE', 'displaymodules' => 'TRUE' )<<

Internal flags for the display functions
Various state flags for the display


Included Files, Type: require_once

$modulepath

require_once( $modulepath )




Packageindex Classtrees Elementlist
PHPDoc 1.0beta