OXID eShop CE
6.1.4
|
Public Member Functions | |
__construct () | |
systemReq () | |
welcome () | |
license () | |
dbInfo () | |
dirsInfo () | |
dbConnect () | |
dbCreate () | |
dirsWrite () | |
finish () | |
getView () | |
Public Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core | |
getInstance ($sInstanceName) | |
__call ($sMethod, $aArgs) | |
Protected Member Functions | |
onDirsWriteSetStep ($setup) | |
setViewOptions ($templateFileName, $titleId, $viewOptions) | |
Protected Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core | |
getClass ($sInstanceName) | |
getSetupInstance () | |
getLanguageInstance () | |
getUtilitiesInstance () | |
getSessionInstance () | |
getDatabaseInstance () | |
userDecidedOverwriteDB () | |
userDecidedIgnoreDBWarning () | |
Private Member Functions | |
databaseCanBeOverwritten ($database) | |
formMessageIfDBCanBeOverwritten ($databaseName, $view, $language) | |
formMessageIfMySqyVersionIsNotRecommended ($view, $language) | |
formMessageInstallAnyway ($view, $language, $sessionId, $setupStep) | |
formMessageIgnoreDbVersionNotRecommended ($view, $language, $sessionId, $setupStep, $databaseExists) | |
installShopData ($database, $demoDataRequired=0) | |
getModuleStateMapGenerator ($systemRequirementsInfo) | |
getSystemRequirementsInfo () | |
updateSystemRequirementsInfo ($systemRequirementsInfo) | |
canUpdateHtaccess () | |
handleCommandExecutionFailedException ($exception) | |
convertCommandOutputToHtmlOutput ($commandOutput) | |
ensureDatabasePresent ($database, $dbName) | |
Private Attributes | |
$view = null | |
Additional Inherited Members | |
Static Protected Attributes inherited from OxidEsales\EshopCommunity\Setup\Core | |
static | $_aInstances = [] |
Class holds scripts (controllers) needed to perform shop setup steps
OxidEsales\EshopCommunity\Setup\Controller::__construct | ( | ) |
Controller constructor
|
private |
Check if htaccess file can be updated.
|
private |
string | $commandOutput |
|
private |
Check if database can be safely overwritten.
\OxidEsales\EshopCommunity\Setup\Database | $database | database instance used to connect to DB |
OxidEsales\EshopCommunity\Setup\Controller::dbConnect | ( | ) |
Testing database connection
Functionality is tested via: Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenNotAllFieldsAreFilled
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenDatabaseUserDoesNotHaveAccess
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenDatabaseUserIsValidButCantCreateDatabase
Acceptance/Frontend/ShopSetUpTest.php::testUserIsNotifiedIfAValidDatabaseAlreadyExistsBeforeTryingToOverwriteIt
OxidEsales\EshopCommunity\Setup\Controller::dbCreate | ( | ) |
Creating database
Functionality is tested via: Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenDatabaseUserIsValidButCantCreateDatabase
Acceptance/Frontend/ShopSetUpTest.php::testUserIsNotifiedIfAValidDatabaseAlreadyExistsBeforeTryingToOverwriteIt
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenSetupSqlFileIsMissing
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDatabaseEntryPageWhenSetupSqlFileHasSyntaxError
Acceptance/Frontend/ShopSetUpTest.php::testSetupShowsErrorMessageWhenMigrationFileContainsSyntaxErrors
Acceptance/Frontend/ShopSetUpTest.php::testSetupShowsErrorMessageWhenMigrationExecutableIsMissing
Acceptance/Frontend/ShopSetUpTest.php::testSetupShowsErrorMessageWhenViewRegenerationReturnsErrorCode
Acceptance/Frontend/ShopSetUpTest.php::testSetupShowsErrorMessageWhenViewsRegenerationExecutableIsMissing
OxidEsales\EshopCommunity\Setup\Controller::dbInfo | ( | ) |
DB info entry page
Functionality is tested via: Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToWelcomeScreenInCaseLicenseIsNotCheckedAsAgreed
OxidEsales\EshopCommunity\Setup\Controller::dirsInfo | ( | ) |
Setup paths info entry page
OxidEsales\EshopCommunity\Setup\Controller::dirsWrite | ( | ) |
Writing config info
Functionality is tested via: Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDirInfoEntryPageWhenNotAllFieldsAreFilled
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDirInfoEntryPageWhenPasswordIsTooShort
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDirInfoEntryPageWhenPasswordDoesNotMatch
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDirInfoEntryPageWhenInvalidEmailUsed
Acceptance/Frontend/ShopSetUpTest.php::testSetupRedirectsToDirInfoEntryPageWhenSetupCantFindConfigFile
|
private |
Ensure the database is available
OxidEsales\EshopCommunity\Setup\Controller::finish | ( | ) |
Final setup step
|
private |
Show warning-question if database with same name already exists.
string | $databaseName | name of database to check if exist |
\OxidEsales\EshopCommunity\Setup\View | $view | to set parameters for template |
\OxidEsales\EshopCommunity\Setup\Language | $language | to translate text |
|
private |
Show warning-question if MySQL version does meet minimal requirements, but is neither recommended nor supported.
\OxidEsales\EshopCommunity\Setup\View | $view | to set parameters for template |
\OxidEsales\EshopCommunity\Setup\Language | $language | to translate text |
|
private |
Show a message and a link to continue installation process, not regarding errors and warnings
\OxidEsales\EshopCommunity\Setup\View | $view | to set parameters for template |
\OxidEsales\EshopCommunity\Setup\Language | $language | to translate text |
string | $sessionId | |
string | $setupStep | where to redirect if chose to rewrite database |
bool | $databaseExists | Database already exists |
|
private |
Show a message and a link to continue installation process, not regarding errors and warnings
\OxidEsales\EshopCommunity\Setup\View | $view | to set parameters for template |
\OxidEsales\EshopCommunity\Setup\Language | $language | to translate text |
string | $sessionId | |
string | $setupStep | where to redirect if chose to rewrite database |
|
private |
Getter for ModuleStateMapGenerator.
Returns an instance of ModuleStateMapGenerator which has all necessary functions predefined:
array | $systemRequirementsInfo |
|
private |
Get updated array in the same format as provided by SystemRequirements::getSystemInfo
.
OxidEsales\EshopCommunity\Setup\Controller::getView | ( | ) |
Returns View object
|
private |
CommandExecutionFailedException | $exception |
|
private |
Installs demo data or initial, dependent on parameter
\OxidEsales\EshopCommunity\Setup\Database | $database | |
int | $demoDataRequired |
SetupControllerExitException |
OxidEsales\EshopCommunity\Setup\Controller::license | ( | ) |
License confirmation page
|
protected |
\OxidEsales\EshopCommunity\Setup\Setup | $setup |
|
protected |
Allows to set all necessary view information with single method call.
string | $templateFileName | File name of template which will be used to pass in the context data. |
string | $titleId | Title Id which will be used in the template. |
array | $viewOptions | An array containing all view elements to be used inside a template. |
OxidEsales\EshopCommunity\Setup\Controller::systemReq | ( | ) |
First page with system requirements check
Functionality is tested via: Acceptance/Frontend/ShopSetUpTest.php::testSystemRequirementsPageCanContinueWithSetup
Acceptance/Frontend/ShopSetUpTest.php::testSystemRequirementsPageShowsTranslatedModuleNames
Acceptance/Frontend/ShopSetUpTest.php::testSystemRequirementsPageShowsTranslatedModuleGroupNames
Acceptance/Frontend/ShopSetUpTest.php::testSystemRequirementsContainsProperModuleStateHtmlClassNames
Acceptance/Frontend/ShopSetUpTest.php::testInstallShopCantContinueDueToHtaccessProblem
|
private |
Modify given array of format SystemRequirements::getSystemInfo
with exceptional cases.
ATM it is a bit tricky to include these changes due to the way SystemRequirements are constructed.
array | $systemRequirementsInfo | An array taken from SystemRequirements::getSystemInfo . |
SystemRequirements::getSystemInfo
. OxidEsales\EshopCommunity\Setup\Controller::welcome | ( | ) |
Welcome page
|
private |