Custom Entity Bundle Laravel Package

Technical Evaluation

Architecture Fit

• PIM-Centric Design: The bundle is tightly coupled with Akeneo PIM’s architecture, leveraging its reference data model (e.g., AbstractCustomEntity) and CRUD patterns (datagrids, form extensions). This aligns well with Akeneo’s modular, entity-driven approach but limits portability to non-Akeneo PHP/Laravel ecosystems.
• Symfony-Dependent: Built for Symfony 3/4, with Doctrine ORM and YAML-based configurations (e.g., menu.yml, datagrid.yml). While Laravel supports Symfony components (e.g., via symfony/console), full compatibility requires bridging gaps (e.g., Doctrine → Eloquent, YAML → PHP arrays).
• Akeneo-Specific Abstractions: Uses Akeneo’s batch jobs, form extensions, and menu system, which do not exist in Laravel. A TPM would need to abstract or replace these with Laravel equivalents (e.g., Laravel Nova for CRUD, Laravel Mix for assets).

Integration Feasibility

• Core Features:
  • Custom Entity CRUD: Feasible with Laravel Eloquent + Nova/Livewire for UI.
  • Reference Data as Attributes: Possible via Akeneo’s API (if using PIM) or custom Laravel relationships.
  • Datagrids/Filters: Replaceable with Laravel Scout (search) + custom table builders (e.g., Laravel DataTables).
• Challenges:
  • Akeneo’s Batch Jobs: No direct Laravel equivalent. Would require custom queue workers (e.g., Laravel Queues).
  • Form Extensions: Akeneo uses Symfony Form Component; Laravel would need custom form builders (e.g., Livewire).
  • Menu System: Akeneo’s Twig-based menus would need replacement with Laravel Blade or Inertia.js.

Technical Risk

Key Questions for the TPM

1. Is Akeneo PIM a Hard Dependency?
   • If yes, integration is limited to Akeneo ecosystems (e.g., PIM + Laravel backend).
   • If no, rewrite core abstractions (e.g., replace AbstractCustomEntity with Laravel models).
2. What’s the UI Strategy?
   • Use Laravel Nova for admin panels or Livewire for custom CRUD?
   • Replace Akeneo’s Twig templates with Blade/Inertia?
3. How to Handle Batch Jobs?
   • Replace Akeneo’s batch jobs with Laravel Queues + Jobs.
4. Performance Implications
   • Akeneo’s datagrids are optimized for PIM; Laravel alternatives (e.g., DataTables) may need tuning.
5. Long-Term Maintenance
   • Akeneo’s last release was 2020—will the bundle stay compatible with newer PIM versions?

Integration Approach

Stack Fit

Migration Path

1. Phase 1: Abstraction Layer
   • Create adapters to translate Akeneo-specific logic (e.g., CustomEntityAdapter for Eloquent).
   • Example:

     // Akeneo: AbstractCustomEntity
     // Laravel: CustomEntity extends Model
     class CustomEntity extends Model {
         use HasUuids; // Akeneo uses UUIDs; Laravel can adopt this.
     }
     

2. Phase 2: Configuration Migration
   • Convert YAML configs to PHP:

     # Akeneo: menu.yml
     extensions:
         acme-menu-supplier:
             module: pim/menu/item
     

     // Laravel: config/menu.php
     return [
         'supplier' => [
             'title' => 'Supplier',
             'route' => 'suppliers.index',
         ],
     ];
     

3. Phase 3: UI Replacement
   • Replace Akeneo’s form extensions with Livewire components:

     // Livewire CRUD for CustomEntity
     class SupplierManager extends Component {
         public function create() { ... }
         public function update() { ... }
     }
     

4. Phase 4: Batch Jobs → Queues
   • Replace Akeneo’s csv_reference_data_quick_export with a Laravel Job:

     class ExportReferenceData implements ShouldQueue {
         public function handle() {
             // Use Laravel Excel or custom CSV logic
         }
     }
     

5. Phase 5: Testing
   • Replace Akeneo’s PHPUnit setup with Laravel’s:

     composer require pestphp/pest --dev
     ./vendor/bin/pest
     

Compatibility

• High Compatibility:
  • Doctrine/Eloquent: Both support ORM features (relationships, events).
  • Symfony Components: Laravel can use symfony/console, symfony/yaml, etc.
• Low Compatibility:
  • Akeneo’s Menu System: No direct Laravel equivalent; requires custom solution.
  • Batch Jobs: Laravel Queues are similar but not identical.
  • Form Extensions: Akeneo’s system is tightly coupled with Symfony Form; Livewire is the closest alternative.

Sequencing

1. Step 1: Core Model Migration
   • Replace AbstractCustomEntity with Eloquent models.
   • Example:

     // app/Models/CustomEntity.php
     namespace App\Models;
     use Illuminate\Database\Eloquent\Model;
     class CustomEntity extends Model {
         protected $fillable = ['code', 'name'];
     }
     

2. Step 2: Configuration Overhaul
   • Convert all YAML configs to PHP/Laravel format.
3. Step 3: UI Layer
   • Build Livewire/Nova components for CRUD.
4. Step 4: Batch Jobs
   • Replace Akeneo jobs with Laravel Queues.
5. Step 5: API Integration
   • If using Akeneo PIM, create Laravel services to interact with its API.
6. Step 6: Testing & Optimization
   • Write PestPHP tests; optimize datagrids with Laravel Scout.

Operational Impact

Maintenance

• Pros:
  • Laravel’s Ecosystem: Mature tooling (Nova, Livewire, Forge) reduces maintenance overhead.
  • PHP Configs: Easier to manage than YAML in large teams.
• Cons:
  • Akeneo Dependency: If tied to PIM, updates may require rework.
  • Custom Abstractions: Adapters (e.g., CustomEntityAdapter) add complexity.
• Mitigation:
  • Document Akeneo ↔ Laravel mapping in a decision record.
  • Use feature flags for gradual migration.

Support

• Akeneo-Specific Issues:
  • Limited community support for Laravel integrations.
  • Debugging may require Akeneo devs if core logic is reused.
• Laravel-Specific Issues:
  • Leverage Laravel Forge,