PayPal Checkout for OXID

PayPal checkout integration for OXID eShop 6.1 and above.

Documentation

• Official German PayPal Checkout for OXID 6.1 to 6.2 documentation
• Official German PayPal Checkout for OXID 6.3 to 6.5 documentation
• Official German PayPal Checkout for OXID from 7.0 documentation
• Official English PayPal Checkout for OXID 6.1 to 6.2 documentation
• Official English PayPal Checkout for OXID 6.3 to 6.5 documentation
• Official English PayPal Checkout for OXID from 7.0 documentation

Technical documentation in this repository: docs/README.md - architecture, payment flows, order states, webhook system, UML diagrams and troubleshooting.

Branch Compatibility

• b-7.0.x module branch is compatible with OXID eShop compilation 7.0, 7.1, 7.2, 7.3, 7.4
• b-6.3.x module branch is compatible with OXID eShop compilation 6.3, 6.4, 6.5
• b-6.1.x module branch is compatible with OXID eShop compilation 6.1, 6.2

Install for OXID

• see Official documentation

Limitations

• no limitations

Merging Strategy

• The b-6.3.x branch is compatible with OXID6.3 to 6.5 and will not be merged automatically into the b-7.0.x branch
• if something changes in the b-6.3.x main branch, it must be ported to the b-7.0.x branch

Running tests

Warning: Running tests will reset the shop.

Requirements

• Ensure test_config.yml is configured:

  partial_module_paths: osc/paypal
  

  activate_all_modules: true
  run_tests_for_shop: false
  run_tests_for_modules: true
  

Run

Running phpunit tests:

vendor/bin/runtests

Running phpunit tests with coverage reports (report is generated in .../paypal/Tests/reports/ directory):

XDEBUG_MODE=coverage vendor/bin/runtests-coverage

CodeStyle commands

The following Composer commands are available for checking and maintaining code quality:

PHP Mess Detector (PHPMD)

• composer md - Run PHPMD checks on locally modified files
• composer md:commit - Run PHPMD checks on files changed in the last commit

PHPStan

• composer stan - Run static analysis checks on locally modified files
• composer stan:commit - Run static analysis checks on files changed in the last commit

PHP CodeSniffer (PHPCS)

• composer cs - Run coding standards checks on locally modified files
• composer cs:commit - Run coding standards checks on files changed in the last commit

Combined Checks

• composer style - Run all code quality checks (PHPMD, PHPStan, and PHPCS) on locally modified files
• composer style:commit - Run all code quality checks on files changed in the last commit

Each command has two variants:

• Default version checks files that have local modifications but haven't been committed
• :commit suffix version checks only the files that were changed in the most recent commit

These commands help maintain consistent code quality by checking:

• Code style and formatting (PHPCS)
• Potential problems and complexity issues (PHPMD)
• Type safety and potential bugs (PHPStan)