The document provides an overview of changes in OXID eShop V6, including new requirements around Composer integration, namespaces replacing class names, database changes using Doctrine DBAL and migrations, and extracted non-essential modules. It discusses benefits like easier installation and updating, as well as backwards compatibility. Details are given on how these changes impact things like installation, adding components, and using Docker for development.

1. OXID ESHOP
OVERVIEW OF CHANGES IN V6

2. WHO?
Edvinas Aleksejonokas
Software developer/architect | OXID eSales AG

3. SYSTEM
REQUIREMENTS

4. SYSTEM REQUIREMENTS | WHAT?
PHP
Supported versions:
5.6
7.0
No encoders/loaders required:
ZendGuard
IonCube
Composer

5. SYSTEM REQUIREMENTS | WHAT?
MYSQL
Supported versions:
5.5
5.6 (# )
5.7
79203

6. COMPOSER

7. COMPOSER | WHAT?

8. COMPOSER | WHAT?
NEW REQUIREMENT
php composer-setup.php
composer install

9. COMPOSER | WHY?
BENEFITS #1/5
Install necessary eShop edition (CE/PE/EE)
Install necessary OXID components
Themes
Modules
Demodata

10. COMPOSER | WHY?
BENEFITS #2/5
Install necessary 3rd party components
doctrine/dbal
phpmailer
smarty
...

11. COMPOSER | WHY?
BENEFITS #3/5
Provide PSR-4 compatible autoloader
Support all necessary 3rd party components
Support new eShop core namespaces:
OxidEsalesEshopCommunity
OxidEsalesEshopProfessional
OxidEsalesEshopEnterprise

12. COMPOSER | WHY?
BENEFITS #4/5
Provide comfortable eShop maintenance:
Install fully functional eShop (batteries included)
Update all components on-demand

13. COMPOSER | WHY?
BENEFITS #5/5
For project developers:
Manage custom/other 3rd party components
Define additional namespaces
Add composer scripts

14. COMPOSER | HOW?
INSTALL ESHOP
composer create-project oxid-esales/oxideshop-project
<my_project_name> dev-b-6.0-ce

15. COMPOSER | HOW?
ADD 3RD PARTY COMPONENT
composer require monolog/monolog

16. COMPOSER | HOW?
ADD OXID ESALES MODULE/THEME
composer require oxid-esales/paypal-module
composer require oxid-esales/flow-theme

17. COMPOSER | HOW?
ADD 3RD PARTY MODULE/THEME
composer require vendor_name/module_name-module
composer require vendor_name/theme_name-theme

18. COMPOSER | HOW?
UPDATE ALL PROJECT COMPONENTS
composer update

19. COMPOSER | HOW?
UPDATE ESHOP CORE ONLY
composer update oxid-esales/oxideshop-ce

20. COMPOSER | HOW?
UPDATE ALL ESHOP COMPONENTS
composer update oxid-esales/oxideshop-metapackage-ce

21. COMPOSER | HOW?
DEFINE CUSTOM NAMESPACES
"autoload": {
"psr-4": {
"MyVendorMyPackage": "./<path_to_src>/"
}
},

22. COMPOSER | HOW?
DEFINE YOUR OWN SCRIPTS
"scripts": {
"oe:views:regenerate": "oe-eshop-facts oe-eshop-db_views_regenerate",
...
"custom": "<path_to_custom_script>"
},

23. COMPOSER | WHERE?
SINGLE FILE
<project_root>/composer.json

24. COMPOSER | WHERE?
V5.3 DEPRECATED
<project_root>/source/modules/composer.json

25. COMPILATION

26. COMPILATION | WHAT?
EVERYTHING INCLUDED IN ONE PLACE
OXID eShop Core
OXID/3rd party:
Modules
Themes
Components

27. COMPILATION | HOW?
METAPACKAGES
A compilation is defined by meta-package:
oxideshop-metapackage-ce
oxideshop-metapackage-pe
oxideshop-metapackage-ee

28. COMPILATION | HOW?
USAGE
New:
composer create-project ...
oxid-esales/oxideshop-project
Existing
<project_root>/source/modules/composer.json
composer require ...
oxid-esales/oxideshop-metapackage-ce

29. COMPILATION | WHERE?
DISTRIBUTION #1 (COMPOSER)
Packagist ( )
Public service for public packages
oxid-esales/oxideshop-ce
oxid-esales/paypal-module
oxid-esales/flow-theme
...
www.packagist.org

30. COMPILATION | WHERE?
DISTRIBUTION #2 (COMPOSER)
Satis ( )
Internal service for proprietary packages
oxid-esales/oxideshop-ee
visualcms-module
...
packages.oxid-esales.com

31. COMPILATION | WHY?
EASY TO ...
composer install / create-project
Fully functional eShop
composer update
Migrate to new major version of eShop
Get the latest patches for core and all components

32. NAMESPACES

33. NAMESPACES | WHAT?
NEW PSR-4 DEFINED FOR INTERNAL CLASSES
OxidEsalesEshop - Virtual Namespace
OxidEsalesEshopCommunity - CE
OxidEsalesEshopProfessional - PE
OxidEsalesEshopEnterprise - EE

34. NAMESPACES | HOW?
COMPOSER AUTOLOADER
"autoload": {
"psr-4": {
"OxidEsalesEshopCommunity": ".../oxideshop-ce",
"OxidEsalesEshopProfessional": ".../oxideshop-pe",
"OxidEsalesEshopEnterprise": ".../oxideshop-ee",
}
}

35. NAMESPACES | HOW?
BACKWARDS COMPATIBLE BY CLASSMAP #1
is an alias to
oxNew('oxArticle');
oxNew(OxidEsalesEshopApplicationModelArticle::class);

36. NAMESPACES | HOW?
CLASSMAPS
Inside ClassMap file:
'oxbase' => ...CoreModelBaseModel::class,
'oxarticle' => ...ApplicationModelArticle::class,
'oxorder' => ...ApplicationModelOrder::class,
'details' => ...ApplicationControllerArticleDetailsController::class,

37. NAMESPACES | HOW?
CLEAR NAMING OF SUPPER CLASSES
oxSuperCfg -> Base
oxView -> BaseController
oxUBase -> FrontendController
oxWidget -> WidgetController
oxAdminView -> AdminController
oxAdminDetail -> AdminDetailsController
oxAdminList -> AdminListController
oxBase -> BaseModel
oxList -> ListModel
oxI18n -> MultiLanguageModel

38. NAMESPACES | HOW?
BACKWARDS COMPATIBLE BY CLASSMAP #2
Inside of metadata.php
is same as
'oxorder' => '<vendor>/<module_name>/models/order'
OxidEsalesEshopApplicationModelOrder::class =>
'<vendor>/<module_name>/models/order'

39. EVEN BETTER...

40. NAMESPACES | HOW?
BACKWARDS COMPATIBLE BY CLASSMAP #2
Inside of metadata.php
is same as
'oxorder' => '<vendor>/<module_name>/models/order'
OxidEsalesEshopApplicationModelOrder::class =>
MyVendorMyModuleMyOrderClass::class

41. NAMESPACES | HOW?
USAGE IN MODULES
Create composer.json file in the root of module
Define namespace in use:
Use composer require to add your module
"autoload": {
"psr-4": {
"MyVendorMyModule":
"../../../source/modules/myvendor/mymodule"
}
}

42. NAMESPACES | WHY?
GENERAL
De-facto standard to manage hierarchy of classes
Helped to separate eShop editions in a clean way
No need to maintain custom auto-loader
Gain performance
No need to scan files on every oxNew call

43. NAMESPACES | WHY?
VIRTUAL NAMESPACE
OxidEsalesEshop
Introduced for convenience
Maps current active eShop edition namespace

44. DATABASE

45. DATABASE | TOPICS
DBAL
InnoDB
Migration
MySQL 5.7
UTF-8

46. DBAL

47. DATABASE | DBAL | WHAT?
NEW DATABASE ABSTRACTION LAYER
ADOdb lite
doctrine/dbal v2.5.4
ORM excluded!

48. DATABASE | DBAL | HOW?
UPDATED CLASSES
OxidEsalesEshopCommunityCore:
DatabaseProvider (oxDb)
DatabaseAdapterDatabaseInterface
DatabaseAdapterDoctrineDatabase

49. DATABASE | DBAL | HOW?
USAGE
DatabaseProvider::getDb()
returns DatabaseInterface:
getOne, getRow, getCol, getAll
select, selectLimit
execute
quote, quoteArray
startTransaction
commitTransaction
rollbackTransaction

50. DATABASE | DBAL | HOW?
SELECT VS EXECUTE

51. DATABASE | DBAL | WHY?
ADOdb lite
Doctrine DBAL
Popular and actively maintained
Allows to switch to different database engine
We like to have options!

52. INNODB

53. DATABASE | INNODB | WHAT?
SWITCH TO INNODB
All tables have been converted to InnoDB

54. DATABASE | INNODB | HOW?
NO FULL-TEXT SEARCH LEFT
Migration to InnoDB
Removed all places in code which required full-text
search
e.g. tags was extracted in separate module
Updated queries to use explicit sorting

55. DATABASE | INNODB | WHY?
NEW POSSIBILITIES
Use transactions for all tables
Row-level locking
Master-master replication model
Linear write scale
e.g. Galera cluster

56. MIGRATIONS

57. DATABASE | MIGRATIONS | WHAT?
Migration - Special SQL file to automatically update
database
doctrine/migrations

58. DATABASE | MIGRATIONS | HOW?
EXECUTION
composer oe:migration:run

59. DATABASE | MIGRATIONS | HOW?
CREATION
MIGRATION_SUITE=<SUITE_NAME>
composer oe:migration:new
CE
PE
EE
PROJECT

60. DATABASE | MIGRATIONS | WHY?
EASE OF USE
Automate manual work
Ability to migrate from CE/PE and PE/EE
Upgrade eShop
Allow project developers to easily apply database
changes

61. MYSQL 5.7

62. DATABASE | MYSQL 5.7 | WHAT?
ESHOP V6 IS MYSQL 5.7 FRIENDLY

63. DATABASE | MYSQL 5.7 | HOW?
CHANGE QUERIES
Our acceptance test suite showed problematic places
Queries were updated to restore original behavior

64. DATABASE | MYSQL 5.7 | WHY?
KEEP UP WITH HOSTING PROVIDERS
Interest from our clients
Be compatible with hosting providers
Benefit from optimization & performance gains

65. UTF-8

66. DATABASE | UTF-8 | WHAT?
UTF-8 ONLY

67. DATABASE | UTF-8 | WHY?
MULTI-LANGUAGE SUPPORT
Support multiple languages in one database
Backwards compatible with ASCII
No noticeable performance penalty

68. DATABASE
FEW MORE NOTES
Master/slave handling was changed
Possible to use nested transactions
oxDb -> 3 method were removed

69. EXTRACTED MODULES

70. EXTRACTED MODULES | WHAT?
LIST OF REPOSITORIES
https://github.com/OXID-eSales:
lexware_export_module
extended_order_administration_module
statistics_module
captcha_module
guestbook_module
facebook_module
pdf_invoice_module
tags_module

71. EXTRACTED MODULES | WHAT?
LIST OF 3RD PARTY MODULES
Trusted shops

72. EXTRACTED MODULES | WHY?
STREAMLINE ESHOP CORE
Remove hard dependencies on non-essentials items
Update extracted modules on-demand
No need to wait for eShop update

73. BACKWARDS
COMPATIBILITY

74. BC | WHAT?
Besides extracted code into modules
There are no more BC breaks for existing modules!

75. BC | WHY?
BECAUSE WE DO CARE!

76. NOTES

77. VM
Our VM has been updated to work with V6 out-of-the-box
PHP upgraded to 5.6
For 5.3 version - few notes in readme

78. DOCUMENTATION
Short link:
http://oxid-eshop-developer-
documentation.readthedocs.io/en/latest/
http://tinyurl.com/oxid-dev-doc

79. SUMMARY

80. SUMMARY
New requirements
Composer integration
Compilation
Namespaces
Class names, classmap, usage in modules
Database changes
Doctrine, InnoDB, Migrations, MySQL 5.7
Extracted Modules
Backwards compatibility
VM & Documentation

81. DETAILED TALKS

82. DETAILED TALKS
Composer role in OXID eShop 6.0
Mantas Vaitkūnas (EN)
Update to eShop 6.0 - What do I have to watch out for?
Gregor Hyneck (DE/EN)
The new database handling in OXID eShop v6.0
Robert Blank (DE/EN)

83. ONE MORE THING...

85. DOCKER | WHAT?
PROTOTYPE
Each component has it's own container
Majority being from original vendors
Each tool can be used as an ad-hoc command
OXID eShop as data volume
Download existing/configured eShop

86. DOCKER | WHY?
MANY REASONS...
Small footprint
Blazing fast!
Developer friendly
Docker for Mac
Docker for Windows
Ability to use Cloud services
Mobility
Helps to automate things
...

87. DOCKER | WHEN? WHERE?
December
Blog post
New github repositories

88. DOCKER | DEMO

89. QUESTIONS?

90. THANK YOU!