Aimeos Base Laravel Package

Getting Started

The aimeos/aimeos-base package serves as the foundational abstraction layer for the Aimeos e-commerce platform — it defines core interfaces, utilities, and base classes but does not include a full application by itself. To begin:

• First, install the full Aimeos Laravel package (aimeos/aimeos-laravel) instead — aimeos-base is a transitive dependency and not meant for direct use.
• If you are building a custom Aimeos integration (e.g., on Symfony, custom framework, or CLI), read the Aimeos Core Documentation and examine the interfaces in src/Aimeos/ (e.g., Context, Controller, MShop).
• Your first use case will likely involve implementing or consuming services that depend on Aimeos\Base\Context\Iface or Aimeos\MShop\Locale\Item\Language\Iface.

Implementation Patterns

• Context-driven architecture: Everything in Aimeos starts with a Context object. You’ll often pass this through controllers, jobs, or CLI commands to access configuration, database connections, caches, and logger.
• Service Provider pattern: If building a host app, register Aimeos services (e.g., Aimeos\Shop\Shop) via your DI container, injecting the Context with your app’s auth, DB, and config.
• MShop (Master Shop) layer: All business logic (products, orders, customers) lives under Aimeos\MShop. Use the factory Aimeos\MShop\Factory::create() to get repositories and operate on domain objects.
• Controller patterns: Standard controllers (e.g., for checkout, product lists) extend Aimeos\Controller\Jobs\Common\Base — you can customize behavior by decorating or extending these.
• Testing: Mock Context\Iface and use factory abstractions to unit-test domain logic without DB overhead.

Gotchas and Tips

• No direct autowiring in Laravel: You’ll get resolution errors if trying to type-hint Context directly. Instead, inject Aimeos\Shop\Base\Context (Laravel-specific) or use a custom factory/service that constructs the context manually.
• NOASSERTION license: Verify license compatibility — aimeos/aimeos-base is part of the broader Aimeos suite, which is LGPL-3.0+. NOASSERTION here is likely a metadata artifact; always check composer.json in the full repo or use composer show -i.
• Environment mismatch: Aimeos expects strict PSR-3/11/17/15 compliance. If your host app uses older Symfony DI or custom logging, wrap it using Aimeos\Base\Stdlib\Logger and PSR adapters.
• Cache key collisions: When sharing caches (e.g., Redis), use config('aimeos.cache.prefix') — forgetting this may cause product data to leak between environments.
• Extensibility points: Override core items via Aimeos\MShop\Factory::createManager()’s manager/name configuration, or extend controllers with Aimeos\Controller\Jobs\Common\Decorator\Base.