OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage:

Public Member Functions

 get ()
 
 set ($value)
 
 add ($moduleId, $controllers)
 
 remove ($moduleId)
 

Public Attributes

const STORAGE_KEY = 'aModuleControllers'
 

Private Member Functions

 toLowercase ($modulesControllers)
 
 controllerKeysToLowercase ($controllers)
 
 getConfig ()
 

Detailed Description

Handler class for the storing of the metadata controller field of the modules.

Member Function Documentation

◆ add()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::add (   $moduleId,
  $controllers 
)

Add the controllers for the module, given by its ID, to the storage.

Parameters
string$moduleIdThe ID of the module controllers to add.
array$controllersThe controllers to add to the storage.

◆ controllerKeysToLowercase()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::controllerKeysToLowercase (   $controllers)
private

Change the controller keys to lower case.

Parameters
array$controllersThe controllers array of one module.
Returns
array The given controllers array with the controller keys in lower case.

◆ get()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::get ( )

Get the stored controller value from the oxconfig.

Returns
null|array The controllers field of the modules metadata.

◆ getConfig()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::getConfig ( )
private

Get the config object.

Returns
\oxConfig The config object.

◆ remove()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::remove (   $moduleId)

Delete the controllers for the module, given by its ID, from the storage.

Parameters
string$moduleIdThe ID of the module, for which we want to delete the controllers from the storage.

◆ set()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::set (   $value)

Set the stored controller value from the oxconfig.

Parameters
array$valueThe controllers field of the modules metadata.

◆ toLowercase()

OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::toLowercase (   $modulesControllers)
private

Change the module IDs and the controller keys to lower case.

Parameters
array$modulesControllersThe controller arrays of several modules.
Returns
array The given controller arrays of several modules, with the module IDs and the controller keys in lower case.

Member Data Documentation

◆ STORAGE_KEY

const OxidEsales\EshopCommunity\Core\Routing\Module\ClassProviderStorage::STORAGE_KEY = 'aModuleControllers'

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