OXID eShop CE  6.4.2
Public Member Functions | Private Attributes | List of all members
OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration Class Reference

Public Member Functions

 getId ()
 
 setId (string $id)
 
 getPath ()
 
 setPath (string $path)
 
 getVersion ()
 
 setVersion (string $version)
 
 getTitle ()
 
 setTitle (array $title)
 
 getDescription ()
 
 setDescription (array $description)
 
 getLang ()
 
 setLang (string $lang)
 
 getThumbnail ()
 
 setThumbnail (string $thumbnail)
 
 isConfigured ()
 
 setConfigured (bool $configured)
 
 getAuthor ()
 
 setAuthor (string $author)
 
 getUrl ()
 
 setUrl (string $url)
 
 getEmail ()
 
 setEmail (string $email)
 
 getClassExtensions ()
 
 addClassExtension (ClassExtension $extension)
 
 hasClassExtensions ()
 
 getTemplateBlocks ()
 
 addTemplateBlock (TemplateBlock $templateBlock)
 
 hasTemplateBlocks ()
 
 getTemplates ()
 
 addTemplate (Template $template)
 
 hasTemplates ()
 
 hasClassExtension (string $namespace)
 
 isExtendingShopClass (string $shopClassNamespace)
 
 addController (Controller $controller)
 
 getControllers ()
 
 hasControllers ()
 
 addSmartyPluginDirectory (SmartyPluginDirectory $directory)
 
 getSmartyPluginDirectories ()
 
 hasSmartyPluginDirectories ()
 
 addEvent (Event $event)
 
 getEvents ()
 
 hasEvents ()
 
 addClassWithoutNamespace (ClassWithoutNamespace $class)
 
 getClassesWithoutNamespace ()
 
 hasClassWithoutNamespaces ()
 
 getModuleSettings ()
 
 hasModuleSetting (string $settingName)
 
 hasModuleSettings ()
 
 getModuleSetting (string $settingName)
 
 addModuleSetting (Setting $moduleSettings)
 
 setModuleSettings (array $moduleSettings)
 

Private Attributes

 $id
 
 $path
 
 $version = ''
 
 $configured = false
 
 $title = []
 
 $description = []
 
 $lang = ''
 
 $thumbnail = ''
 
 $author = ''
 
 $url = ''
 
 $email = ''
 
 $classExtensions = []
 
 $templates = []
 
 $controllers = []
 
 $smartyPluginDirectories = []
 
 $templateBlocks = []
 
 $events = []
 
 $classesWithoutNamespace = []
 
 $moduleSettings = []
 

Member Function Documentation

◆ addClassExtension()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addClassExtension ( ClassExtension  $extension)
Parameters
ClassExtension$extension
Returns
$this

◆ addClassWithoutNamespace()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addClassWithoutNamespace ( ClassWithoutNamespace  $class)
Deprecated:
6.6 Will be removed completely
Parameters
ClassWithoutNamespace$class
Returns
$this

◆ addController()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addController ( Controller  $controller)
Parameters
Controller$controller
Returns
$this

◆ addEvent()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addEvent ( Event  $event)
Parameters
Event$event
Returns
$this

◆ addModuleSetting()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addModuleSetting ( Setting  $moduleSettings)
Parameters
Setting$moduleSettings
Returns
ModuleConfiguration

◆ addSmartyPluginDirectory()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addSmartyPluginDirectory ( SmartyPluginDirectory  $directory)
Parameters
SmartyPluginDirectory$directory
Returns
$this

◆ addTemplate()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addTemplate ( Template  $template)

◆ addTemplateBlock()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::addTemplateBlock ( TemplateBlock  $templateBlock)

◆ getAuthor()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getAuthor ( )
Returns
string

◆ getClassesWithoutNamespace()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getClassesWithoutNamespace ( )
Deprecated:
6.6 Will be removed completely
Returns
ClassWithoutNamespace[]

◆ getClassExtensions()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getClassExtensions ( )
Returns
ClassExtension[]

◆ getControllers()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getControllers ( )
Returns
Controller[]

◆ getDescription()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getDescription ( )
Returns
array

◆ getEmail()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getEmail ( )
Returns
string

◆ getEvents()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getEvents ( )
Returns
Event[]

◆ getId()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getId ( )
Returns
string

◆ getLang()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getLang ( )
Returns
string

◆ getModuleSetting()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getModuleSetting ( string  $settingName)
Parameters
string$settingName
Returns
Setting
Exceptions
ModuleSettingNotFountException

◆ getModuleSettings()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getModuleSettings ( )
Returns
Setting[]

◆ getPath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getPath ( )
Deprecated:
6.6.1 path parameter will be removed from moduleConfiguration in the next major version
Returns
string

◆ getSmartyPluginDirectories()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getSmartyPluginDirectories ( )
Returns
SmartyPluginDirectory[]

◆ getTemplateBlocks()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getTemplateBlocks ( )
Returns
TemplateBlock[]

◆ getTemplates()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getTemplates ( )
Returns
Template[]

◆ getThumbnail()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getThumbnail ( )
Returns
string

◆ getTitle()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getTitle ( )
Returns
array

◆ getUrl()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getUrl ( )
Returns
string

◆ getVersion()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::getVersion ( )
Returns
string

◆ hasClassExtension()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasClassExtension ( string  $namespace)
Parameters
string$namespace
Returns
bool

◆ hasClassExtensions()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasClassExtensions ( )
Returns
bool

◆ hasClassWithoutNamespaces()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasClassWithoutNamespaces ( )
Deprecated:
6.6 Will be removed completely
Returns
bool

◆ hasControllers()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasControllers ( )
Returns
bool

◆ hasEvents()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasEvents ( )
Returns
bool

◆ hasModuleSetting()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasModuleSetting ( string  $settingName)
Parameters
string$settingName
Returns
bool

◆ hasModuleSettings()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasModuleSettings ( )
Returns
bool

◆ hasSmartyPluginDirectories()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasSmartyPluginDirectories ( )
Returns
bool

◆ hasTemplateBlocks()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasTemplateBlocks ( )
Returns
bool

◆ hasTemplates()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::hasTemplates ( )
Returns
bool

◆ isConfigured()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::isConfigured ( )
Returns
bool

◆ isExtendingShopClass()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::isExtendingShopClass ( string  $shopClassNamespace)
Parameters
string$shopClassNamespace
Returns
bool

◆ setAuthor()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setAuthor ( string  $author)
Parameters
string$author
Returns
ModuleConfiguration

◆ setConfigured()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setConfigured ( bool  $configured)
Parameters
bool$configured
Returns
ModuleConfiguration

◆ setDescription()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setDescription ( array  $description)
Parameters
array$description
Returns
ModuleConfiguration

◆ setEmail()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setEmail ( string  $email)
Parameters
string$email
Returns
ModuleConfiguration

◆ setId()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setId ( string  $id)
Parameters
string$id
Returns
ModuleConfiguration

◆ setLang()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setLang ( string  $lang)
Parameters
string$lang
Returns
ModuleConfiguration

◆ setModuleSettings()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setModuleSettings ( array  $moduleSettings)
Parameters
Setting[]$moduleSettings
Returns
ModuleConfiguration

◆ setPath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setPath ( string  $path)
Parameters
string$path
Deprecated:
6.6.1 path parameter will be removed from moduleConfiguration in the next major version
Returns
ModuleConfiguration

◆ setThumbnail()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setThumbnail ( string  $thumbnail)
Parameters
string$thumbnail
Returns
ModuleConfiguration

◆ setTitle()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setTitle ( array  $title)
Parameters
array$title
Returns
ModuleConfiguration

◆ setUrl()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setUrl ( string  $url)
Parameters
string$url
Returns
ModuleConfiguration

◆ setVersion()

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::setVersion ( string  $version)
Parameters
string$version
Returns
ModuleConfiguration

Member Data Documentation

◆ $author

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$author = ''
private

◆ $classesWithoutNamespace

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$classesWithoutNamespace = []
private

◆ $classExtensions

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$classExtensions = []
private

◆ $configured

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$configured = false
private

◆ $controllers

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$controllers = []
private

◆ $description

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$description = []
private

◆ $email

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$email = ''
private

◆ $events

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$events = []
private

◆ $id

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$id
private

◆ $lang

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$lang = ''
private

◆ $moduleSettings

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$moduleSettings = []
private

◆ $path

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$path
private

◆ $smartyPluginDirectories

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$smartyPluginDirectories = []
private

◆ $templateBlocks

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$templateBlocks = []
private

◆ $templates

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$templates = []
private

◆ $thumbnail

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$thumbnail = ''
private

◆ $title

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$title = []
private

◆ $url

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$url = ''
private

◆ $version

OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration::$version = ''
private
The documentation for this class was generated from the following file: