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

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

Public Member Functions
	__construct ()

	init ()

	addGlobalParams ($oShop=null)

	getServiceUrl ($sLangAbbr=null)

	render ()

	save ()

	resetContentCache ($blForceReset=null)

	resetCounter ($sCounterType, $sValue=null)

	getNavigation ()

	getViewId ()

	chshp ()

	resetSeoData ($sShopId)

	getPreviewId ()

	getEditObjectId ()

	setEditObjectId ($sId)

Protected Member Functions
	_getEditShop ($sShopId)

	_getServiceProtocol ()

	_getShopVersionNr ()

	_setupNavigation ($sNode)

	_addNavigationHistory ($sNode)

	_getMaxUploadFileInfo ($iMaxFileSize, $blFormatted=false)

	_resetContentCache ()

	_allowAdminEdit ($sUserId)

	_getCountryByCode ($sCountryCode)

	_authorize ()

	isNewEditObject ()

	getControllerKey ()

	getShopParentClass ()

Protected Attributes
	$_aSumType

	$_sThisTemplate = null

	$_iDefEdit = 0

	$_iEditLang = 0

	$_sShopTitle = " - "

	$_sShopVersion = null

	$_sServiceUrl = null

	$_oEditShop = null

	$_sEditObjectId = null

	$viewId = null

Static Protected Attributes
static	$_oNaviTree = null

static	$_sAuthUserRights = null

Detailed Description

Main Controller class for admin area.

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::__construct ( )

Creates oxshop object and loads shop data, sets title of shop

Member Function Documentation

◆ _addNavigationHistory()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_addNavigationHistory ( $sNode )

protected

Store navigation history parameters to cookie

Parameters

string $sNode active view id

◆ _allowAdminEdit()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_allowAdminEdit ( $sUserId )

protected

Checks if current $sUserId user is not an admin and checks if user is able to be edited by logged in user. This method does not perform full rights check.

Parameters

string $sUserId user id

Returns: bool

◆ _authorize()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_authorize ( )

protected

performs authorization of admin user

Returns: boolean

◆ _getCountryByCode()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_getCountryByCode ( $sCountryCode )

protected

Get english country name by country iso alpha 2 code

Parameters

string $sCountryCode Country code

Returns: boolean

◆ _getEditShop()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_getEditShop ( $sShopId )

protected

Returns (cached) shop object

Parameters

object $sShopId shop id

Returns: oxshop

◆ _getMaxUploadFileInfo()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_getMaxUploadFileInfo	(	$iMaxFileSize,
		$blFormatted = `false`
	)

protected

Returns maximum allowed size of upload file and formatted size equivalent

Parameters

int	$iMaxFileSize	recommended maximum size of file (normalu value is taken from php ini, otherwise sets 2MB)
bool	$blFormatted	Return formated

Returns: array

◆ _getServiceProtocol()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_getServiceProtocol ( )

protected

Returns service url protocol: "https" is admin works in ssl mode, "http" if no ssl

Returns: string

◆ _getShopVersionNr()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_getShopVersionNr ( )

protected

Returns shop version

Deprecated:: since v6.0.0-rc.2 (2017-08-23); Use OxidEsales\Eshop\Core\ShopVersion::getVersion() instead.

Returns: string

◆ _resetContentCache()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_resetContentCache ( )

protected

Resets cache.

◆ _setupNavigation()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::_setupNavigation ( $sNode )

protected

Sets-up navigation parameters

Parameters

string $sNode active view id

◆ addGlobalParams()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::addGlobalParams ( $oShop = null )

Sets some global parameters to Smarty engine (such as self link, etc.), returns modified shop object.

Parameters

object $oShop Object to modify some parameters

Returns: object

◆ chshp()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::chshp ( )

Changing active shop

◆ getControllerKey()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getControllerKey ( )

protected

Get controller key also for chain extended class.

Returns: null|string

◆ getEditObjectId()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getEditObjectId ( )

Returns active/editable object id

Returns: string

◆ getNavigation()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getNavigation ( )

Returns navigation object

Returns: oxnavigationtree

◆ getPreviewId()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getPreviewId ( )

Returns id which is used for product preview in shop during administration

Returns: string

◆ getServiceUrl()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getServiceUrl ( $sLangAbbr = null )

Returns service URL

Deprecated:: since v5.3 (2016-05-20); Dynpages will be removed.

Parameters

string $sLangAbbr language abbr.

Returns: string

◆ getShopParentClass()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getShopParentClass ( )

protected

Method to figure out \OxidEsales\Eshop class.

Returns: string

◆ getViewId()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::getViewId ( )

Current view ID getter helps to identify navigation position

Returns: string

◆ init()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::init ( )

Sets some shop configuration parameters (such as language), creates some list object (depends on subclass) and executes parent method parent::Init().

◆ isNewEditObject()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::isNewEditObject ( )

protected

Returns true if editable object is new.

Returns: bool

◆ render()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::render ( )

Executes parent method parent::render(), passes configuration data to Smarty engine.

Returns: string

◆ resetContentCache()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::resetContentCache ( $blForceReset = null )

Reset output cache

Parameters

bool $blForceReset if true, forces reset

◆ resetCounter()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::resetCounter	(	$sCounterType,
		$sValue = `null`
	)

Resets counters values from cache. Resets price category articles, category articles, vendor articles, manufacturer articles count.

Parameters

string	$sCounterType	counter type
string	$sValue	reset value

◆ resetSeoData()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::resetSeoData ( $sShopId )

Marks seo entires as expired.

Parameters

string $sShopId Shop id

◆ save()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::save ( )

Clears cache

◆ setEditObjectId()

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::setEditObjectId ( $sId )

Sets editable object id

Parameters

string $sId object id

Member Data Documentation

◆ $_aSumType

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_aSumType

protected

Initial value:

= [
        0 => 'abs',
        1 => '%',
        2 => 'itm'
    ]

◆ $_iDefEdit

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_iDefEdit = 0

protected

◆ $_iEditLang

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_iEditLang = 0

protected

◆ $_oEditShop

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_oEditShop = null

protected

Active shop object

Returns

◆ $_oNaviTree

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_oNaviTree = null

staticprotected

◆ $_sAuthUserRights

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sAuthUserRights = null

staticprotected

◆ $_sEditObjectId

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sEditObjectId = null

protected

◆ $_sServiceUrl

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sServiceUrl = null

protected

◆ $_sShopTitle

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sShopTitle = " - "

protected

◆ $_sShopVersion

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sShopVersion = null

protected

◆ $_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$_sThisTemplate = null

protected

◆ $viewId

OxidEsales\EshopCommunity\Application\Controller\Admin\AdminController::$viewId = null

protected

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

/oxideshop-ce/source/Application/Controller/Admin/AdminController.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addNavigationHistory()

◆ _allowAdminEdit()

◆ _authorize()

◆ _getCountryByCode()

◆ _getEditShop()

◆ _getMaxUploadFileInfo()

◆ _getServiceProtocol()

◆ _getShopVersionNr()

◆ _resetContentCache()

◆ _setupNavigation()

◆ addGlobalParams()

◆ chshp()

◆ getControllerKey()

◆ getEditObjectId()

◆ getNavigation()

◆ getPreviewId()

◆ getServiceUrl()

◆ getShopParentClass()

◆ getViewId()

◆ init()

◆ isNewEditObject()

◆ render()

◆ resetContentCache()

◆ resetCounter()

◆ resetSeoData()

◆ save()

◆ setEditObjectId()

Member Data Documentation

◆ $_aSumType

◆ $_iDefEdit

◆ $_iEditLang

◆ $_oEditShop

◆ $_oNaviTree

◆ $_sAuthUserRights

◆ $_sEditObjectId

◆ $_sServiceUrl

◆ $_sShopTitle

◆ $_sShopVersion

◆ $_sThisTemplate

◆ $viewId