SourceForge.net LogoPHPGallue
[ class tree: setup ] [ index: setup ] [ all elements ]

Class: SETUPStep

Source Location: /setup/admin/setup.php

Class Overview


A step during setup.


Author(s):

Variables

Methods


Child classes:

SETUPStepAuth
A step during setup.
SETUPStepConfig
A step during setup.
SETUPStepFiles
A step during setup.
SETUPStepDatabase
A step during setup.
SETUPStepInit
A step during setup.
SETUPStepUser
A step during setup.
SETUPStepLocations
A step during setup.
SETUPStepURL
A step during setup.
SETUPStepFinish
A step during setup.

Class Details

[line 498]
A step during setup.



Tags:

abstract:  


[ Top ]


Class Variables

$_executed =  false

[line 508]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_inputs = array()

[line 502]



Tags:

var:  of SETUPInput
access:  protected

Type:   array


[ Top ]

$_msg =  ''

[line 509]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_name =

[line 506]



Tags:

access:  protected

Type:   string


[ Top ]

$_title =

[line 507]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 515]


method addInput [line 566]

void addInput( SETUPInput $input)



Parameters:

SETUPInput   $input  

[ Top ]

method check [line 661]


method displayCLI [line 635]

void displayCLI( )



Overridden in child classes as:

SETUPStepAuth::displayCLI()
SETUPStepLocations::displayCLI()

[ Top ]

method displayDOM [line 593]

void displayDOM( SETUPGlobalVars $globalvars, $elem)



Overridden in child classes as:

SETUPStepAuth::displayDOM()
SETUPStepDatabase::displayDOM()
SETUPStepUser::displayDOM()
SETUPStepLocations::displayDOM()
SETUPStepFinish::displayDOM()

Parameters:

SETUPGlobalVars   $globalvars  
DOMElement   $elem  

[ Top ]

method execute [line 670]


method finalize [line 586]

void finalize( )



Overridden in child classes as:

SETUPStepConfig::finalize()
SETUPStepInit::finalize()

[ Top ]

method isCompleted [line 678]

void isCompleted( )



Overridden in child classes as:

SETUPStepAuth::isCompleted()
SETUPStepFinish::isCompleted()

[ Top ]

method prepare [line 579]


method readDOM [line 652]

void readDOM( SETUPGlobalVars $globalvars)



Parameters:

SETUPGlobalVars   $globalvars  

[ Top ]

method recoverSession [line 528]

void recoverSession( )

Recovers object references.

I'm not sure if object references survive if you store them in a session. This method recovers the references from the $_SESSION autoglobal.




Overridden in child classes as:

SETUPStepConfig::recoverSession()
SETUPStepInit::recoverSession()

[ Top ]

method reset [line 695]

void reset( )



Overridden in child classes as:

SETUPStepInit::reset()
SETUPStepUser::reset()

[ Top ]

method setMsg [line 690]

void setMsg( $msg)



Parameters:

   $msg  

[ Top ]

method __get [line 545]

mixed __get( string $value)

"Magic" method to read properties.



Parameters:

string   $value   The propertie's name: 'name', 'page', 'inputs' or the name of an input field.

[ Top ]


Documentation generated on Wed, 16 Aug 2006 15:36:42 +0200 by phpDocumentor 1.3.0RC6