Symfony Printer Laravel Package

Getting Started

Minimal Steps

1. Installation Add the package via Composer:

   composer require drjele/symfony-printer
   

   No Laravel-specific setup is required since this is a Symfony utility package, but it can be used in Laravel via Symfony’s components or as a standalone utility.

2. First Use Case Import the Printer class and use it to format output:

   use DrJele\Printer\Printer;
   
   $printer = new Printer();
   $output = $printer->print('Hello, Laravel!');
   echo $output; // Renders formatted output (e.g., colored, styled)
   

3. Where to Look First

   • Documentation: Check the GitLab repo for usage examples (if available).
   • Source Code: Explore src/Printer.php for core methods like print(), error(), success(), etc.
   • Symfony Integration: If using in Laravel, leverage Symfony’s Console/Style/StyleInterface for CLI output (this package may wrap similar functionality).

Implementation Patterns

Usage Patterns

1. CLI Output Styling Use Printer for colored, formatted console output in Laravel Artisan commands:

   use DrJele\Printer\Printer;
   
   class MyCommand extends Command {
       protected function handle() {
           $printer = new Printer();
           $printer->success('Task completed!');
           $printer->error('Failed to process: ' . $e->getMessage());
       }
   }
   

2. Logging Integration Extend Laravel’s logging to include formatted messages:

   use DrJele\Printer\Printer;
   use Illuminate\Support\Facades\Log;
   
   Log::info((new Printer())->info('User logged in: ' . $user->name));
   

3. API Response Formatting Format API responses with structured output (e.g., for debugging):

   return response()->json([
       'data' => $data,
       'debug' => (new Printer())->dump($data, 'Data structure')
   ]);
   

Workflows

• Consistent Styling: Use predefined methods (success(), warning(), error()) for uniform CLI output across commands.
• Debugging: Leverage dump() or table() methods for structured variable inspection in Tinker or logs.
• Testing: Mock Printer in unit tests to isolate output logic:

  $printer = Mockery::mock(Printer::class);
  $printer->shouldReceive('success')->once();
  

Integration Tips

• Symfony Console: If using Laravel’s Illuminate\Support\Facades\Console, combine with Symfony’s Style interface for advanced features.
• Custom Themes: Extend Printer to add project-specific styles (e.g., custom colors for warnings).
• Dependency Injection: Bind Printer to Laravel’s container for easy access:

  $this->app->singleton(Printer::class, function () {
      return new Printer();
  });
  

Gotchas and Tips

Pitfalls

1. Symfony Dependency: The package assumes Symfony’s Console components. If using in Laravel, ensure compatibility (e.g., avoid Symfony-specific features like Symfony\Component\Console\Output\OutputInterface directly).
2. Output Buffering: CLI output may not appear immediately if buffering is enabled (e.g., in tests). Use flush() or disable buffering:

   $printer->print('Message')->flush();
   

3. No Laravel-Specific Features: Avoid expecting Laravel integrations (e.g., no Log facade methods or Blade directives).

Debugging

• Silent Failures: Methods like dump() may not throw exceptions. Check return values or use try-catch:

  try {
      $printer->dump($variable);
  } catch (\Exception $e) {
      Log::error('Dump failed: ' . $e->getMessage());
  }
  

• Color Issues: If colors don’t render, ensure your terminal supports ANSI codes or the environment is configured correctly (e.g., NO_COLOR env var).

Config Quirks

• No Config File: The package is utility-focused; no config/printer.php exists. Customize via constructor or DI.
• Locale/Encoding: For non-ASCII output, ensure your terminal/environment supports UTF-8.

Extension Points

1. Custom Printer Classes: Extend DrJele\Printer\Printer to add methods:

   class MyPrinter extends Printer {
       public function customOutput($message) {
           return $this->print($message)->withStyle('bg=blue;fg=white');
       }
   }
   

2. Hooks for Logging: Override methods to log output (e.g., success()) before rendering.
3. Integration with Laravel Events: Trigger Printer output in event listeners:

   event(new \App\Events\UserRegistered($user));
   // In listener:
   $printer->success('User registered: ' . $user->email);