Inheritance diagram for OxidEsales\EshopCommunity\Core\Controller\BaseController:

Collaboration diagram for OxidEsales\EshopCommunity\Core\Controller\BaseController:

Public Member Functions
	init ()

	setViewParameters ($aParams=null)

	getViewParameter ($sKey)

	setIsCallForCache ($blIsCallForCache=null)

	getIsCallForCache ()

	getViewId ()

	render ()

	addGlobalParams ($oShop=null)

	addTplParam ($sPara, $sValue)

	getBelboonParam ()

	getViewConfig ()

	getTemplateName ()

	setTemplateName ($sTemplate)

	setClassName ($classKey)

	getClassName ()

	setClassKey ($classKey)

	getClassKey ()

	setFncName ($sFncName)

	getFncName ()

	setViewData ($aViewData=null)

	getViewData ()

	getViewDataElement ($sParamId=null)

	setClassLocation ($sClassLocation=null)

	getClassLocation ()

	setThisAction ($sThisAction=null)

	getThisAction ()

	setParent ($oParent=null)

	getParent ()

	setIsComponent ($blIsComponent=null)

	getIsComponent ()

	executeFunction ($sFunction)

	getAdditionalParams ()

	getCharSet ()

	getShopVersion ()

	getShopEdition ()

	getRevision ()

	getPackageInfo ()

	getShopFullEdition ()

	isDemoVersion ()

	isBetaVersion ()

	isRCVersion ()

	showBetaNote ()

	isDemoShop ()

	showNewsletter ()

	setShowNewsletter ($blShow)

	getActCategory ()

	setActCategory ($oCategory)

	getCategoryId ()

	setCategoryId ($sCategoryId)

	getErrorDestination ()

	getActionClassName ()

	isMall ()

	showRdfa ()

	getSidForWidget ()

	showPersParam ($persParamKey)

Protected Member Functions
	_executeNewAction ($sNewAction)

	onExecuteNewAction ()

	getContainer ()

Protected Attributes
	$_aViewData = []

	$_sClassLocation = null

	$_sThisAction = null

	$_oParent = null

	$_blIsComponent = false

	$_sThisTemplate = null

	$_sViewId = null

	$_sClass = null

	$classKey = null

	$_sFnc = null

	$_sCharSet = null

	$_sVersion = null

	$_blDemoVersion = null

	$_blDemoShop = null

	$_iNewsStatus = null

	$_sShopLogo = null

	$_sCategoryId = null

	$_oClickCat = null

	$_blIsCallForCache = false

	$_oViewConf = null

Static Protected Attributes
static	$_blExecuted = false

Detailed Description

Base view class. Collects and passes data to template engine, sets some global configuration parameters.

Member Function Documentation

◆ _executeNewAction()

OxidEsales\EshopCommunity\Core\Controller\BaseController::_executeNewAction ( $sNewAction )

protected

Formats header for new controller action

Input example: "view_name?param1=val1&param2=val2" => "cl=view_name&param1=val1&param2=val2"

Parameters

string $sNewAction new action params

Exceptions

◆ addGlobalParams()

OxidEsales\EshopCommunity\Core\Controller\BaseController::addGlobalParams ( $oShop = null )

Sets and caches default parameters for shop object and returns it.

Template variables: isdemoversion, shop, isdemoversion, version, urlsign

Parameters

\OxidEsales\Eshop\Application\Model\Shop $oShop current shop object

Returns: \OxidEsales\Eshop\Core\ViewConfig $oShop current shop object

◆ addTplParam()

OxidEsales\EshopCommunity\Core\Controller\BaseController::addTplParam	(	$sPara,
		$sValue
	)

Sets value to parameter used by template engine.

Parameters

string	$sPara	name of parameter to pass
string	$sValue	value of parameter

◆ executeFunction()

OxidEsales\EshopCommunity\Core\Controller\BaseController::executeFunction ( $sFunction )

Executes method (creates class and then executes). Returns executed function result.

Parameters

string $sFunction name of function to execute

Exceptions

◆ getActCategory()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getActCategory ( )

Returns active category set by categories component; if category is not set by component - will create category object and will try to load by id passed by request

Returns: \OxidEsales\Eshop\Application\Model\Category

◆ getActionClassName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getActionClassName ( )

Returns name of a view class, which will be active for an action (given a generic fnc, e.g. logout)

Returns: string

◆ getAdditionalParams()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getAdditionalParams ( )

Template variable getter. Returns additional params for url

Returns: string

◆ getBelboonParam()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getBelboonParam ( )

Returns belboon parameter

Returns: string $sBelboon

◆ getCategoryId()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getCategoryId ( )

Get category ID

Returns: string

◆ getCharSet()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getCharSet ( )

Returns active charset

Returns: string

◆ getClassKey()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getClassKey ( )

Returns class key of current view

Returns: string

◆ getClassLocation()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getClassLocation ( )

Get location of a executed class file

Returns: string

◆ getClassName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getClassName ( )

Deprecated:: since v6.0 (2017-02-3). Use BaseController::getClassId() instead.

Returns class name of current class

Returns: string

◆ getContainer()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getContainer ( )

protected

◆ getErrorDestination()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getErrorDestination ( )

Returns a name of the view variable containing the error/exception messages

◆ getFncName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getFncName ( )

Returns name of current action function

Returns: string

◆ getIsCallForCache()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getIsCallForCache ( )

Get cache sign to enable/disable use of cache

Returns: bool

◆ getIsComponent()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getIsComponent ( )

Get flag if this object is a component

Returns: bool

◆ getPackageInfo()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getPackageInfo ( )

Returns shop package info

Returns: string

◆ getParent()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getParent ( )

Get parent object

Returns: BaseController

◆ getRevision()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getRevision ( )

Returns shop revision

Deprecated:: since v6.0.0 (2017-12-04); This functionality will be removed completely

Returns: bool|string

◆ getShopEdition()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getShopEdition ( )

Returns shop edition

Returns: string

◆ getShopFullEdition()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getShopFullEdition ( )

Returns shop full edition

Returns: string

◆ getShopVersion()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getShopVersion ( )

Returns shop version

Returns: string

◆ getSidForWidget()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getSidForWidget ( )

Returns session ID, but only in case it is needed to be included for widget calls. This basically happens on session change, when session cookie is not equals to the actual session ID.

Returns: string

◆ getTemplateName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getTemplateName ( )

Returns current view template file name

Returns: string

◆ getThisAction()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getThisAction ( )

Get name of running class method

Returns: string

◆ getViewConfig()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getViewConfig ( )

Returns view config object

Returns: \OxidEsales\Eshop\Core\ViewConfig

◆ getViewData()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getViewData ( )

Get view data

Returns: array

◆ getViewDataElement()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getViewDataElement ( $sParamId = null )

Get view data single array element

Parameters

string $sParamId view data array key

Returns: mixed

◆ getViewId()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getViewId ( )

Returns view ID (currently it returns NULL)

◆ getViewParameter()

OxidEsales\EshopCommunity\Core\Controller\BaseController::getViewParameter ( $sKey )

Get parameters to controllers

Parameters

string $sKey parameter key

Returns: string

◆ init()

OxidEsales\EshopCommunity\Core\Controller\BaseController::init ( )

Initiates all components stored, executes \OxidEsales\Eshop\Core\Controller\BaseController::addGlobalParams.

◆ isBetaVersion()

OxidEsales\EshopCommunity\Core\Controller\BaseController::isBetaVersion ( )

Returns if current shop is beta version.

Returns: bool

◆ isDemoShop()

OxidEsales\EshopCommunity\Core\Controller\BaseController::isDemoShop ( )

Returns if current shop is demo shop

Returns: string

◆ isDemoVersion()

OxidEsales\EshopCommunity\Core\Controller\BaseController::isDemoVersion ( )

Returns if current shop is demo version

Returns: string

◆ isMall()

OxidEsales\EshopCommunity\Core\Controller\BaseController::isMall ( )

Returns if shop is mall

Returns: bool

◆ isRCVersion()

OxidEsales\EshopCommunity\Core\Controller\BaseController::isRCVersion ( )

Returns if current shop is release candidate version.

Returns: bool

◆ onExecuteNewAction()

OxidEsales\EshopCommunity\Core\Controller\BaseController::onExecuteNewAction ( )

protected

Method for overwriting if any additional actions on _executeNewAction is needed

◆ render()

OxidEsales\EshopCommunity\Core\Controller\BaseController::render ( )

Returns name of template to render

Returns: string current view template file name

◆ setActCategory()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setActCategory ( $oCategory )

Active category setter

Parameters

\OxidEsales\Eshop\Application\Model\Category $oCategory active category

◆ setCategoryId()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setCategoryId ( $sCategoryId )

Category ID setter

Parameters

string $sCategoryId Id of category to cache

◆ setClassKey()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setClassKey ( $classKey )

Current view class key setter.

Parameters

string $classKey current view class key

◆ setClassLocation()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setClassLocation ( $sClassLocation = null )

Set location of a executed class file

Parameters

string $sClassLocation location of a executed class file

◆ setClassName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setClassName ( $classKey )

Deprecated:: since v6.0 (2017-02-3). Use BaseController::setClassKey() instead.

NOTE: current usage and name misleading, the shop actually calls this function with the view's class id as argument.

Current view class name setter.

Parameters

string $classKey current view class name

◆ setFncName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setFncName ( $sFncName )

Set current view action function name

Parameters

string $sFncName action function name

◆ setIsCallForCache()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setIsCallForCache ( $blIsCallForCache = null )

Set cache sign to enable/disable use of cache

Parameters

bool $blIsCallForCache cache sign to enable/disable use of cache

◆ setIsComponent()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setIsComponent ( $blIsComponent = null )

Set flag if this object is a component or not

Parameters

bool $blIsComponent flag if this object is a component

◆ setParent()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setParent ( $oParent = null )

Set parent object. If this is a component we will have our parent view here.

Parameters

object $oParent parent object

◆ setShowNewsletter()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setShowNewsletter ( $blShow )

Sets if to show newsletter

Parameters

bool $blShow if TRUE - newsletter subscription box will be shown

◆ setTemplateName()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setTemplateName ( $sTemplate )

Sets current view template file name

Parameters

string $sTemplate template name

◆ setThisAction()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setThisAction ( $sThisAction = null )

Set name of running class method

Parameters

string $sThisAction name of running class method

◆ setViewData()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setViewData ( $aViewData = null )

Set array of data that is passed to template engine - array( "varName" => "varValue")

Parameters

array $aViewData array of data that is passed to template engine

◆ setViewParameters()

OxidEsales\EshopCommunity\Core\Controller\BaseController::setViewParameters ( $aParams = null )

Add parameters to controllers

Parameters

array $aParams view parameters array.

◆ showBetaNote()

OxidEsales\EshopCommunity\Core\Controller\BaseController::showBetaNote ( )

Template variable getter. Returns if beta note can be displayed (for header.tpl)

Returns: bool

◆ showNewsletter()

OxidEsales\EshopCommunity\Core\Controller\BaseController::showNewsletter ( )

Template variable getter. Returns if newsletter can be displayed (for _right.tpl)

Returns: integer

◆ showPersParam()

OxidEsales\EshopCommunity\Core\Controller\BaseController::showPersParam ( $persParamKey )

Returns whether to show persistent parameter. Returns true as a default.

Parameters

string $persParamKey

Returns: bool

◆ showRdfa()

OxidEsales\EshopCommunity\Core\Controller\BaseController::showRdfa ( )

Returns if page has rdfa

Returns: bool

Member Data Documentation

◆ $_aViewData

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_aViewData = []

protected

◆ $_blDemoShop

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_blDemoShop = null

protected

◆ $_blDemoVersion

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_blDemoVersion = null

protected

◆ $_blExecuted

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_blExecuted = false

staticprotected

◆ $_blIsCallForCache

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_blIsCallForCache = false

protected

◆ $_blIsComponent

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_blIsComponent = false

protected

◆ $_iNewsStatus

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_iNewsStatus = null

protected

◆ $_oClickCat

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_oClickCat = null

protected

◆ $_oParent

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_oParent = null

protected

◆ $_oViewConf

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_oViewConf = null

protected

◆ $_sCategoryId

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sCategoryId = null

protected

◆ $_sCharSet

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sCharSet = null

protected

◆ $_sClass

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sClass = null

protected

◆ $_sClassLocation

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sClassLocation = null

protected

◆ $_sFnc

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sFnc = null

protected

◆ $_sShopLogo

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sShopLogo = null

protected

◆ $_sThisAction

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sThisAction = null

protected

◆ $_sThisTemplate

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sThisTemplate = null

protected

◆ $_sVersion

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sVersion = null

protected

◆ $_sViewId

OxidEsales\EshopCommunity\Core\Controller\BaseController::$_sViewId = null

protected

◆ $classKey

OxidEsales\EshopCommunity\Core\Controller\BaseController::$classKey = null

protected

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

/oxideshop-ce/source/Core/Controller/BaseController.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ _executeNewAction()

◆ addGlobalParams()

◆ addTplParam()

◆ executeFunction()

◆ getActCategory()

◆ getActionClassName()

◆ getAdditionalParams()

◆ getBelboonParam()

◆ getCategoryId()

◆ getCharSet()

◆ getClassKey()

◆ getClassLocation()

◆ getClassName()

◆ getContainer()

◆ getErrorDestination()

◆ getFncName()

◆ getIsCallForCache()

◆ getIsComponent()

◆ getPackageInfo()

◆ getParent()

◆ getRevision()

◆ getShopEdition()

◆ getShopFullEdition()

◆ getShopVersion()

◆ getSidForWidget()

◆ getTemplateName()

◆ getThisAction()

◆ getViewConfig()

◆ getViewData()

◆ getViewDataElement()

◆ getViewId()

◆ getViewParameter()

◆ init()

◆ isBetaVersion()

◆ isDemoShop()

◆ isDemoVersion()

◆ isMall()

◆ isRCVersion()

◆ onExecuteNewAction()

◆ render()

◆ setActCategory()

◆ setCategoryId()

◆ setClassKey()

◆ setClassLocation()

◆ setClassName()

◆ setFncName()

◆ setIsCallForCache()

◆ setIsComponent()

◆ setParent()

◆ setShowNewsletter()

◆ setTemplateName()

◆ setThisAction()

◆ setViewData()

◆ setViewParameters()

◆ showBetaNote()

◆ showNewsletter()

◆ showPersParam()

◆ showRdfa()

Member Data Documentation

◆ $_aViewData

◆ $_blDemoShop

◆ $_blDemoVersion

◆ $_blExecuted

◆ $_blIsCallForCache

◆ $_blIsComponent

◆ $_iNewsStatus

◆ $_oClickCat

◆ $_oParent

◆ $_oViewConf

◆ $_sCategoryId

◆ $_sCharSet

◆ $_sClass

◆ $_sClassLocation

◆ $_sFnc