File: README.md

Recommend this page to a friend!
  Classes of Moamen Eltouny  >  Laravel Short URL Generator  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Laravel Short URL Generator
Generate and expand short URL stored in a database
Author: By
Last change:
Date: 11 months ago
Size: 2,027 bytes
 

Contents

Class file image Download

<p align="center"><a href="https://pharaonic.io" target="_blank"><img src="https://raw.githubusercontent.com/Pharaonic/logos/main/short-url.jpg" width="470"></a></p>

<p align="center"> <a href="https://packagist.org/packages/Pharaonic/laravel-short-url"><img src="https://img.shields.io/packagist/v/RaggiTech/laravel-short-url" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/Pharaonic/laravel-short-url"><img src="https://img.shields.io/packagist/dt/Pharaonic/laravel-short-url" alt="Total Downloads"></a> <a href="https://packagist.org/packages/Pharaonic/laravel-short-url"><img src="https://img.shields.io/packagist/l/Pharaonic/laravel-short-url" alt="License"></a> </p>

Install

Laravel >= 8

Install the latest version using Composer:

$ composer require pharaonic/laravel-short-url
$ php artisan vendor:publish --tag=laravel-short-url
$ php artisan migrate

Usage

<a name="generate" id="generate"></a>

Generate (URL, Route)

// Generate from URL
shortURL()->generate('https://pharaonic.io');

// Generate from URL with Expiry date (string or Carbon object)
shortURL()->generate('https://pharaonic.io', '2027-07-07');



// Generate from Route
shortURL()->generate('route.name.here', ['param' => 1]);

// Generate from Route with Expiry date (string or Carbon object)
shortURL()->generate('route.name.here', ['param' => 1]', '2027-07-07');

<a name="read" id="read"></a>

Get URL

echo shortURL('3dc0c3deda')->url;    //      http://127.0.0.1:8000/8ca3522787

// Blade
@shortURL('3dc0c3deda')

<a name="expired" id="expired"></a>

IF Expired

shortURL('3dc0c3deda')->expired		// false

<a name="regenerate" id="regenerate"></a>

Re-Generate

shortURL('3dc0c3deda')->regenerate()		// Returns ShortURL Object

License

MIT LICENSE

For more information send a message to info at phpclasses dot org.