PHPackages endereco/endereco-oxid6-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. endereco/endereco-oxid6-client ActiveOxideshop-module[API Development](/categories/api) endereco/endereco-oxid6-client ============================== 4.6.0(2mo ago)114.9k↓63.3%8[6 issues](https://github.com/Endereco/endereco-oxid6-client/issues)[2 PRs](https://github.com/Endereco/endereco-oxid6-client/pulls)GPL-3.0-onlyPHPPHP >=5.6CI failing Since Jul 22Pushed 1mo ago4 watchersCompare [ Source](https://github.com/Endereco/endereco-oxid6-client)[ Packagist](https://packagist.org/packages/endereco/endereco-oxid6-client)[ RSS](/packages/endereco-endereco-oxid6-client/feed)WikiDiscussions master Synced 2d ago READMEChangelog (10)Dependencies (15)Versions (50)Used By (0) Endereco Implementation for OXID 6 ================================== [](#endereco-implementation-for-oxid-6) Contributing ------------ [](#contributing) For information on how to contribute to this project, please see our [Contributing Guidelines](CONTRIBUTING.md). Installation ------------ [](#installation) The installation is done in the following steps: 1. **Install the module via Composer** ``` composer require endereco/endereco-oxid6-client ``` This command downloads the latest version. To install a specific version, for example *4.5.2*, the command can be adjusted as follows: ``` composer require endereco/endereco-oxid6-client:4.5.2 ``` 2. **Run migrations (optional)** By default, the Endereco-Oxid6 module automatically executes necessary database changes after activation. All adjustments are located in the [Installer file](./Installer/Installer.php) in the *onActivate* method. However, if you have at least version 6.2.3 of the shop and want to execute database changes via migrations, you can disable the default database adjustments. For this, the following code must be added to the shop's *config.inc.php* file: ``` $this->bEnderecoUseMigrations = true; ``` From now on, the entire code block in *onActivate* will no longer be executed. After reinstalling the Endereco-Oxid6 module, as well as after each module update, migrations should be checked and possibly applied: ``` vendor/bin/oe-eshop-db_migrate migrations:migrate ``` [See documentation for migrations in OXID 6](https://docs.oxid-esales.com/developer/en/6.2/development/tell_me_about/migrations.html#module-migrations) 3. **Activate the module** In OXID admin panel: Extensions → Modules → Endereco → Activate Development Setup ----------------- [](#development-setup) ### Prerequisites [](#prerequisites) - PHP 5.6 or higher - Composer - OXID eShop 6.1+ installation - Nodejs and npm - Git ### Setting up the Development Environment [](#setting-up-the-development-environment) **Important:** Before setting up the development environment, make sure the module is properly installed via Composer first (see Installation section above). This ensures all autoload paths are registered correctly. 1. **Fork and Clone the Repository** ``` git clone https://github.com/your-username/endereco-oxid6-client.git cd endereco-oxid6-client ``` 2. **Install Development Dependencies** ``` composer install npm install ``` 3. **Set up Git Hooks** (automatically runs quality checks before commits) ``` composer post-install-cmd ``` 4. **Link Module to OXID Shop** **Note:** The module must be installed properly first via `composer require endereco/endereco-oxid6-client` so that all paths are registered in the composer autoload. After proper installation, create a symlink from your OXID shop's modules directory to your development directory: ``` ln -s /path/to/your/endereco-oxid6-client /path/to/oxid/source/modules/endereco/endereco-oxid6-client ``` 5. **Activate the Module** In OXID admin panel: Extensions → Modules → Endereco → Activate ### Development Workflow [](#development-workflow) 1. **Build Endereco Bundle** ``` npm run build # Build the Endereco bundle ``` 2. **Run Quality Checks** ``` composer qa # Run all checks composer phpcs # Code style check only composer phpcbf # Auto-fix code style issues ``` 3. **Testing with Multiple OXID Versions** The project includes PHPStan configurations for different OXID versions: - `phpstan.6.1.neon` - OXID 6.1 - `phpstan.6.2.neon` - OXID 6.2 - `phpstan.6.3.neon` - OXID 6.3 - `phpstan.6.4.neon` - OXID 6.4 - `phpstan.6.5.neon` - OXID 6.5 4. **Before Committing** Ensure all quality checks pass: ``` composer qa ``` Testing ------- [](#testing) Test the module with different OXID 6 versions using: ``` ./playground.sh ``` The script will prompt for the following options: - **OXID version** — `6.3`, `6.4`, or `6.5` - **XDebug** — enable step debugging on port 9003 (IDE must be in listen mode) - **Migration mode** — test the `bEnderecoUseMigrations = true` code path instead of the default `onActivate`-based DB setup - **Force rebuild** — discard the cached Docker image and rebuild from scratch The container starts on **port 80**. If the port is already in use, the script offers to stop the blocking container or choose an alternative port (81–89 or 8080–8089). On first start the OXID shop is set up automatically (schema import, demo data, module activation). The shop shows a 500 error during setup — reload after a moment. Log in to the OXID admin panel at `http://localhost/admin` with: ``` E-Mail: admin@example.com Password: admin ``` In the admin panel, navigate to **Extensions → Modules → Endereco** and open the module configuration to enter a valid API key. You can request a test API key at [endereco.de](https://endereco.de). To stop the environment: ``` docker rm -f oxid-{version} oxid-{version}-db && docker network rm oxid-{version}-net ``` Scripts and Utilities --------------------- [](#scripts-and-utilities) This repository includes several shell scripts to assist with development and testing. ### Shell Scripts [](#shell-scripts) #### `playground.sh` [](#playgroundsh) Launches an interactive OXID 6 development environment in Docker. Builds a Docker image with the selected OXID version (6.3, 6.4, or 6.5) and the module volume-mounted for live development. Handles port conflicts, optional XDebug setup, optional migration mode, and full auto-setup on first start. ``` ./playground.sh ``` Access the shop at `http://localhost/` and the admin panel at `http://localhost/admin` with credentials `admin@example.com` / `admin`. #### `fetch_shops.sh` [](#fetch_shopssh) Downloads OXID shop installations (6.1–6.5) into the `shops/` directory using Docker. These local shop copies provide the class stubs that PHPStan needs to analyse the module against each OXID version. Run this once after cloning or whenever you need to refresh the shops. Requires Docker. ``` ./fetch_shops.sh ``` #### `check_phpmd.sh` [](#check_phpmdsh) Runs PHP Mess Detector on all project PHP files, excluding `vendor/`, `shops/`, and `node_modules/`. Called automatically by `composer phpmd` and as part of `composer qa`. ``` ./check_phpmd.sh ``` #### `test_php_versions.sh` [](#test_php_versionssh) Checks PHP syntax compatibility by running `php -l` against PHP 7.0–8.1 using Docker images. Called automatically by `composer phpcompat` and as part of `composer qa`. Requires Docker. ``` bash test_php_versions.sh ``` ### Health Score 48 — FairBetter than 93% of packages Maintenance69 Regular maintenance activity Popularity29 Limited adoption so far Community23 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~62 days Recently: every ~15 days Total 35 Last Release 61d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/dd40bfba73c3fcc1fd964bf977e70fcf387a9c7983a81d39b998133384a03344?d=identicon)[iljaweber](/maintainers/iljaweber) ![](https://www.gravatar.com/avatar/af87131eaaacf7fbf818c92b44fc0b9c021b4308a764c4677a61565d93847ee9?d=identicon)[iljamobilemojo](/maintainers/iljamobilemojo) ![](https://www.gravatar.com/avatar/f568827d13d58732bb8aab80067fd50017543b86e70a2682eb33f0eeaf6e60c9?d=identicon)[endereco](/maintainers/endereco) ![](https://www.gravatar.com/avatar/4295442fa4a66d71132fc57813370dea9f260dd3e44e336493ae62a8b0946adf?d=identicon)[enderecoFlorian](/maintainers/enderecoFlorian) --- Top Contributors [![iljamobilemojo](https://avatars.githubusercontent.com/u/47107206?v=4)](https://github.com/iljamobilemojo "iljamobilemojo (34 commits)")[![iwebercodes](https://avatars.githubusercontent.com/u/20324995?v=4)](https://github.com/iwebercodes "iwebercodes (34 commits)")[![enderecoFlorian](https://avatars.githubusercontent.com/u/79191747?v=4)](https://github.com/enderecoFlorian "enderecoFlorian (5 commits)")[![pm-ecommlab](https://avatars.githubusercontent.com/u/97977272?v=4)](https://github.com/pm-ecommlab "pm-ecommlab (4 commits)")[![cgsmith](https://avatars.githubusercontent.com/u/570018?v=4)](https://github.com/cgsmith "cgsmith (1 commits)")[![TumTum](https://avatars.githubusercontent.com/u/225997?v=4)](https://github.com/TumTum "TumTum (1 commits)")[![Endereco](https://avatars.githubusercontent.com/u/48090681?v=4)](https://github.com/Endereco "Endereco (1 commits)")[![MichaNdrc](https://avatars.githubusercontent.com/u/256759278?v=4)](https://github.com/MichaNdrc "MichaNdrc (1 commits)")[![tbischoffseidemannweb](https://avatars.githubusercontent.com/u/172749361?v=4)](https://github.com/tbischoffseidemannweb "tbischoffseidemannweb (1 commits)") ### Code Quality Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/endereco-endereco-oxid6-client/health.svg) ``` [![Health](https://phpackages.com/badges/endereco-endereco-oxid6-client/health.svg)](https://phpackages.com/packages/endereco-endereco-oxid6-client) ``` ### Alternatives [statamic/cms The Statamic CMS Core Package 4.8k3.6M986](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai The PHP Agentic Framework. 2.0k656.1k38](/packages/neuron-core-neuron-ai)[eslazarev/wildberries-sdk Wildberries OpenAPI clients (generated). 273.0k](/packages/eslazarev-wildberries-sdk)[avalara/avataxclient Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API. 528.5M7](/packages/avalara-avataxclient)[files.com/files-php-sdk Files.com PHP SDK 2481.1k](/packages/filescom-files-php-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)