OxidEsales\EshopCommunity\Core\Base Class Reference

Collaboration diagram for OxidEsales\EshopCommunity\Core\Base:

Public Member Functions
	__call ($method, $arguments)
	__construct ()
	getConfig ()
	setConfig ($config)
	getSession ()
	setSession ($session)
	getUser ()
	setUser ($user)
	isAdmin ()
	setAdminMode ($isAdmin)
	dispatchEvent (\Symfony\Component\EventDispatcher\Event $event)

Protected Member Functions
	getContainer ()

Static Protected Attributes
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

Basic class which is used as parent class by other OXID eShop classes. It provides access to some basic objects and some basic functionality.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\Base::__construct

(

)

Class constructor. The constructor is defined in order to be possible to call parent::__construct() in modules.

Returns

null

Member Function Documentation

__call()

OxidEsales\EshopCommunity\Core\Base::__call	(		$method,
			$arguments
	)

Only used for convenience in UNIT tests by doing so we avoid writing extended classes for testing protected or private methods

Parameters

string	$method	Methods name
array	$arguments	Argument array

Exceptions

oxSystemComponentException

Throws an exception if the called method does not exist or is not accessable in current class

Returns

string

dispatchEvent()

OxidEsales\EshopCommunity\Core\Base::dispatchEvent

(

\Symfony\Component\EventDispatcher\Event

$event

)

Dispatch given event.

Parameters

\Symfony\Component\EventDispatcher\Event

$event

Event to dispatch

Returns

\Symfony\Component\EventDispatcher\Event

getConfig()

OxidEsales\EshopCommunity\Core\Base::getConfig

(

)

oxConfig instance getter

Deprecated:

since v6.4.0 (2018-10-15); This method will be removed completely. Use \OxidEsales\Eshop\Core\Registry::getConfig().

Returns

\OxidEsales\Eshop\Core\Config

getContainer()

OxidEsales\EshopCommunity\Core\Base::getContainer ( )

protected

getSession()

OxidEsales\EshopCommunity\Core\Base::getSession

(

)

oxSession instance getter

Deprecated:

since v6.4.0 (2019-05-17); This method will be removed completely. Use \OxidEsales\Eshop\Core\Registry::getSession().

Returns

\OxidEsales\Eshop\Core\Session

getUser()

OxidEsales\EshopCommunity\Core\Base::getUser

(

)

Active user getter

Returns

\OxidEsales\Eshop\Application\Model\User

isAdmin()

OxidEsales\EshopCommunity\Core\Base::isAdmin

(

)

Admin mode status getter

Returns

bool

setAdminMode()

OxidEsales\EshopCommunity\Core\Base::setAdminMode

(

$isAdmin

)

Admin mode setter

Parameters

bool

$isAdmin

admin mode

setConfig()

OxidEsales\EshopCommunity\Core\Base::setConfig

(

$config

)

oxConfig instance setter

Parameters

\OxidEsales\Eshop\Core\Config

$config

config object

Deprecated:

since v6.4.0 (2018-10-15); This method will be removed completely. Use \OxidEsales\Eshop\Core\Registry::set(\OxidEsales\Eshop\Core\Config:class, $config).

setSession()

OxidEsales\EshopCommunity\Core\Base::setSession

(

$session

)

oxSession instance setter

Deprecated:

since v6.4.0 (2019-05-17); This method will be removed completely. Use \OxidEsales\Eshop\Core\Registry::set(\OxidEsales\Eshop\Core\Session::class, $session).

Parameters

\OxidEsales\Eshop\Core\Session

$session

session object

setUser()

OxidEsales\EshopCommunity\Core\Base::setUser

(

$user

)

Active oxuser object setter

Parameters

\OxidEsales\Eshop\Application\Model\User

$user

user object

Member Data Documentation

$_blIsAdmin

OxidEsales\EshopCommunity\Core\Base::$_blIsAdmin = null

staticprotected

$_oActUser

OxidEsales\EshopCommunity\Core\Base::$_oActUser = null

staticprotected

$_oConfig

OxidEsales\EshopCommunity\Core\Base::$_oConfig = null

staticprotected

$_oRights

OxidEsales\EshopCommunity\Core\Base::$_oRights = null

staticprotected

$_oSession

OxidEsales\EshopCommunity\Core\Base::$_oSession = null

staticprotected

---

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

• /oxideshop-ce/source/Core/Base.php