Cms Layout Graphite Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require apie/cms-layout-graphite
   

   Publish the configuration (if available):

   php artisan vendor:publish --provider="Apie\CmsLayoutGraphite\CmsLayoutGraphiteServiceProvider"
   

2. First Use Case The package appears to be a CMS layout system (likely for Graphite CMS). Start by inspecting the config/cms-layout-graphite.php (if published) to understand available layout types, blocks, or regions. Example usage might involve:

   use Apie\CmsLayoutGraphite\Facades\CmsLayoutGraphite;
   
   // Fetch a layout by ID or slug
   $layout = CmsLayoutGraphite::getLayout('homepage');
   
   // Render a layout (if the package supports direct rendering)
   echo $layout->render();
   

3. Where to Look First

   • Service Provider: Check CmsLayoutGraphiteServiceProvider for registered bindings.
   • Facade: Use CmsLayoutGraphite facade for convenience.
   • Monorepo Docs: Refer to the Apie monorepo for broader context (e.g., Graphite CMS integration).

Implementation Patterns

Core Workflows

1. Layout Management

   • Fetching Layouts: Retrieve layouts by ID, slug, or type (e.g., CmsLayoutGraphite::find($id)).
   • Dynamic Regions: If the package supports regions/blocks, use methods like:

     $layout->addRegion('header', $block);
     $layout->getRegion('footer')->render();
     

   • Caching: Cache layouts or regions for performance (e.g., CmsLayoutGraphite::cacheLayout($layout, 3600)).

2. Integration with Graphite CMS

   • Content Sync: Hook into Graphite CMS events (e.g., graphite.content.updated) to refresh layouts:

     event(new \Graphite\Events\ContentUpdated($content));
     

   • Template Overrides: Extend Graphite templates to include layout logic:

     @layout('graphite::layouts.app')
         @section('content')
             {{ $layout->renderRegion('main') }}
         @endsection
     

3. Laravel Service Integration

   • Middleware: Use middleware to inject layouts into requests:

     public function handle(Request $request, Closure $next) {
         $request->merge(['layout' => CmsLayoutGraphite::getLayout($request->route('slug'))]);
         return $next($request);
     }
     

   • View Composers: Attach layouts to views:

     View::composer('*', function ($view) {
         $view->with('layout', CmsLayoutGraphite::getCurrentLayout());
     });
     

4. API Responses

   • Serialize layouts for APIs:

     return response()->json([
         'layout' => CmsLayoutGraphite::getLayout('api')->toArray(),
     ]);
     

Gotchas and Tips

Pitfalls

1. Lack of Documentation

   • Workaround: Dive into the monorepo for undocumented features or examples. Check tests/ folders for usage patterns.
   • Example: Search for CmsLayoutGraphite in the monorepo to find real-world implementations.

2. Graphite CMS Dependency

   • Issue: The package assumes Graphite CMS is installed. If not, layouts may fail silently.
   • Fix: Verify Graphite CMS is a dependency in composer.json:

     "require": {
         "graphite/graphite": "^1.0"
     }
     

3. Configuration Quirks

   • Missing Config: If config/cms-layout-graphite.php is unpublishable, hardcode defaults:

     config(['cms-layout-graphite.default_driver' => 'graphite']);
     

   • Driver Abstraction: The package may support multiple drivers (e.g., graphite, database). Test all drivers in your environment.

4. Caching Gotchas

   • Stale Data: Layouts cached aggressively may not reflect Graphite CMS changes. Use tags or event listeners to invalidate cache:

     Cache::tags(['layout-homepage'])->forget('homepage-layout');
     

Debugging Tips

1. Log Layout Data Use Laravel’s logging to inspect layout structures:

   \Log::debug('Layout regions:', $layout->getRegions());
   

2. Enable Query Logging If layouts query Graphite CMS, enable debug mode:

   \Graphite::setDebug(true);
   

3. Check for Deprecated Methods The package may use internal Apie methods. Override or extend the package:

   // app/Providers/CmsLayoutGraphiteServiceProvider.php
   public function register() {
       $this->app->extend('cms-layout-graphite', function ($service) {
           return new CustomCmsLayoutGraphite($service);
       });
   }
   

Extension Points

1. Custom Layout Drivers Implement a new driver by extending Apie\CmsLayoutGraphite\Contracts\Driver:

   class DatabaseDriver implements Driver {
       public function getLayout($id) {
           return DB::table('layouts')->find($id);
       }
   }
   

2. Block System Extensions Extend the block system to support custom types:

   CmsLayoutGraphite::extendBlock('video', function ($block) {
       return new VideoBlock($block->content);
   });
   

3. Event Listeners Listen for layout events (if supported) to react to changes:

   CmsLayoutGraphite::listen('layout.updated', function ($layout) {
       // Send notification or update cache
   });
   

4. Blade Directives Create custom Blade directives for layouts:

   Blade::directive('layoutRegion', function ($region) {
       return "<?php echo \\Apie\\CmsLayoutGraphite\\Facades\\CmsLayoutGraphite::renderRegion($region); ?>";
   });
   

   Usage:

   @layoutRegion('sidebar')