README

A flexible, extensible URL shortener library for PHP applications with multiple storage backends and event-driven architecture.

Features

• 🚀 Multiple Storage Backends - Redis, File, or bring your own
• 📝 PSR-compliant Logging - Built-in Monolog integration
• 🎯 Event-Driven Architecture - Hook into URL processing lifecycle
• 🔧 Extensible Design - Easy to customize validators, code generators, and more
• 💪 Type-Safe - Full PHP type hints and exceptions

Installation

composer require nimp/link-loom

Quick Start

Basic Usage with Redis

<?php

use Nimp\LinkLoom\UrlShortenerBuilder;
use Redis;

$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

$shortener = (new UrlShortenerBuilder())
    ->withRedisRepository($redis)
    ->build();

// Shorten URL
$code = $shortener->encode('https://example.com/long-url');
echo "Short code: " . $code;

// Expand URL
$url = $shortener->decode($code);
echo "Original URL: " . $url;

With Logging

$shortener = (new UrlShortenerBuilder())
    ->withRedisRepository($redis)
    ->withLogger('/path/to/urls.log')
    ->build();

Advanced Configuration

$shortener = (new UrlShortenerBuilder())
    ->withCustomRepository(new MySQLRepository())
    ->withCodeGenerator(new MyCustomCodeGenerator())
    ->withCustomValidator(new MyCustomValidator())
    ->build();

Multiple Event Listeners

$shortener = (new UrlShortenerBuilder())
    ->withRedisRepository($redis)
    ->withLogger('/path/to/urls.log')
    ->addListener(new AnalyticsListener())
    ->addListener(new CacheListener())
    ->build();

Custom Event Dispatcher

$shortener = (new UrlShortenerBuilder())
    ->withRedisRepository($redis)
    ->withEventDispatcher($myCustomDispatcher)
    ->build();

Event System

LinkLoom provides a comprehensive event system for monitoring the URL shortening lifecycle using the Observer pattern.

Available Events

All events extend BaseShortenerEvent and provide access to the UrlShortener instance:

$event->context; // UrlShortener instance

UrlShortener Methods

Method Description

encode(string $url): string	Shorten URL and return code
decode(string $code): string	Expand code to original URL