OXID eShop CE  6.4.2
OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider:
+ Collaboration diagram for OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider:

Public Member Functions

 __construct (MetaDataNormalizerInterface $metaDataNormalizer, BasicContextInterface $context, MetaDataValidatorInterface $metaDataValidator, MetaDataConverterInterface $metaDataConverter)
 
 getData (string $filePath)
 

Public Attributes

const METADATA_ID = 'id'
 
const METADATA_METADATA_VERSION = 'metaDataVersion'
 
const METADATA_MODULE_DATA = 'moduleData'
 
const METADATA_TITLE = 'title'
 
const METADATA_DESCRIPTION = 'description'
 
const METADATA_LANG = 'lang'
 
const METADATA_THUMBNAIL = 'thumbnail'
 
const METADATA_AUTHOR = 'author'
 
const METADATA_URL = 'url'
 
const METADATA_EMAIL = 'email'
 
const METADATA_VERSION = 'version'
 
const METADATA_EXTEND = 'extend'
 
const METADATA_BLOCKS = 'blocks'
 
const METADATA_CONTROLLERS = 'controllers'
 
const METADATA_EVENTS = 'events'
 
const METADATA_TEMPLATES = 'templates'
 
const METADATA_SETTINGS = 'settings'
 
const METADATA_SMARTY_PLUGIN_DIRECTORIES = 'smartyPluginDirectories'
 
const METADATA_FILEPATH = 'metaDataFilePath'
 
const METADATA_FILES = 'files'
 

Private Member Functions

 getNormalizedMetaDataFileContent ()
 
 addFilePathToData (array $normalizedMetaData)
 
 validateMetaDataFileVariables ($metaDataVersion, $moduleData)
 
 sanitizeExtendedClasses (array $normalizedMetaData)
 
 isBackwardsCompatibleClass (string $className)
 
 getBackwardsCompatibilityClassMap ()
 

Private Attributes

 $filePath
 
 $eventDispatcher
 
 $metaDataNormalizer
 
 $context
 
 $metaDataValidatorService
 
 $metaDataConverter
 

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::__construct ( MetaDataNormalizerInterface  $metaDataNormalizer,
BasicContextInterface  $context,
MetaDataValidatorInterface  $metaDataValidator,
MetaDataConverterInterface  $metaDataConverter 
)
Parameters
MetaDataNormalizerInterface$metaDataNormalizer
BasicContextInterface$context
MetaDataValidatorInterface$metaDataValidator
MetaDataConverterInterface$metaDataConverter

Member Function Documentation

◆ addFilePathToData()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::addFilePathToData ( array  $normalizedMetaData)
private
Parameters
array$normalizedMetaData
Returns
mixed

◆ getBackwardsCompatibilityClassMap()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::getBackwardsCompatibilityClassMap ( )
private
Returns
array

◆ getData()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::getData ( string  $filePath)
Parameters
string$filePath
Returns
array
Exceptions
InvalidMetaDataException

Implements OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProviderInterface.

◆ getNormalizedMetaDataFileContent()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::getNormalizedMetaDataFileContent ( )
private
Returns
array
Exceptions
InvalidMetaDataException

◆ isBackwardsCompatibleClass()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::isBackwardsCompatibleClass ( string  $className)
private
Parameters
string$className
Returns
bool

◆ sanitizeExtendedClasses()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::sanitizeExtendedClasses ( array  $normalizedMetaData)
private
Parameters
array$normalizedMetaData
Returns
array

◆ validateMetaDataFileVariables()

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::validateMetaDataFileVariables (   $metaDataVersion,
  $moduleData 
)
private
Parameters
mixed$metaDataVersion
mixed$moduleData
Exceptions
InvalidMetaDataException

Member Data Documentation

◆ $context

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$context
private

◆ $eventDispatcher

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$eventDispatcher
private

◆ $filePath

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$filePath
private

◆ $metaDataConverter

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$metaDataConverter
private

◆ $metaDataNormalizer

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$metaDataNormalizer
private

◆ $metaDataValidatorService

OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::$metaDataValidatorService
private

◆ METADATA_AUTHOR

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_AUTHOR = 'author'

◆ METADATA_BLOCKS

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_BLOCKS = 'blocks'

◆ METADATA_CONTROLLERS

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_CONTROLLERS = 'controllers'

◆ METADATA_DESCRIPTION

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_DESCRIPTION = 'description'

◆ METADATA_EMAIL

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_EMAIL = 'email'

◆ METADATA_EVENTS

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_EVENTS = 'events'

◆ METADATA_EXTEND

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_EXTEND = 'extend'

◆ METADATA_FILEPATH

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_FILEPATH = 'metaDataFilePath'

◆ METADATA_FILES

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_FILES = 'files'
Deprecated:
6.6 Will be removed completely

◆ METADATA_ID

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_ID = 'id'

◆ METADATA_LANG

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_LANG = 'lang'

◆ METADATA_METADATA_VERSION

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_METADATA_VERSION = 'metaDataVersion'

◆ METADATA_MODULE_DATA

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_MODULE_DATA = 'moduleData'

◆ METADATA_SETTINGS

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_SETTINGS = 'settings'

◆ METADATA_SMARTY_PLUGIN_DIRECTORIES

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_SMARTY_PLUGIN_DIRECTORIES = 'smartyPluginDirectories'

◆ METADATA_TEMPLATES

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_TEMPLATES = 'templates'

◆ METADATA_THUMBNAIL

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_THUMBNAIL = 'thumbnail'

◆ METADATA_TITLE

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_TITLE = 'title'

◆ METADATA_URL

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_URL = 'url'

◆ METADATA_VERSION

const OxidEsales\EshopCommunity\Internal\Framework\Module\MetaData\Dao\MetaDataProvider::METADATA_VERSION = 'version'

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