OXID eShop CE  6.4.2
OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand:
+ Collaboration diagram for OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand:

Public Member Functions

 __construct (ModuleConfigurationInstallerInterface $moduleConfigurationInstaller, BasicContextInterface $context)
 

Public Attributes

const MESSAGE_INSTALLATION_WAS_SUCCESSFUL = 'Module configuration has been installed.'
 
const MESSAGE_INSTALLATION_FAILED = 'An error occurred while installing module configuration.'
 
const MESSAGE_TARGET_PATH_IS_REQUIRED
 

Protected Member Functions

 configure ()
 
 execute (InputInterface $input, OutputInterface $output)
 

Private Member Functions

 getModuleSourcePath (InputInterface $input)
 
 getModuleTargetPath (InputInterface $input)
 
 isDirectoryInsideShopModulesDirectory (string $path)
 
 validatePath (string $path)
 
 getAbsolutePath (string $path)
 

Private Attributes

 $moduleConfigurationInstaller
 
 $context
 

Detailed Description

Deprecated:
command will be superseded by oe:module:install in next major

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::__construct ( ModuleConfigurationInstallerInterface  $moduleConfigurationInstaller,
BasicContextInterface  $context 
)
Parameters
ModuleConfigurationInstallerInterface$moduleConfigurationInstaller
BasicContextInterface$context

Member Function Documentation

◆ configure()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::configure ( )
protected

◆ execute()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::execute ( InputInterface  $input,
OutputInterface  $output 
)
protected
Parameters
InputInterface$input
OutputInterface$output
Exceptions

◆ getAbsolutePath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::getAbsolutePath ( string  $path)
private
Parameters
string$path
Returns
string

◆ getModuleSourcePath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::getModuleSourcePath ( InputInterface  $input)
private
Parameters
InputInterface$input
Returns
string

◆ getModuleTargetPath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::getModuleTargetPath ( InputInterface  $input)
private
Parameters
InputInterface$input
Returns
string
Exceptions
ModuleTargetPathIsMissingException

◆ isDirectoryInsideShopModulesDirectory()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::isDirectoryInsideShopModulesDirectory ( string  $path)
private
Parameters
string$path
Returns
bool

◆ validatePath()

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::validatePath ( string  $path)
private
Parameters
string$path

Member Data Documentation

◆ $context

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::$context
private

◆ $moduleConfigurationInstaller

OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::$moduleConfigurationInstaller
private

◆ MESSAGE_INSTALLATION_FAILED

const OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::MESSAGE_INSTALLATION_FAILED = 'An error occurred while installing module configuration.'

◆ MESSAGE_INSTALLATION_WAS_SUCCESSFUL

const OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::MESSAGE_INSTALLATION_WAS_SUCCESSFUL = 'Module configuration has been installed.'

◆ MESSAGE_TARGET_PATH_IS_REQUIRED

const OxidEsales\EshopCommunity\Internal\Framework\Module\Command\InstallModuleConfigurationCommand::MESSAGE_TARGET_PATH_IS_REQUIRED
Initial value:
= 'The given module source path is not inside the shop modules ' .
'directory. Please provide a second parameter with the modules ' .
'target path inside the shop modules directory.'

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