oxid-solution-catalysts/paypal-module

OXID eSales PayPal payment module for OXID

v3.3.5-rc.3 2024-04-16 10:52 UTC

Requires

• php: >=8.0
• giggsey/libphonenumber-for-php: ^8.12
• oxid-solution-catalysts/paypal-client: v3.0.10
• viison/address-splitter: ^0.3.4
• webmozart/path-util: ^2.3.0

Requires (Dev)

• codeception/module-db: ^3.0.0
• codeception/module-phpbrowser: ^3.0.0
• codeception/module-rest: ^3.3.0
• oxid-esales/oxideshop-ce: dev-b-7.0.x
• phpmd/phpmd: ^2.11
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.1.1
• squizlabs/php_codesniffer: 3.*
• symfony/dotenv: ^5.1

GPL-3.0

• payment
• modules
• paypal
• eshop
• OXID

README

PayPal checkout integration for OXID eShop 6.1 and above.

Documentation

• Official German PayPal checkout for OXID documentation.
• Official English PayPal checkout for OXID documentation.

Branch Compatibility

• 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.1.x branch is compatible with OXID6.1 and will not be merged into the b-6.3.x branch
• if something changes in the b-6.3.x main branch, it must be ported to the b-6.1.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
  

• For codeception tests to be running, selenium server should be available, several options to solve this:
  • Use OXID official vagrant box environment.
  • Use OXID official docker sdk configuration.
  • Use other preconfigured containers, example: image: 'selenium/standalone-chrome-debug:3.141.59'

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

Running codeception tests default way (Host: selenium, browser: chrome): in OXID 6.2 and above:

vendor/bin/runtests-codeception

in OXID 6.1:

vendor/bin/runtests-selenium

Running codeception tests example with specific host/browser/testgroup: in OXID 6.2 and above:

SELENIUM_SERVER_HOST=seleniumchrome BROWSER_NAME=chrome vendor/bin/runtests-codeception --group=examplegroup

in OXID 6.1:

SELENIUM_SERVER_HOST=seleniumchrome BROWSER_NAME=chrome vendor/bin/runtests-selenium --group=examplegroup