Loremipsum Bundle Laravel Package

Getting Started

Minimal Setup

1. Install via Composer:

   composer require apoutchika/loremipsum-bundle:dev-master
   

2. Enable the Bundle in config/bundles.php (Laravel 5.4+):

   return [
       // ...
       Apoutchika\LoremIpsumBundle\ApoutchikaLoremIpsumBundle::class => ['all' => true],
   ];
   

   (For older Symfony/Laravel versions, register in AppKernel.php as shown in the README.)

3. First Use Case: Generate placeholder text in a controller:

   use Apoutchika\LoremIpsumBundle\LoremIpsum\LoremIpsum;
   
   public function generatePlaceholder()
   {
       $lorem = app(LoremIpsum::class);
       $paragraphs = $lorem->getParagraphs(2); // 2 random paragraphs
       return response()->json(['placeholder' => $paragraphs]);
   }
   

Implementation Patterns

Core Workflows

1. Dynamic Placeholder Generation:

   • Controllers: Use for seeding, testing, or mock data:

     $lorem = app(LoremIpsum::class);
     $user = new User([
         'name' => $lorem->getWords(1),
         'bio' => $lorem->getParagraphs(1),
     ]);
     

   • Factories: Integrate with Laravel’s Factory for fake data:

     use Apoutchika\LoremIpsumBundle\LoremIpsum\LoremIpsum;
     
     $factory->define(User::class, function (Faker $faker) {
         $lorem = app(LoremIpsum::class);
         return [
             'name' => $lorem->getWords(1),
             'email' => $faker->unique()->safeEmail,
         ];
     });
     

2. Twig Integration (if using Symfony’s Twig):

   • Generate placeholders in views:

     <p>{{ paragraphs(1, 3) }}</p> {# 1-3 paragraphs #}
     <span>{{ words(5) }}</span> {# 5 words #}
     

3. Custom Lorem Ipsum:

   • Override default text (e.g., for domain-specific placeholders):

     $lorem = app(LoremIpsum::class);
     $lorem->setLoremIpsum('Tech Startup Inc'); // Replace default text
     $companyName = $lorem->getWords(2); // "Tech Startup"
     

4. Seeding Databases:

   • Bulk generate data in DatabaseSeeder:

     $lorem = app(LoremIpsum::class);
     for ($i = 0; $i < 10; $i++) {
         DB::table('posts')->insert([
             'title' => $lorem->getWords(3),
             'content' => $lorem->getParagraphs(2),
         ]);
     }
     

Gotchas and Tips

Pitfalls

1. Service Container Confusion:

   • Laravel’s app() vs. Symfony’s get():

     // Laravel (correct):
     $lorem = app(LoremIpsum::class);
     
     // Symfony (legacy, may fail in Laravel):
     $lorem = $this->get('apoutchika.lorem_ipsum');
     

   • Fix: Bind the service in AppServiceProvider:

     public function register()
     {
         $this->app->bind('apoutchika.lorem_ipsum', function () {
             return new \Apoutchika\LoremIpsumBundle\LoremIpsum\LoremIpsum();
         });
     }
     

2. Twig Template Errors:

   • If using Twig in Laravel, ensure the bundle’s Twig extensions are registered.
   • Fix: Manually register the extension in AppServiceProvider:

     use Apoutchika\LoremIpsumBundle\Twig\LoremIpsumExtension;
     
     public function boot()
     {
         $this->app['twig']->addExtension(new LoremIpsumExtension());
     }
     

3. Randomness Control:

   • The package uses PHP’s rand(), which is not cryptographically secure but sufficient for placeholders.
   • For reproducible testing, seed the random generator:

     mt_srand(1234); // Seed before generating
     $paragraphs = $lorem->getParagraphs(1);
     

Tips

1. Performance:

   • Cache generated placeholders if regenerating frequently:

     $cacheKey = 'lorem_paragraphs_'.md5('user_bio');
     $paragraphs = Cache::remember($cacheKey, 60, function () use ($lorem) {
         return $lorem->getParagraphs(1);
     });
     

2. Extending Functionality:

   • Create a custom service to wrap the bundle:

     class CustomLoremIpsumService {
         protected $lorem;
     
         public function __construct(LoremIpsum $lorem)
         {
             $this->lorem = $lorem;
         }
     
         public function getUserBio()
         {
             return $this->lorem->getParagraphs(2);
         }
     }
     

     Register it in AppServiceProvider:

     $this->app->bind(CustomLoremIpsumService::class, function ($app) {
         return new CustomLoremIpsumService($app->make(LoremIpsum::class));
     });
     

3. Testing:

   • Mock the service in unit tests:

     $mockLorem = Mockery::mock(LoremIpsum::class);
     $mockLorem->shouldReceive('getWords')->andReturn('Test User');
     $this->app->instance(LoremIpsum::class, $mockLorem);
     

4. Configuration:

   • Override default settings via config/services.php (if the bundle supports it).
   • Note: This bundle lacks a config/ directory, so direct service binding is recommended for customization.

5. Debugging:

   • Check if the service is registered:

     php artisan container:list | grep lorem
     

   • If missing, ensure the bundle is properly loaded in config/bundles.php.