Domainator9K Apptype Drupaleight Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle via Composer in your Laravel project (note: this is a Symfony bundle, so use a bridge like symfony-bundle-to-laravel or integrate via a Symfony microkernel if needed):

   composer require district09/domainator9k-apptype-drupaleight-bundle
   

   Register the bundle in config/app.php (Symfony-style) or adapt via Laravel's service provider.

2. Configuration Publish the bundle's config:

   php artisan vendor:publish --provider="District09\Domainator9kApptypeDrupal8Bundle\Domainator9kApptypeDrupal8Bundle"
   

   Edit config/domainator9k-apptype-drupal8.php to define Drupal 8 app connections (e.g., API endpoints, credentials).

3. First Use Case Fetch Drupal 8 content via a Laravel service:

   use District09\Domainator9kApptypeDrupal8Bundle\Service\Drupal8Service;
   
   $drupalService = app(Drupal8Service::class);
   $nodes = $drupalService->getNodes(['type' => 'article']); // Example: Fetch articles
   

Implementation Patterns

Workflows

1. Data Synchronization Use the bundle to sync Drupal 8 content (nodes, users, taxonomies) into Laravel models:

   $drupalService->syncNodesToLocalModels(Node::class, ['title', 'body']);
   

2. API Integration Leverage the bundle’s HTTP client to interact with Drupal 8 REST endpoints:

   $response = $drupalService->get('/jsonapi/node/article', [
       'fields[node--article]' => 'title,body',
   ]);
   

3. Event-Driven Updates Hook into Drupal 8 webhooks (if configured) to trigger Laravel events:

   event(new DrupalContentUpdated($drupalData));
   

Laravel Integration Tips

• Service Container Binding Bind the Drupal 8 service to Laravel’s container for dependency injection:

  $this->app->bind(Drupal8Service::class, function ($app) {
      return new Drupal8Service($app['config']['domainator9k-apptype-drupal8']);
  });
  

• Eloquent Model Observers Use observers to react to local model changes and push updates to Drupal:

  class ArticleObserver {
      public function saved(Article $article) {
          app(Drupal8Service::class)->updateNode($article->id, $article->toArray());
      }
  }
  

• Queue Jobs for Async Operations Offload heavy sync operations to Laravel queues:

  SyncDrupalContent::dispatch($drupalService, ['node_type' => 'page']);
  

Gotchas and Tips

Pitfalls

1. Deprecated Symfony Bundle

   • The bundle is Symfony-specific and lacks Laravel-native features (e.g., Eloquent, queues). Use a bridge or wrapper for seamless integration.
   • No active maintenance: Last release in 2018 may introduce compatibility issues with modern Laravel/Symfony versions.

2. Authentication Quirks

   • Ensure Drupal 8’s REST module is configured with proper permissions for the API endpoint.
   • Basic Auth may fail if Drupal’s services.yml isn’t updated:

     # Drupal 8 services.yml
     http_middleware:
       - 'drupal.auth'
     

3. Data Mapping Complexity

   • Drupal’s JSON:API responses may require manual mapping to Laravel models. Use Laravel’s array_walk_recursive or a mapper library like spatie/array-to-object.

Debugging

• Enable Verbose Logging Add to config/domainator9k-apptype-drupal8.php:

  'debug' => env('APP_DEBUG', false),
  

  Logs will appear in Laravel’s storage/logs.

• HTTP Client Errors Check Drupal’s REST endpoint directly (e.g., POSTMAN) to isolate issues. Common causes:

  • Missing Content-Type: application/json header.
  • Incorrect machine token in Authorization: Bearer <token>.

Extension Points

1. Custom Endpoints Extend the service to support non-standard Drupal routes:

   class CustomDrupalService extends Drupal8Service {
       public function customEndpoint($path, $data = []) {
           return $this->httpClient->post($this->baseUrl . $path, [
               'headers' => ['Content-Type' => 'application/json'],
               'body' => json_encode($data),
           ]);
       }
   }
   

2. Webhook Listeners Create a Laravel route to handle Drupal webhook payloads:

   Route::post('/drupal-webhook', function (Request $request) {
       $payload = $request->json()->all();
       // Process payload (e.g., update local DB)
   });
   

3. Caching Responses Cache Drupal API responses using Laravel’s cache system:

   $cacheKey = 'drupal_nodes_' . md5($query);
   return Cache::remember($cacheKey, now()->addHours(1), function () use ($drupalService, $query) {
       return $drupalService->getNodes($query);
   });