Short Url Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   • Add the bundle via vendors install or Git submodule (as per README).
   • Register the BumzShortUrlBundle in AppKernel.php.
   • Include routing in routing.yml:

     BumzShortUrlBundle:
         resource: "@BumzShortUrlBundle/Resources/config/routing.yml"
         prefix:   /
     

   • Clear cache:

     php app/console cache:clear
     

2. First Use Case:

   • Generate a short URL in a controller:

     $shortUrl = $this->get('short_url')->generate('user/profile/123');
     

   • Display it in Twig:

     {{ path('short_url', {'path': 'user/profile/123'}) }}
     

Implementation Patterns

Core Workflows

1. URL Generation:

   • Use the service in controllers:

     $shortUrl = $this->get('short_url')->generate('/long/path');
     

   • Or via Twig:

     {{ short_url('/long/path') }}
     

   • Supports absolute paths (e.g., /user/123) or full URLs (e.g., https://example.com/user/123).

2. Routing Integration:

   • The bundle auto-routes ~short to handle short URLs (e.g., http://your.host/~short/abc123).
   • Customize the route prefix in routing.yml if needed.

3. Dynamic Short Codes:

   • Generate unique short codes for database records (e.g., users, products):

     $shortCode = $this->get('short_url')->generateShortCode('user', $userId);
     

   • Use in URLs:

     <a href="{{ path('short_url', {'path': 'user/' ~ user.shortCode }) }}">View</a>
     

4. Twig Extensions:

   • Leverage short_url() and path('short_url', {...}) in templates for consistency.

5. API/CLI Usage:

   • Access the service via dependency injection in commands or APIs:

     $shortUrl = $this->container->get('short_url')->generate('/api/resource');
     

Gotchas and Tips

Pitfalls

1. Routing Conflicts:

   • Ensure ~short doesn’t clash with existing routes. Override in routing.yml if needed:

     short_url:
         pattern:  /~custom_prefix/{path}
         defaults: { _controller: BumzShortUrlBundle:ShortUrl:redirect }
     

2. Short Code Collisions:

   • The bundle uses a simple hash (e.g., md5()). For high-traffic apps, implement a custom strategy (e.g., UUID or database-backed uniqueness) by extending the service:

     class CustomShortUrlGenerator extends \Bumz\ShortUrlBundle\Service\ShortUrlGenerator
     {
         protected function generateShortCode($path) {
             return Str::random(8); // Custom logic
         }
     }
     

   • Register the custom service in services.yml:

     services:
         short_url:
             class: AppBundle\Service\CustomShortUrlGenerator
             arguments: [...]
     

3. HTAccess Requirements:

   • Ensure your server rewrites ~short to the Symfony frontend controller. Example .htaccess rule:

     RewriteRule ^~short/(.*)$ /app_dev.php/~short/$1 [L]
     

4. Caching Short URLs:

   • The bundle doesn’t cache short codes by default. For performance, cache generated codes in Redis/Memcached:

     $cache = $this->get('cache');
     $shortCode = $cache->get("short_url:{$path}");
     if (!$shortCode) {
         $shortCode = $this->get('short_url')->generate($path);
         $cache->set("short_url:{$path}", $shortCode, 3600);
     }
     

Debugging Tips

1. Check Route Generation:

   • Verify the short_url route exists:

     php app/console router:debug | grep short_url
     

2. Log Short Codes:

   • Temporarily log generated codes to debug collisions:

     $this->get('logger')->debug('Generated short code:', ['code' => $shortCode]);
     

3. Test Redirects:

   • Manually test short URLs (e.g., http://your.host/~short/abc123) to ensure they redirect correctly.

Extension Points

1. Custom Short Code Format:

   • Override the ShortUrlGenerator class to enforce formats (e.g., alphanumeric-only):

     protected function sanitizeShortCode($code) {
         return preg_replace('/[^a-zA-Z0-9]/', '', $code);
     }
     

2. Analytics Integration:

   • Extend the redirect controller to track clicks:

     class CustomShortUrlController extends \Bumz\ShortUrlBundle\Controller\ShortUrlController
     {
         public function redirectAction($shortCode) {
             $this->get('analytics')->track('short_url_click', ['code' => $shortCode]);
             return parent::redirectAction($shortCode);
         }
     }
     

   • Override the bundle’s controller in services.yml:

     services:
         short_url.controller:
             class: AppBundle\Controller\CustomShortUrlController
             arguments: [...]
     

3. Database-Backed Short Codes:

   • Store short codes in a table for auditability or expiration:

     // Example: Add to ShortUrlGenerator
     public function generate($path) {
         $shortCode = $this->findOrCreateShortCode($path);
         return $this->getBaseUrl() . '/~short/' . $shortCode;
     }
     
     protected function findOrCreateShortCode($path) {
         $existing = $this->get('doctrine')->getRepository('AppBundle:ShortUrl')
             ->findOneBy(['path' => $path]);
         if (!$existing) {
             $existing = new ShortUrl();
             $existing->path = $path;
             $existing->code = $this->generateUniqueCode();
             $this->get('doctrine')->getManager()->persist($existing);
         }
         return $existing->code;
     }