OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain:

Public Member Functions
	render ()
	save ()

Public Attributes
const	NEW_SHOP_ID = "-1"
const	SHOP_FIELD_SET_SIZE = 64

Protected Member Functions
	_getNonCopyConfigVars ()
	_copyConfigVars ($shop)
	renderNewShop ()
	updateShopIdByUser ($user, $shopId, $updateViewData=false)
	checkParent ($shop)
	updateParameters ($parameters)
	checkExceptionType ($exception)
	canCreateShop ($shopId, $shop)
	updateShopInformation ($config, $shop, $shopId)

Detailed Description

Admin article main shop manager. Performs collection and updatind (on user submit) main item information. Admin Menu: Main Menu -> Core Settings -> Main.

Member Function Documentation

_copyConfigVars()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::_copyConfigVars (   $shop )

protected

Copies base shop config variables to current

Parameters

\OxidEsales\Eshop\Application\Model\Shop

$shop

new shop object

_getNonCopyConfigVars()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::_getNonCopyConfigVars ( )

protected

Returns array of config variables which cannot be copied

Returns

array

canCreateShop()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::canCreateShop (   $shopId,   $shop  )

protected

Check if Shop can be created.

Parameters

string	$shopId
\OxidEsales\Eshop\Application\Model\Shop	$shop

Returns

bool

checkExceptionType()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::checkExceptionType (   $exception )

protected

Check for exception type and set it to _aViewData.

Parameters

\OxidEsales\Eshop\Core\Exception\StandardException

$exception

checkParent()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::checkParent (   $shop )

protected

Load Shop parent and set result to _aViewData.

Parameters

\OxidEsales\Eshop\Application\Model\Shop

$shop

render()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::render

(

)

Executes parent method parent::render(), creates oxCategoryList and oxshop objects, passes it's data to Smarty engine and returns name of template file "shop_main.tpl".

Returns

string

renderNewShop()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::renderNewShop ( )

protected

Return template name for new shop if it is different from standard.

Returns

string

save()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::save

(

)

Saves changed main shop configuration parameters.

Returns

null

updateParameters()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::updateParameters (   $parameters )

protected

Unset not used Shop parameters.

Parameters

array

$parameters

Returns

array

updateShopIdByUser()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::updateShopIdByUser (   $user,   $shopId,   $updateViewData = false  )

protected

Check user rights and change userId if need.

Parameters

\OxidEsales\Eshop\Application\Model\User	$user
string	$shopId
bool	$updateViewData	If needs to update view data when shop Id changes.

Returns

string

updateShopInformation()

OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::updateShopInformation (   $config,   $shop,   $shopId  )

protected

Update shop information in DB and oxConfig.

Parameters

\OxidEsales\Eshop\Core\Config	$config
\OxidEsales\Eshop\Application\Model\Shop	$shop
string	$shopId

Member Data Documentation

NEW_SHOP_ID

const OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::NEW_SHOP_ID = "-1"

Identifies new shop.

SHOP_FIELD_SET_SIZE

const OxidEsales\EshopCommunity\Application\Controller\Admin\ShopMain::SHOP_FIELD_SET_SIZE = 64

---

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

• /oxideshop-ce/source/Application/Controller/Admin/ShopMain.php