OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Registry Class Reference
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Registry:

Static Public Member Functions

static get ($className)
 
static set ($className, $instance)
 
static getConfig ()
 
static getSession ()
 
static getLang ()
 
static getUtils ()
 
static getUtilsObject ()
 
static getInputValidator ()
 
static getPictureHandler ()
 
static getRequest ()
 
static getSeoEncoder ()
 
static getSeoDecoder ()
 
static getUtilsCount ()
 
static getUtilsDate ()
 
static getUtilsFile ()
 
static getUtilsPic ()
 
static getUtilsServer ()
 
static getUtilsString ()
 
static getUtilsUrl ()
 
static getUtilsXml ()
 
static getUtilsView ()
 
static getControllerClassNameResolver ()
 
static getLogger ()
 
static getKeys ()
 
static instanceExists ($className)
 
static getBackwardsCompatibilityClassMap ()
 
static getStorageKey ($className)
 

Static Protected Member Functions

static createObject ($className)
 
static getObject ($className)
 

Static Protected Attributes

static $instances = []
 
static $backwardsCompatibilityClassMap = null
 

Detailed Description

Object registry design pattern implementation. Stores the instances of objects

Member Function Documentation

◆ createObject()

static OxidEsales\EshopCommunity\Core\Registry::createObject (   $className)
staticprotected

Special case handling: The recommended way to get an instance of UtilsObject is to use Registry::getUtilsObject IMPORTANT: UtilsObject is not delivered from Registry::instances this way, so Registry::set will have no effect on which UtilsObject is delivered. Also Registry::instanceExists will always return false for UtilsObject. This does only affect BC class name and unified namespace class names, not the edition own classes atm.

Parameters
string$classNameClass name.
Returns
object

◆ get()

static OxidEsales\EshopCommunity\Core\Registry::get (   $className)
static

Instance getter. Return an existing or new instance for a given class name. Consider using the getter methods over the generic Registry::get() method. In order to avoid issues with different shop editions, the given class name must be from the Unified Namespace.

For reasons of backwards compatibility old class names like 'oxconfig' are still supported and equivalent to the corresponding class name from the Unified Namespace, as they store and retrieve the same instances. But be aware, that support for old class names will be dropped in the future.

Parameters
string$classNameThe class name from the Unified Namespace.
Returns
object

◆ getBackwardsCompatibilityClassMap()

static OxidEsales\EshopCommunity\Core\Registry::getBackwardsCompatibilityClassMap ( )
static

Get backwardsCompatibilityClassMap

Returns
array

◆ getConfig()

static OxidEsales\EshopCommunity\Core\Registry::getConfig ( )
static

Return an instance of \OxidEsales\Eshop\Core\Config

Returns
\OxidEsales\Eshop\Core\Config

◆ getControllerClassNameResolver()

static OxidEsales\EshopCommunity\Core\Registry::getControllerClassNameResolver ( )
static

Return an instance of \OxidEsales\Eshop\Core\Routing\ControllerClassNameResolver

Returns
\OxidEsales\Eshop\Core\Routing\ControllerClassNameResolver

◆ getInputValidator()

static OxidEsales\EshopCommunity\Core\Registry::getInputValidator ( )
static

Return an instance of \OxidEsales\Eshop\Core\InputValidator

Returns
\OxidEsales\Eshop\Core\InputValidator

◆ getKeys()

static OxidEsales\EshopCommunity\Core\Registry::getKeys ( )
static

Return all class instances, which are currently set in the registry

Returns
array

◆ getLang()

static OxidEsales\EshopCommunity\Core\Registry::getLang ( )
static

Returns an instance of \OxidEsales\Eshop\Core\Language

Returns
\OxidEsales\Eshop\Core\Language

◆ getLogger()

static OxidEsales\EshopCommunity\Core\Registry::getLogger ( )
static

Returns Logger

Returns
\Psr\Log\LoggerInterface

◆ getObject()

static OxidEsales\EshopCommunity\Core\Registry::getObject (   $className)
staticprotected

Return a well known object from the registry

Parameters
string$classNameA unified namespace class name
Returns
mixed

◆ getPictureHandler()

static OxidEsales\EshopCommunity\Core\Registry::getPictureHandler ( )
static

Return an instance of \OxidEsales\Eshop\Core\PictureHandler

Returns
\OxidEsales\Eshop\Core\PictureHandler

◆ getRequest()

static OxidEsales\EshopCommunity\Core\Registry::getRequest ( )
static

Return an instance of \OxidEsales\Eshop\Core\Request

Returns
\OxidEsales\Eshop\Core\Request

◆ getSeoDecoder()

static OxidEsales\EshopCommunity\Core\Registry::getSeoDecoder ( )
static

Return an instance of \OxidEsales\Eshop\Core\SeoDecoder

Returns
\OxidEsales\Eshop\Core\SeoDecoder

◆ getSeoEncoder()

static OxidEsales\EshopCommunity\Core\Registry::getSeoEncoder ( )
static

Return an instance of \OxidEsales\Eshop\Core\SeoEncoder

Returns
\OxidEsales\Eshop\Core\SeoEncoder

◆ getSession()

static OxidEsales\EshopCommunity\Core\Registry::getSession ( )
static

Returns an instance of \OxidEsales\Eshop\Core\Session

Returns
\OxidEsales\Eshop\Core\Session

◆ getStorageKey()

static OxidEsales\EshopCommunity\Core\Registry::getStorageKey (   $className)
static

Translate a given old class name like 'oxconfig' into a storage key as known by the Registry. If a new class name is used, the method just returns it as it is.

Parameters
string$classNameClass name to be converted.
Returns
string

◆ getUtils()

static OxidEsales\EshopCommunity\Core\Registry::getUtils ( )
static

Returns an instance of \OxidEsales\Eshop\Core\Utils

Returns
\OxidEsales\Eshop\Core\Utils

◆ getUtilsCount()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsCount ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsCount

Returns
\OxidEsales\Eshop\Core\UtilsCount

◆ getUtilsDate()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsDate ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsDate

Returns
\OxidEsales\Eshop\Core\UtilsDate

◆ getUtilsFile()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsFile ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsFile

Returns
\OxidEsales\Eshop\Core\UtilsFile

◆ getUtilsObject()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsObject ( )
static

Returns an instance of OxidEsales\Eshop\Core\UtilsObject

Returns
\OxidEsales\Eshop\Core\UtilsObject

◆ getUtilsPic()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsPic ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsPic

Returns
\OxidEsales\Eshop\Core\UtilsPic

◆ getUtilsServer()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsServer ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsServer

Returns
\OxidEsales\Eshop\Core\UtilsServer

◆ getUtilsString()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsString ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsString

Returns
\OxidEsales\Eshop\Core\UtilsString

◆ getUtilsUrl()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsUrl ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsUrl

Returns
\OxidEsales\Eshop\Core\UtilsUrl

◆ getUtilsView()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsView ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsView

Returns
\OxidEsales\Eshop\Core\UtilsView

◆ getUtilsXml()

static OxidEsales\EshopCommunity\Core\Registry::getUtilsXml ( )
static

Return an instance of \OxidEsales\Eshop\Core\UtilsXml

Returns
\OxidEsales\Eshop\Core\UtilsXml

◆ instanceExists()

static OxidEsales\EshopCommunity\Core\Registry::instanceExists (   $className)
static

Check if an instance of a given class is set in the registry

Parameters
string$className
Returns
bool

◆ set()

static OxidEsales\EshopCommunity\Core\Registry::set (   $className,
  $instance 
)
static

Instance setter

Parameters
string$classNameClass name
object$instanceObject instance
Returns
null

Member Data Documentation

◆ $backwardsCompatibilityClassMap

OxidEsales\EshopCommunity\Core\Registry::$backwardsCompatibilityClassMap = null
staticprotected

◆ $instances

OxidEsales\EshopCommunity\Core\Registry::$instances = []
staticprotected

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