OxidEsales\EshopCommunity\Setup\Setup Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Setup\Setup:

Collaboration diagram for OxidEsales\EshopCommunity\Setup\Setup:

Public Member Functions
	getTitle ()
	setTitle ($sTitle)
	getMessage ()
	setMessage ($sMsg)
	getCurrentStep ()
	getNextStep ()
	setNextStep ($iStep)
	alreadySetUp ()
	deleteSetupDirectory ()
	getShopId ()
	getSteps ()
	getStep ($sStepId)
	getModuleClass ($iModuleState)
Public Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core
	getInstance ($sInstanceName)
	__call ($sMethod, $aArgs)

Protected Attributes
	$_sTitle = null
	$_sMessage = null
	$_iCurrStep = null
	$_iNextStep = null
	$_aSetupSteps

Additional Inherited Members
Protected Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core
	getClass ($sInstanceName)
	getSetupInstance ()
	getLanguageInstance ()
	getUtilitiesInstance ()
	getSessionInstance ()
	getDatabaseInstance ()
	userDecidedOverwriteDB ()
	userDecidedIgnoreDBWarning ()
Static Protected Attributes inherited from OxidEsales\EshopCommunity\Setup\Core
static	$_aInstances = []

Detailed Description

The setup manager class.

Member Function Documentation

alreadySetUp()

OxidEsales\EshopCommunity\Setup\Setup::alreadySetUp

(

)

Checks if config file is alleady filled with data

Returns

bool

deleteSetupDirectory()

OxidEsales\EshopCommunity\Setup\Setup::deleteSetupDirectory

(

)

Decides if leave or delete Setup directory dependent from configuration.

Returns

bool

getCurrentStep()

OxidEsales\EshopCommunity\Setup\Setup::getCurrentStep

(

)

Returns current setup step index

Returns

int

getMessage()

OxidEsales\EshopCommunity\Setup\Setup::getMessage

(

)

Returns installation process status message

Returns

string

getModuleClass()

OxidEsales\EshopCommunity\Setup\Setup::getModuleClass

(

$iModuleState

)

$iModuleState - module status: -1 - unable to datect, should not block 0 - missing, blocks setup 1 - fits min requirements 2 - exists required or better

Parameters

int

$iModuleState

module state

Returns

string

getNextStep()

OxidEsales\EshopCommunity\Setup\Setup::getNextStep

(

)

Returns next setup step ident

Returns

int

getShopId()

OxidEsales\EshopCommunity\Setup\Setup::getShopId

(

)

Returns default shop id

Returns

mixed

getStep()

OxidEsales\EshopCommunity\Setup\Setup::getStep

(

$sStepId

)

Returns setup step index

Parameters

string

$sStepId

setup step identifier

Returns

int

getSteps()

OxidEsales\EshopCommunity\Setup\Setup::getSteps

(

)

Returns setup steps index array

Returns

array

getTitle()

OxidEsales\EshopCommunity\Setup\Setup::getTitle

(

)

Returns current setup step title

Returns

string

setMessage()

OxidEsales\EshopCommunity\Setup\Setup::setMessage

(

$sMsg

)

Sets installation process status message

Parameters

string

$sMsg

status message

setNextStep()

OxidEsales\EshopCommunity\Setup\Setup::setNextStep

(

$iStep

)

Current setup step setter

Parameters

int

$iStep

current setup step index

setTitle()

OxidEsales\EshopCommunity\Setup\Setup::setTitle

(

$sTitle

)

Current setup step title setter

Parameters

string

$sTitle

title

Member Data Documentation

$_aSetupSteps

OxidEsales\EshopCommunity\Setup\Setup::$_aSetupSteps

protected

Initial value:

= [
        'STEP_SYSTEMREQ'   => 100, 
        'STEP_WELCOME'     => 200, 
        'STEP_LICENSE'     => 300, 
        'STEP_DB_INFO'     => 400, 
        'STEP_DB_CONNECT'  => 410, 
        'STEP_DIRS_INFO'   => 500, 
        'STEP_DIRS_WRITE'  => 510, 
        'STEP_DB_CREATE'   => 520, 
        'STEP_FINISH'      => 700, 
    ]

$_iCurrStep

OxidEsales\EshopCommunity\Setup\Setup::$_iCurrStep = null

protected

$_iNextStep

OxidEsales\EshopCommunity\Setup\Setup::$_iNextStep = null

protected

$_sMessage

OxidEsales\EshopCommunity\Setup\Setup::$_sMessage = null

protected

$_sTitle

OxidEsales\EshopCommunity\Setup\Setup::$_sTitle = null

protected

---

The documentation for this class was generated from the following file:

• /oxideshop-ce/source/Setup/Setup.php