Lorem Ipsum Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require ahuang/lorem-ipsum-bundle --dev
   

   Add to config/bundles.php:

   return [
       // ...
       AdamHuang\LoremIpsumBundle\LoremIpsumBundle::class => ['dev' => true],
   ];
   

2. First Use Case: Inject the service in a controller or service:

   use AdamHuang\LoremIpsumBundle\Service\LoremIpsumService;
   
   public function __construct(private LoremIpsumService $loremIpsum)
   {
   }
   
   public function generatePlaceholder()
   {
       return $this->loremIpsum->generateParagraphs(3); // Generates 3 paragraphs
   }
   

3. Configuration: Check config/packages/adamhuang_lorem_ipsum.yaml for customization (e.g., word count, paragraph length).

Implementation Patterns

Core Workflows

1. Placeholder Generation:

   • Use in tests (e.g., LoremIpsumService::generateWords(5) for fake user names).
   • Use in UI previews (e.g., generateParagraphs(2) for mock content in admin panels).

2. Integration with Forms:

   // In a form type
   $builder->add('description', TextType::class, [
       'data' => $this->loremIpsum->generateParagraphs(1),
   ]);
   

3. Dynamic Content:

   • Generate randomized data for API responses or CLI scripts:

     $fakeData = [
         'title' => $this->loremIpsum->generateSentence(),
         'content' => $this->loremIpsum->generateParagraphs(2),
     ];
     

4. Service Layer Abstraction:

   • Extend the service for project-specific needs:

     class CustomLoremService extends LoremIpsumService {
         public function generateBlogPost(): array {
             return [
                 'title' => $this->generateSentence(),
                 'excerpt' => $this->generateSentence(),
                 'body' => $this->generateParagraphs(5),
             ];
         }
     }
     

Gotchas and Tips

Pitfalls

1. Dev-Only Bundle:

   • The bundle is not registered in production by default (check config/bundles.php). Explicitly enable it if needed:

     ['dev' => false, 'test' => true], // For testing environments
     

2. Limited Customization:

   • No built-in theming (e.g., HTML tags, custom word lists). Override via dependency injection:

     # config/packages/adamhuang_lorem_ipsum.yaml
     adamhuang_lorem_ipsum:
         word_list: ['@custom_word_list'] # DI reference
     

3. Thread Safety:

   • The service is stateless but may cache word lists. Clear caches if words repeat unexpectedly.

Debugging

• Unexpected Output: Check config/packages/adamhuang_lorem_ipsum.yaml for misconfigured paragraph_length or word_count settings.
• Service Unavailable: Verify the bundle is enabled in bundles.php and PHP version meets ^7.1.3.

Extension Points

1. Custom Word Lists: Create a service to inject custom words:

   $container->set('custom_word_list', new ArrayList(['custom', 'words', 'here']));
   

2. HTML Generation: Extend the service to wrap output in HTML tags:

   class HtmlLoremService extends LoremIpsumService {
       public function generateHtmlParagraphs(int $count): string {
           return '<p>' . implode('</p><p>', array_map(fn($p) => $p, $this->generateParagraphs($count))) . '</p>';
       }
   }
   

3. Localization: Override the service to support non-Latin scripts (requires custom word lists).