Twig Template Engine Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require memio/twig-template-engine
   

   Register the service provider in config/app.php:

   'providers' => [
       Memio\TwigTemplateEngine\TwigTemplateEngineServiceProvider::class,
   ],
   

2. Basic Usage Define a Twig template in resources/views/emails/welcome.twig:

   <h1>Hello, {{ name }}!</h1>
   

   Render it in a Laravel controller:

   use Memio\TwigTemplateEngine\Facades\Twig;
   
   $content = Twig::render('emails.welcome', ['name' => 'John']);
   

3. First Use Case Replace Blade templates for dynamic email generation:

   $email = new \Illuminate\Mail\Message;
   $email->subject('Welcome!');
   $email->markdown('emails.welcome', ['name' => $user->name]); // Replace with Twig
   $email->twig('emails.welcome', ['name' => $user->name]); // New method
   

Implementation Patterns

Workflows

1. Template Inheritance Extend base layouts in Twig:

   {% extends 'layouts.app.twig' %}
   {% block content %}
       <p>Custom content</p>
   {% endblock %}
   

2. Dynamic Template Resolution Use Laravel’s view resolution with Twig:

   $template = Twig::resolve('emails.' . $type . '.twig');
   $content = Twig::render($template, $data);
   

3. Integration with Laravel Components Combine Twig with Livewire/Inertia:

   <div x-data="{ open: false }">
       {{ include('partials.modal.twig', { title: 'Alert' }) }}
   </div>
   

Best Practices

• Cache Compilation Enable Twig cache for production:

  Twig::setCacheDir(storage_path('framework/views'));
  

• Reusable Macros Define Twig extensions for shared logic:

  Twig::addExtension(new \Memio\TwigTemplateEngine\Extensions\CustomExtension());
  

Gotchas and Tips

Pitfalls

1. Namespace Conflicts Avoid naming Twig files identical to Blade files (e.g., welcome.blade.php vs. welcome.twig). Fix: Use explicit extensions in config/view.php:

   'paths' => [
       resource_path('views'),
   ],
   'extensions' => ['php', 'twig'], // Ensure Twig is last
   

2. Autoloading Issues If Twig templates aren’t found, verify:

   • The views directory is in config/view.php.
   • The TwigTemplateEngineServiceProvider is registered.

3. Performance Overhead Twig’s flexibility adds slight runtime cost. Profile with:

   php artisan twig:cache:clear
   

Debugging

• Enable Twig Debug Mode

  Twig::setDebug(true); // In development only
  

• Check Compiled Templates Inspect cached files in storage/framework/views for errors.

Extension Points

1. Custom Filters Register a Twig filter for Laravel-specific logic:

   Twig::addFilter(new \Twig\TwigFilter('laravel_route', function ($name, $params = []) {
       return route($name, $params);
   }));
   

2. Override Default Loader For non-standard template paths:

   Twig::setLoader(new \Twig\Loader\FilesystemLoader([
       base_path('custom-templates'),
   ]));
   

3. Integrate with Laravel Mix Process Twig templates during asset compilation:

   mix.twig(); // Hypothetical; check package docs for actual API