Download the PHP package endereco/endereco-oxid6-client without Composer

On this page you can find all versions of the php package endereco/endereco-oxid6-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package endereco-oxid6-client

Endereco Implementation for OXID 6

Contributing

For information on how to contribute to this project, please see our Contributing Guidelines.

Installation

The installation is done in the following steps:

  1. Install the module via Composer

    This command downloads the latest version. To install a specific version, for example 4.5.2, the command can be adjusted as follows:

  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 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:

    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:

    See documentation for migrations in OXID 6

  3. Activate the module

    In OXID admin panel: Extensions → Modules → Endereco → Activate

Development Setup

Prerequisites

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

  2. Install Development Dependencies

  3. Set up Git Hooks (automatically runs quality checks before commits)

  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:

  5. Activate the Module

    In OXID admin panel: Extensions → Modules → Endereco → Activate

Development Workflow

  1. Build Endereco Bundle

  2. Run Quality Checks

  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:

Testing

Test the module with different OXID 6 versions using:

The script will prompt for the following options:

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:

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.

To stop the environment:

Scripts and Utilities

This repository includes several shell scripts to assist with development and testing.

Shell Scripts

playground.sh

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.

Access the shop at http://localhost/ and the admin panel at http://localhost/admin with credentials [email protected] / admin.

fetch_shops.sh

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.

check_phpmd.sh

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.

test_php_versions.sh

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.


All versions of endereco-oxid6-client with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
ext-curl Version *
guzzlehttp/guzzle Version ^6.3|^7.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package endereco/endereco-oxid6-client contains the following files

Loading the files please wait ...