How isotope/core works
Project type and purpose
• This is an extension bundle for the Contao CMS, providing a full-fledged e-commerce solution (“Isotope eCommerce”) plus two add-on modules (“Isotope Reports” for analytics and “Isotope Rules” for pricing/promotions).
• It delivers both frontend storefront functionality (shopping cart, checkout steps, product lists) and backend administration (product management, orders, customers, configuration).
File structure
• Top-level: build scripts (composer.json, gulpfile.js, build.xml), project metadata.
• “system/modules/isotope”: the core extension, subdivided into:
• assets (JS/CSS/plugins)
• config (DI services.yaml, currencies, autoload)
• dca (Contao’s Data Container Arrays → metadata for backend forms)
• library (PHP namespaces for Controllers, Models, EventListeners, Services, Widgets)
• templates (HTML5 templates for frontend modules, backend overview pages)
• “system/modules/isotope_reports” and “system/modules/isotope_rules”: same pattern—assets, config, dca, library, templates.
• Supports DI (services.yaml, rector.php), event system, MVC, Contao’s module & DCA architecture.
README (docs/README.md)
• Likely describes system requirements, installation steps, high-level architecture: Contao core hooks into the extension via Contao Manager plugin, routes requests to Isotope’s controllers and templates.
Main components
a. Contao CMS core (HTTP kernel, Contao Manager, routing, DCA engine)
b. Isotope extension (split into sub‐components):
• Frontend controllers & modules (CheckoutStep, ContentElement, Module classes)
• Backend modules & DCA (BackendModule, Data Container Arrays, Callback classes)
• Core services (DependencyInjection, EventListeners, Automator, Analytics)
• Domain models & repositories (Isotope\Model\*, request cache, collections)
• Templates & assets (JS/CSS/plugins)
c. -ons:
• Reports module (Graphing libraries: d3, ApexCharts; Report services)
• Rules module (Pricing/discount model, rule engine)
d. Database (MySQL): stores product, order, customer, pricing, rule, report data
e. External services:
• Payment providers (Paypal, Stripe, others via Model\Payment\*)
• Shipping providers (flat rate, DHLBusiness, custom shipping Model\Shipping\*)
• Google Analytics (UnitedPrototype library)
Relationships and data flow
• Client (browser) → HTTP request → Contao kernel → routes to:
• Frontend page request → Isotope frontend Module/Controller → Services → Models → DB → Templates → back to client
• Backend request → Contao backend → Isotope BackendModule → DCA callbacks → Services → DB → backend templates
• Checkout workflow: front‐controller triggers CheckoutStep sequence → writes to ProductCollection (cart/order) → persists to DB → Payment service → external payment API callback (PostsaleController) → final update
• Rules engine invoked during price calculation (Model\ProductCollectionSurcharge → Rules module)
• Reports query data (via Report services) and feed charts (apexcharts, d3)
Architectural patterns and design principles
• MVC: Controllers (Isotope\Controller, Module classes) → Models (Isotope\Model\*) → Views (templates)
• Dependency Injection & service container (services.yaml, Compiler passes)
• Event-driven: EventListeners subscribe to price calculations, language changes, post-checkout tasks
• Modular design: core + optional sub-modules (reports, rules)
• Hook/callback extensibility (Contao DCA callbacks, ServiceAnnotation for hooks)
Elements
• HTTP request flow (browser → Contao → Isotope → DB → browser)
• Data persistence (controllers → models → DB)
• Events/callbacks (price calculation → rule engine)
• External API calls (payment/shipping/analytics)
• Gray for Contao core
• Blue for Isotope core
• Green for Reports add-on
• Orange for Rules add-on
• Red for external services
• Controllers (rectangles)
• Services and listeners (rounded rectangles)
• Models/repositories (parallelograms)
• Templates/assets (documents)
Summary
• Contao → Isotope core → DB → external dependencies
• Drill down into sub-components of the Isotope core (frontend vs. backend vs. services vs. models)
• Modular add-ons (reports, rules)
• Critical architectural elements (DI, event system, MVC layers, external integrations) are present to guide both design reviews and future enhancements.