News Bundle Laravel Package

Technical Evaluation

Architecture Fit

• Contao-Specific Constraints: The news-bundle is tightly coupled with Contao CMS, which uses Doctrine 1.x, Smarty templating, and a legacy DCA (Data Container API) system. Laravel’s Eloquent ORM, Blade templating, and resource-based admin (e.g., Nova/Livewire) introduce fundamental architectural mismatches.

  • Key Misalignment:
    • Contao’s tl_* database tables (e.g., tl_news, tl_news_archive) are schema-first with no migrations, conflicting with Laravel’s migration-first approach.
    • Admin UI: Contao’s backend is monolithic (PHP classes + JavaScript), while Laravel prefers modular admin solutions (Nova, Filament, or Livewire).
    • Routing: Contao’s annotation-based routing (@Route) differs from Laravel’s declarative routes.
  • Opportunity: If the goal is to migrate Contao news functionality to Laravel, this bundle can serve as a reference for business logic (e.g., archiving, categorization) but requires complete rewrites of Contao-specific layers.

• Laravel Integration Points:

  • Symfony Compatibility: The bundle uses Symfony components (e.g., HttpKernel, DependencyInjection), which are natively supported in Laravel but require manual configuration (e.g., service providers).
  • Doctrine DBAL: Laravel’s Eloquent can replace Doctrine 1.x for database interactions, but schema migrations must be rewritten.
  • Templating: Smarty templates would need replacement with Blade/Twig or a custom adapter.

Integration Feasibility

• Direct Integration: Not feasible without significant refactoring. The bundle assumes:
  • Contao’s Contao\CoreBundle and Contao\ManagerPlugin systems.
  • Legacy Contao tables (tl_news, tl_news_archive) with hardcoded queries.
  • Smarty templating in frontend modules.
• Workarounds:
  1. Feature Extraction:
     • Port business logic (e.g., news CRUD, archiving) to Laravel Eloquent models.
     • Replace Contao’s DCA admin UI with Livewire/Nova.
     • Rewrite Smarty templates as Blade views.
  2. API Wrapper:
     • Deploy Contao separately and expose news via Laravel Sanctum/Passport API.
     • Use Laravel as a frontend consuming Contao’s data.
  3. Hybrid Approach:
     • Use Contao for editor workflows and Laravel for frontend/API layers.
     • Sync data via database replication or event listeners.

Technical Risk

Key Questions

1. Business Goals:

   • Is the objective to extend Contao’s news in Laravel (hybrid) or fully replace Contao’s news system?
   • Are there non-negotiable Contao features (e.g., multi-language editing, specific workflows) that must be preserved?

2. Technical Scope:

   • Which Contao news features are critical? (e.g., RSS feeds, archiving, user permissions).
   • Should third-party Contao extensions (e.g., contao/calendar-bundle) also be integrated?

3. Migration Strategy:

   • Is a big-bang rewrite feasible, or should we incrementally replace Contao news with Laravel components?
   • Should we vendor the bundle (embed as Composer dependency) or host it separately (microservice)?

4. Team Constraints:

   • Does the team have Contao expertise (e.g., DCA, tl_* tables) or Laravel admin UI experience (Livewire/Nova)?
   • Is there budget for a rewrite, or should we leverage the bundle as a reference?

5. Alternatives:

   • Would a Laravel-native news package (e.g., Backpack News, Orchid Platform) reduce risk?
   • Could headless Contao (via API) + Laravel frontend avoid this integration entirely?

Integration Approach

Stack Fit

Migration Path

Option 1: Feature Extraction (Recommended for Greenfield)

1. Audit Contao Dependencies:

   • Identify core news logic (e.g., NewsModel, ArchiveModel) vs. Contao-specific helpers.
   • Example: Extract getPublishedNews() from Contao\NewsBundle\Model\NewsModel to a Laravel service.

2. Rebuild Database Schema:

   • Create Laravel migrations for tl_news and tl_news_archive:

     php artisan make:migration create_news_tables
     

   • Example migration:

     Schema::create('news', function (Blueprint $table) {
         $table->id();
         $table->string('title');
         $table->text('teaser')->nullable();
         $table->text('content');
         $table->boolean('published')->default(false);
         $table->timestamps();
     });
     

3. Replace Templating:

   • Convert Smarty templates (e.g., news_list.html5) to Blade:

     <!-- resources/views/news/list.blade.php -->
     @foreach($newsItems as $news)
         <article>
             <h2>{{ $news->title }}</h2>
             <div>{!! $news->content !!}</div>
         </article>
     @endforeach
     

   • Use View Composers to replicate Contao’s dynamic logic.

4. Admin UI Rebuild:

   • Replace Contao’s DCA with Livewire:

     // app/Livewire/NewsManager.php
     public function updateNews($id, array $data)
     {
         $news = News::findOrFail($id);
         $news->update($data);
     }
     

   • Or use Nova for a pre-built admin panel:

     // app/Nova/News.php
     public static $title = 'title';
     public static $search = ['title', 'content'];
     

5. Routing:

   • Replace Contao’s routes:

     // routes/web.php
     Route::get('/news/{id}', [NewsController::class, 'show']);
     Route::get('/news', [NewsController::class, 'index'])->name('news.index');
     

6. Testing:

   • Write PestPHP tests for business logic:

     test('news can be published', function () {