OxidEsales\EshopCommunity\Setup\View Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Setup\View:

Collaboration diagram for OxidEsales\EshopCommunity\Setup\View:

Public Member Functions
	setTemplateFileName ($templateFileName)
	display ()
	getTitle ()
	setTitle ($sTitleId)
	getMessages ()
	setMessage ($sMessage, $blOverride=false)
	getText ($sTextId, $blPrint=true)
	getSid ($blPrint=true)
	setViewParam ($sName, $sValue)
	getViewParam ($sName)
	getSetupStep ($sStepId, $blPrint=true)
	getNextSetupStep ()
	getCurrentSetupStep ()
	getSetupSteps ()
	isDeletedSetup ($aSetupConfig, $aDemoConfig)
	getReqInfoUrl ($sIdent, $blPrint=true)
	sendHeaders ()
Public Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core
	getInstance ($sInstanceName)
	__call ($sMethod, $aArgs)

Protected Attributes
	$_sTitle = null
	$_aMessages = []
	$_aViewParams = []

Private Member Functions
	getPathToActiveTemplateFileName ()
	getPathToTemplateFileName ($templateFileName)

Private Attributes
	$templateFileName = 'default.php'

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

Setup View class

Member Function Documentation

display()

OxidEsales\EshopCommunity\Setup\View::display

(

)

Displays current setup step template

getCurrentSetupStep()

OxidEsales\EshopCommunity\Setup\View::getCurrentSetupStep

(

)

Returns current setup step id

Returns

null

getMessages()

OxidEsales\EshopCommunity\Setup\View::getMessages

(

)

Returns messages array

Returns

array

getNextSetupStep()

OxidEsales\EshopCommunity\Setup\View::getNextSetupStep

(

)

Returns next setup step id

Returns

int

getPathToActiveTemplateFileName()

OxidEsales\EshopCommunity\Setup\View::getPathToActiveTemplateFileName ( )

private

Returns

string

getPathToTemplateFileName()

OxidEsales\EshopCommunity\Setup\View::getPathToTemplateFileName (   $templateFileName )

private

Parameters

string

$templateFileName

Name of the template file.

Returns

string

getReqInfoUrl()

OxidEsales\EshopCommunity\Setup\View::getReqInfoUrl	(		$sIdent,
			$blPrint = true
	)

Returns or prints url for info about missing web service configuration

Parameters

string	$sIdent	module identifier
bool	$blPrint	prints result if TRUE

Returns

mixed

getSetupStep()

OxidEsales\EshopCommunity\Setup\View::getSetupStep	(		$sStepId,
			$blPrint = true
	)

Returns passed setup step number

Parameters

string	$sStepId	setup step id
bool	$blPrint	if true - prints requested value [optional]

Returns

int

getSetupSteps()

OxidEsales\EshopCommunity\Setup\View::getSetupSteps

(

)

Returns all setup process steps

Returns

array

getSid()

OxidEsales\EshopCommunity\Setup\View::getSid

(

$blPrint = true

)

Prints session id

Parameters

bool

$blPrint

if true - prints requested value [optional]

Returns

null

getText()

OxidEsales\EshopCommunity\Setup\View::getText	(		$sTextId,
			$blPrint = true
	)

Translates text

Parameters

string	$sTextId	translation ident
bool	$blPrint	if true - prints requested value [optional]

Returns

string

getTitle()

OxidEsales\EshopCommunity\Setup\View::getTitle

(

)

Returns current page title

Returns

string

getViewParam()

OxidEsales\EshopCommunity\Setup\View::getViewParam

(

$sName

)

Returns view parameter value

Parameters

string

$sName

view parameter name

Returns

mixed

isDeletedSetup()

OxidEsales\EshopCommunity\Setup\View::isDeletedSetup	(		$aSetupConfig,
			$aDemoConfig
	)

If demo data installation is OFF, tries to delete demo pictures also checks if setup deletion is ON and deletes setup files if possible, return deletion status

Parameters

array	$aSetupConfig	if to delete setup directory.
array	$aDemoConfig	database and demo data configuration.

Returns

bool

sendHeaders()

OxidEsales\EshopCommunity\Setup\View::sendHeaders

(

)

Sends content headers.

setMessage()

OxidEsales\EshopCommunity\Setup\View::setMessage	(		$sMessage,
			$blOverride = false
	)

Sets message to view

Parameters

string	$sMessage	message to write to view
bool	$blOverride	if TRUE cleanups previously defined messages [optional]

setTemplateFileName()

OxidEsales\EshopCommunity\Setup\View::setTemplateFileName

(

$templateFileName

)

Defines name of template to be used in display method.

Parameters

string

$templateFileName

Exceptions

TemplateNotFoundException

setTitle()

OxidEsales\EshopCommunity\Setup\View::setTitle

(

$sTitleId

)

Sets current page title id

Parameters

string

$sTitleId

title id

setViewParam()

OxidEsales\EshopCommunity\Setup\View::setViewParam	(		$sName,
			$sValue
	)

Sets view parameter value

Parameters

string	$sName	parameter name
mixed	$sValue	parameter value

Member Data Documentation

$_aMessages

OxidEsales\EshopCommunity\Setup\View::$_aMessages = []

protected

$_aViewParams

OxidEsales\EshopCommunity\Setup\View::$_aViewParams = []

protected

$_sTitle

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

protected

$templateFileName

OxidEsales\EshopCommunity\Setup\View::$templateFileName = 'default.php'

private

---

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

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