README

Path2URL

🚀 A robust PHP library for converting relative paths to absolute URLs

📖 About Path2URL

🛠️ Path2URL is a powerful PHP library designed to automatically convert relative file paths to absolute URLs in HTML, CSS, and JavaScript files. Perfect for migrating websites, setting up CDNs, or managing content across different environments.

⏰ Last Updated: 2024-11-12 14:53:36 UTC

✨ Features

🌟 Key Features:

🔄 Converts relative paths to absolute URLs
📁 Supports HTML, CSS, and JavaScript files
💾 Automatic backup creation before modifications
📝 Comprehensive logging system
⚙️ Configurable file extensions
🔒 Type-safe with PHP 7.4+ features

⚡ Installation

📦 Install the package via Composer:

composer require abdessattar23/path2url

🚀 Basic Usage

use Path2URL\Path2URL;

// Initialize the converter
$converter = new Path2URL(
    '/path/to/your/files',
    'https://your-domain.com'
);

// Process all files
$stats = $converter->process();

🎯 Example Transformations

📄 HTML Files

<!-- Before -->
<img src="./images/logo.png">
<a href="../docs/guide.pdf">

<!-- After -->
<img src="https://your-domain.com/images/logo.png">
<a href="https://your-domain.com/docs/guide.pdf">

🎨 CSS Files

/* Before */
background-image: url('./images/bg.jpg');
background: url('../assets/pattern.png');

/* After */
background-image: url('https://your-domain.com/images/bg.jpg');
background: url('https://your-domain.com/assets/pattern.png');

⚙️ Advanced Configuration

// Custom configuration
$converter = new Path2URL(
    '/path/to/your/files',
    'https://your-domain.com',
    ['html', 'css', 'js', 'xml'],  // Custom file extensions
    'custom_log.log'               // Custom log file
);

📊 Logging Example

[2024-11-12 13:46:07] [INFO] Starting URL conversion process
[2024-11-12 13:46:07] [INFO] Processing file: /path/to/file.html
[2024-11-12 13:46:07] [INFO] Created backup: file.html.1731417583.bak
[2024-11-12 13:46:07] [INFO] Successfully processed file

📋 Requirements

💻 PHP 7.4 or higher
📦 Composer for dependency management

🧪 Testing

Run the test suite:

composer test

🔐 Security

🛡️ Found a security issue? Please email abdessattar23 instead of using the issue tracker.

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

📜 License

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

🗺️ Roadmap

🖥️ CLI interface implementation
📁 Additional file type support
⚙️ Custom URL transformation rules
🔌 Framework integrations
⚡ Real-time processing option

👥 Credits

👨‍💻 Author: abdessattar23
🌟 All Contributors

🌐 Social

💝 Support

If you found this package helpful, please consider:

⭐ Starring the repository
🐛 Reporting issues
🤝 Contributing to the code
☕ Buy me a coffee

📊 Project Stats

🔥 Created and maintained by abdessattar23

If this package helps your project, please consider giving it a ⭐

_{Built with ❤️ by the PHP community}

abdessattar23 / path2url

Maintainers

Details