README

A Laravel package that streamlines development with reusable traits, contracts, and a powerful value generator system. Reduce boilerplate, standardize behavior, and enhance your models with automatic UUID, token, and slug generation.

✨ Features

• 🔧 11 Reusable Traits - UUID, Token, Slug, Meta, User, API, Search, and more
• 🎨 Customizable Generators - Flexible token, UUID, and slug generation
• ⚙️ Three-Tier Configuration - Model → Config → Default resolution
• 🔌 Extensible Architecture - Create custom generators easily
• 📦 Zero Configuration - Works out of the box with sensible defaults
• ✅ 100% Tested - Comprehensive test coverage with Pest PHP

📦 Installation

composer require cleaniquecoders/traitify

🚀 Quick Start

use CleaniqueCoders\Traitify\Concerns\InteractsWithUuid;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use InteractsWithUuid;

    // UUID automatically generated on creation
}

$post = Post::create(['title' => 'Hello World']);
echo $post->uuid; // 9d9e8da7-78c3-4c9d-9f5e-5c8e4a2b1d3c

📚 Documentation

• Documentation Home - Complete documentation index
• Getting Started - Installation and setup
• Architecture - System design and patterns
• Traits Reference - All available traits
• Generators - Customizable value generation
• Configuration - Configuration options
• Examples - Real-world usage examples
• Advanced - Extend and customize

🔥 Popular Use Cases

Auto-Generate UUIDs

use InteractsWithUuid;

protected $uuid_column = 'id'; // Use UUID as primary key

Secure API Tokens

use InteractsWithToken;

protected $tokenGeneratorConfig = [
    'length' => 64,
    'prefix' => 'sk_',
    'pool' => 'hex',
];

SEO-Friendly Slugs

use InteractsWithSlug;

protected $slugGeneratorConfig = [
    'unique' => true,
    'max_length' => 100,
];

🧪 Testing

composer test

📖 Available Traits

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

🔒 Security

If you discover any security issues, please review our security policy.

📝 Changelog

Please see CHANGELOG for recent changes.

👥 Credits

• Nasrul Hazim Bin Mohamad
• All Contributors

📄 License

The MIT License (MIT). Please see License File for more information.