O

IUM-URL

v1.0.0

URL Management

Complete URL management for Laravel. Shorten links, track clicks, analyze visitor analytics, and protect privacy — all via a clean fluent API.

Documentation View Source

Quick Install

$composer require obelaw/ium-url

PHP 8.2+ • Laravel 10+

All Features

Everything you need for link shortening, click tracking, and privacy-safe analytics in one modular package.

Fluent API

Access all functionality fluently via the global helper. Chain operations with a clean, readable syntax that integrates naturally with your Laravel application.

  • Global ium()->url() helper
  • Shorten, track, and analyze in one place
  • Uniform method signatures across all operations
  • Self-documenting code with named parameters
  • Service provider registration included

Strict Type Safety

Every operation uses dedicated Data Objects for input and query mapping. Catch errors at compile time with fully typed DTOs instead of loose arrays.

  • ShortenUrlData for link creation
  • TrackUrlData for visitor context
  • UrlStatsData for analytics filters
  • Immutable UrlStatsResultData report payload
  • Constructor validation on all DTOs

Visitor Analytics

Separate total clicks from unique visitors with high-performance aggregation. Filter analytics by date range and device type to understand your audience.

  • Total vs unique visitor counts
  • Device distribution breakdown
  • Referrer source tracking
  • Date-ranged filter support
  • Conversion ratio calculation

Privacy-Safe Tracking

Automatically masks IPv4 and IPv6 addresses before storing them in the database. Full GDPR compliance built in — no configuration required.

  • Automatic IP anonymization on capture
  • IPv4 and IPv6 mask support
  • No external privacy service dependencies
  • Original IP never persisted
  • GDPR-ready out of the box

Device Parser

Analyze user agent headers to categorize visitors into device types without heavy third-party dependencies. Lightweight, decoupled, and extensible.

  • Classifies: desktop, mobile, tablet, robot
  • No heavy third-party parser dependencies
  • Clean separation of concerns
  • Fallback to other for unknown agents
  • Filters analytics by device type

Prefix Compliance

Models and migrations extend Obelawium base classes to comply with prefix-scoped table registries. Seamlessly integrates into multi-tenant and prefixed database setups.

  • ium_url_* table prefix convention
  • Extends ModelBase and MigrationBase
  • Compatible with multi-tenant architectures
  • No table name conflicts with other packages
  • Automatic prefix resolution

Native Integration

IUM-URL works seamlessly with the rest of the IUM ecosystem and any Laravel application.

Any Laravel App

Framework Agnostic

Install via Composer and use the fluent helper anywhere in your Laravel application with zero configuration.

IUM Ecosystem

Obelawium Compatible

Table prefix compliance ensures clean integration alongside CRM, PIM, OMS, and other IUM packages.

GDPR Ready

Privacy by Design

IP anonymization, decoupled device parsing, and clean data separation make compliance straightforward.

Start with URL

Read the full documentation for installation guides, code examples, and API reference.

Read URL Docs