tzsk/shorten-url

Google URL Shortener and Expander for Laravel 5.1 and Above.

Shorten Url

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Package for Shortening URL and Expanding URL with Google. This is a great combination if you plan to send Links in your Text Messages fired from your Application., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require tzsk/shorten-url, <sub>(*4)</sub>

## Configure

First add the Service Provider and Facade in your app config file.

``` php
'providers' => [
    ...
    Tzsk\ShortenUrl\Provider\ShortenUrlServiceProvider::class,
    ...
]
...
'aliases' => [
    ...
    'GoogleUrl' => Tzsk\ShortenUrl\Facade\GoogleUrl::class,
    ...
]

After that run vendor:publish with flag config:, <sub>(*5)</sub>

$ php artisan vendor:publish --tag=config

Once you do that you will have a new file in your config folder. config/url.php, <sub>(*6)</sub>

There is only one criteria. Google API key for Shortening URL. Just login with google account and go to [https://console.developers.google.com], <sub>(*7)</sub>

Now create a new Application there. And Enable API for URL Shortening. And generate API Key to use in Credentials section., <sub>(*8)</sub>

Usage

``` php, <sub>(*9)</sub>

Use Class Path at the top of the File.

use Tzsk\ShortenUrl\Facade\GoogleUrl;, <sub>(*10)</sub>

Inside your Controller Method for Shortening.

$short = GoogleUrl::shorten("LONG URL"); # Returns String., <sub>(*11)</sub>

OR...

$short_data = GoogleUrl::extended()->shorten("LONG URL"); /** * For extended it will give the full response that google provides. */, <sub>(*12)</sub>

Inside your Controller Method for Expanding.

$long = GoogleUrl::expand("SHORT URL"); # Returns String., <sub>(*13)</sub>

OR...

$long_data = GoogleUrl::extended()->expand("SHORT URL"); /** * For extended it will give the full response that google provides. */ ```, <sub>(*14)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*15)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*16)</sub>

Security

If you discover any security related issues, please email mailtokmahmed@gmail.com instead of using the issue tracker., <sub>(*17)</sub>

Credits

• Kazi Mainuddin Ahmed
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>