quickstart.md

Quick Reference

Get started with Omnia Ipsum in 5 minutes.

Installation

composer require neuralglitch/omnia-ipsum

Bundle is auto-registered via Symfony Flex.

All Functions at a Glance

{# Images (5 providers) #}
{{ omnia_image(width, height, options) }}
{{ omnia_avatar(name, size, options) }}

{# Videos (Google Cloud Storage) #}
{{ omnia_video(width, height, options) }}

{# Audio (Music + Silent) #}
{{ omnia_audio(duration, options) }}  {# Default: SoundHelix music #}

{# Lorem Ipsum Text #}
{{ lorem_paragraphs(count) }}
{{ lorem_paragraph() }}
{{ lorem_sentences(count) }}
{{ lorem_sentence() }}
{{ lorem_words(count) }}
{{ lorem_title() }}

{# Faker (Realistic Data) #}
{{ fake(formatter, arguments) }}
{{ fake_text(maxChars) }}  {# Realistic text #}

Common Examples

Hero Section

<section class="hero">
    <video src="{{ omnia_video(1920, 1080, {video: 'big-buck-bunny'}) }}" 
           autoplay muted loop class="hero-video"></video>
    <div class="hero-content">
        <h1>{{ lorem_title() }}</h1>
        <p>{{ lorem_sentence() }}</p>
    </div>
</section>

Product Grid

<div class="product-grid">
    {% for i in 1..12 %}
        <div class="product-card">
            <img src="{{ omnia_image(300, 300, {provider: 'picsum', seed: i}) }}" alt="Product">
            <h3>{{ lorem_title() }}</h3>
            <p>{{ lorem_sentence() }}</p>
            <p class="price">{{ fake('randomFloat', [2, 10, 1000]) }} €</p>
        </div>
    {% endfor %}
</div>

Team Section

<div class="team">
    {% for i in 1..6 %}
        {% set name = fake('name') %}
        <div class="team-member">
            <img src="{{ omnia_avatar(name, 120) }}" alt="{{ name }}">
            <h4>{{ name }}</h4>
            <p>{{ fake('jobTitle') }}</p>
            <p>{{ fake('email') }}</p>
        </div>
    {% endfor %}
</div>

Blog Post

<article>
    <img src="{{ omnia_image(1200, 400, {provider: 'picsum'}) }}" class="featured">
    <h1>{{ lorem_title() }}</h1>
    <div class="meta">
        {% set author = fake('name') %}
        <img src="{{ omnia_avatar(author, 40) }}" alt="{{ author }}">
        <span>{{ author }}</span>
        <time>{{ fake('dateTimeBetween', ['-30 days', 'now'])|date('F j, Y') }}</time>
    </div>
    <div class="content">{{ lorem_paragraphs(5) }}</div>
</article>

Media Gallery

<div class="gallery">
    {# Images #}
    {% for i in 1..6 %}
        <img src="{{ omnia_image(400, 300, {provider: 'picsum', seed: i}) }}">
    {% endfor %}
    
    {# Videos #}
    {% set videos = ['big-buck-bunny', 'sintel', 'elephants-dream'] %}
    {% for video in videos %}
        <video src="{{ omnia_video(1920, 1080, {video: video}) }}" controls></video>
    {% endfor %}
    
    {# Audio - Music #}
    {% for i in 1..3 %}
        <div class="audio-item">
            <h4>{{ lorem_title() }}</h4>
            <audio src="{{ omnia_audio(10, {song: i}) }}" controls></audio>
        </div>
    {% endfor %}
</div>

Image Providers

{# Picsum - Real photos #}
{{ omnia_image(800, 600, {provider: 'picsum'}) }}

{# Picsum - Grayscale or blurred #}
{{ omnia_image(800, 600, {provider: 'picsum', grayscale: true}) }}
{{ omnia_image(800, 600, {provider: 'picsum', blur: 5}) }}

{# Placeholder.com - Colored boxes (default) #}
{{ omnia_image(600, 400, {background: 'ff0000', text: 'Sale!'}) }}

{# DummyImage - Multiple formats #}
{{ omnia_image(800, 600, {provider: 'dummyimage', format: 'jpg'}) }}

{# UI Avatars - User avatars #}
{{ omnia_avatar('John Doe', 100) }}

See Image Providers for all 5 providers.

Videos

{# Default video (Big Buck Bunny) #}
{{ omnia_video(1920, 1080) }}

{# Specific videos #}
{{ omnia_video(1920, 1080, {video: 'sintel'}) }}
{{ omnia_video(1920, 1080, {video: 'elephants-dream'}) }}
{{ omnia_video(1920, 1080, {video: 'tears-of-steel'}) }}

13 videos available from Google Cloud Storage (reliable & fast!)

See Video Providers for all videos.

Faker Formatters

{# Personal #}
{{ fake('name') }}
{{ fake('email') }}
{{ fake('phoneNumber') }}

{# Address #}
{{ fake('address') }}
{{ fake('city') }}
{{ fake('country') }}

{# Company #}
{{ fake('company') }}
{{ fake('jobTitle') }}

{# Internet #}
{{ fake('userName') }}
{{ fake('url') }}

{# Dates #}
{{ fake('date') }}
{{ fake('dateTime')|date('Y-m-d H:i') }}

{# Numbers #}
{{ fake('randomNumber') }}
{{ fake('randomFloat', [2, 0, 100]) }}

{# Text #}
{{ fake('sentence') }}
{{ fake('paragraph') }}

See Faker Integration for 100+ formatters.

Configuration

# config/packages/omnia_ipsum.yaml
omnia_ipsum:
    images:
        default_provider: 'picsum'      # Default image provider
        
    videos:
        default_duration: 30            # Default video duration (seconds)
        
    faker:
        locale: 'de_DE'                 # German fake data
        seed: 42                        # Reproducible data

See Configuration for all options.

Best Practices

✅ DO

• Use in development/testing only
• Disable in production (['dev' => true, 'test' => true])
• Choose appropriate providers (Picsum for photos, UI-Avatars for people)
• Use seed parameter for different images in loops
• Use fake_text() for realistic content in client demos
• Use SoundHelix for music/podcast demos, Silence for UI testing
• Configure soundhelix as default for media demos

❌ DON'T

• Don't use in production
• Don't use Silence provider for long durations (>60s causes memory issues)
• Don't use Faker for passwords/tokens
• Don't expect custom durations with SoundHelix (all songs are ~5 min)

Next Steps

• Image Providers - Learn about all image providers
• Video Providers - Video options and clips
• Faker Integration - All available fake data formatters
• Configuration - Customize defaults