Shorten your URL the easy way, with your favourite provider (Bit.ly, Goo.gl, Ow.ly).
The URL Shortening Providers are online services that takes long URLs and squeezes them into fewer characters to make the link easier to share, tweet, or send by email.
vinelab/url-shortener
is a PHP Package that consumes URL Shortening Providers
API's.
The supported providers of this release:
- Bit.ly
- ...
The recommended way to install this package is via Composer
.
A. Run this composer command:
composer require vinelab/url-shortener:*
B. Or manually add the package to your composer.json
and run composer update
.
{
"require": {
"vinelab/url-shortener": "*"
}
}
If you are using this package inside a Laravel project then you need to:
- Register the service provider in your
config/app.php
:
'providers' => array(
...
'Vinelab\UrlShortener\UrlShortenerServiceProvider'
),
The service provider will automatically alias the Vinelab\UrlShortener\Shorten
class, so you can easily use the Shorten
facade anywhere in your app.
- Publish the configuration file:
php artisan vendor:publish --provider ='Vinelab\UrlShortener\UrlShortenerServiceProvider'
Go to the generated config file url-shortener.php
and select your default provider:
'default' => 'bitly',
Then add your provider token:
'bitly' => [
'token' => 'YOUR-TOKEN-HERE',
],
Note: It's very recommended to not add your token (any sensetive data) to the config file instead reference it to a .env
variable.
And to do so:
- replace the
'token' => 'YOUR-TOKEN-HERE',
with'token' => env('BITLY_TOKEN'),
- open your
.env
file and add the token variable there with the token value:BITLY_TOKEN=YOUR-TOKEN-HERE
. - add the variable
BITLY_TOKEN=
to the.env.example
for other developers.
The easiest way is to use it is by the Shorten
facade.
$long_url = 'http://testing.tst/something/12345/something-else/54321';
$short_url = Shorten/Shorten::url($long_url); // returns the short version of the long_url as a string
Supporting a new URL shortening provider is very easy.
- all you have to is to write a driver for your URL Shortener service.
check the
Bitly
driverVinelab\UrlShortener\Drivers\Bitly
implementation to get an overview. - add you driver configuration to the config file.
- write tests for your drvier.
- check out the Contribution Guide for general details.
The MIT License (MIT). Please see License File for more information.