{"id":13526005,"url":"https://github.com/phpsa/laravel-yourls-plugin","last_synced_at":"2026-01-24T21:32:59.258Z","repository":{"id":45433094,"uuid":"196083755","full_name":"phpsa/laravel-yourls-plugin","owner":"phpsa","description":"Plugin which integrates Laravel with Yourls (Your Own URL Shortener).","archived":false,"fork":false,"pushed_at":"2023-12-13T02:28:10.000Z","size":32,"stargazers_count":17,"open_issues_count":2,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-17T04:14:45.074Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phpsa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":"github:phpsa"},"created_at":"2019-07-09T21:05:24.000Z","updated_at":"2024-12-31T14:17:08.000Z","dependencies_parsed_at":"2023-12-03T21:25:34.176Z","dependency_job_id":"09db3fc4-0809-4759-be38-e740bd46691c","html_url":"https://github.com/phpsa/laravel-yourls-plugin","commit_stats":{"total_commits":27,"total_committers":4,"mean_commits":6.75,"dds":0.5185185185185186,"last_synced_commit":"32b1e130c16cf897037930612395a3e0acd110c5"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/phpsa/laravel-yourls-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpsa%2Flaravel-yourls-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpsa%2Flaravel-yourls-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpsa%2Flaravel-yourls-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpsa%2Flaravel-yourls-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phpsa","download_url":"https://codeload.github.com/phpsa/laravel-yourls-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpsa%2Flaravel-yourls-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28737320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T21:19:41.845Z","status":"ssl_error","status_checked_at":"2026-01-24T21:13:38.675Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T06:01:24.268Z","updated_at":"2026-01-24T21:32:59.229Z","avatar_url":"https://github.com/phpsa.png","language":"PHP","funding_links":[],"categories":["Integrations"],"sub_categories":["3rd party Integrations and Frameworks"],"readme":"# Laravel Yourls Plugin\n[![For Laravel 5][badge_laravel]](https://github.com/phpsa/laravel-api-controller/issue)\n[![Build Status](https://travis-ci.org/phpsa/laravel-yourls-plugin.svg?branch=master)](https://travis-ci.org/phpsa/laravel-yourls-plugin)\n[![styleci](https://styleci.io/repos/196083755/shield)](https://styleci.io/repos/196083755)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpsa/laravel-yourls-plugin/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpsa/laravel-yourls-plugin/?branch=master)\n[![Coverage Status](https://coveralls.io/repos/github/phpsa/laravel-yourls-plugin/badge.svg?branch=master)](https://coveralls.io/github/phpsa/laravel-yourls-plugin?branch=master)\n\n[![Packagist](https://img.shields.io/packagist/v/phpsa/laravel-yourls-plugin.svg)](https://packagist.org/packages/phpsa/laravel-yourls-plugin)\n[![Packagist](https://poser.pugx.org/phpsa/laravel-yourls-plugin/d/total.svg)](https://packagist.org/packages/phpsa/laravel-yourls-plugin)\n[![Packagist](https://img.shields.io/packagist/l/phpsa/laravel-yourls-plugin.svg)](https://packagist.org/packages/phpsa/laravel-yourls-plugin)\n[![Github Issues][badge_issues]](https://github.com/phpsa/laravel-api-controller/issue)\n\nPackage description: Plugin which integrates Laravel with Yourls (Your Own URL Shortener).\n\n## Installation\n\nInstall via composer\n```bash\ncomposer require phpsa/laravel-yourls-plugin\n```\n\n### Register Service Provider\n\n**Note! This and next step are optional if you use laravel\u003e=5.5 with package\nauto discovery feature.**\n\nAdd service provider to `config/app.php` in `providers` section\n```php\nPhpsa\\LaravelYourlsPlugin\\ServiceProvider::class,\n```\n\n### Register Facade\n\nRegister package facade in `config/app.php` in `aliases` section\n```php\n'ShortUrl' =\u003e Phpsa\\LaravelYourlsPlugin\\Facades\\LaravelYourlsPlugin::class,\n```\n\n### Publish Configuration File (optional)\n\n```bash\nphp artisan vendor:publish --provider=\"Phpsa\\LaravelYourlsPlugin\\ServiceProvider\" --tag=\"config\"\n```\n\n### Configuration Settings\n\nyou can set the following values in your environment file\n\n```bash\nLARAVEL_YOURLS_PLUGIN_URL=\nLARAVEL_YOURLS_PLUGIN_USERNAME=\nLARAVEL_YOURLS_PLUGIN_PASSWORD=\nLARAVEL_YOURLS_PLUGIN_SIGNATURE=\nLARAVEL_YOURLS_PLUGIN_FORMAT=json\n```\n\nAuthentication can use either the username / password combo or the signature\n\n## Usage\n\nusing the Facade: you can access the following methods:\n\n### shorturl\n*Generates a short url for your long url*\n\n```php\n\\ShortUrl::shorturl(string $url [, string $title = NULL [], string $keyword = NULL [], string $format = NULL ]]] )\n```\n\n**Parameters**\n+ *$url* - required - the url you wish to create a short url for\n+ *$title* - optional - Title of the short url\n+ *$keyword* - optional - Title for the short url (ie short.url/{keyword})\n+ *$format* - optional - Change the format for this specific request (json / xml)\n\n**Returns**\nstring - the short url that was generated\n\n\n### expand\n*Expands inforation about your short url*\n```php\n\\ShortUrl::expand(string $shorturl [, string $format = null] )\n```\n\n**Parameters**\n+ *$shorturl* - required - the shorturl to expand (can be either 'abc' or 'http://site/abc')\n+ *$format* - optional - Change the format for this specific request (json / xml)\n\n**Returns**\nstdClass - object of the response details\n\n### urlStats\n*Get stats about one short URL*\n```php\n\\ShortUrl::expand(string $shorturl [, string $format = null] )\n```\n\n**Parameters**\n+ *$shorturl* - required - the shorturl to expand (can be either 'abc' or 'http://site/abc')\n+ *$format* - optional - Change the format for this specific request (json / xml)\n\n**Returns**\nstdClass - object of the response details\n\n### stats\n*Get stats about one short URL*\n```php\n\\ShortUrl::stats( [string $filter = null [, int $limit = null [, string $format = null ]]] )\n```\n\n**Parameters**\n+ *$filter* - optional - the filter: either \"top\", \"bottom\" , \"rand\" or \"last\"\n+ *$limit* - optional - the limit (maximum number of links to return)\n+ *$format* - optional - Change the format for this specific request (json / xml)\n\n**Returns**\nstdClass - object of the response details\n\n### dbStats\n*Get stats about one short URL*\n```php\n\\ShortUrl::dbStats([ string $format = null] )\n```\n\n**Parameters**\n+ *$format* - optional - Change the format for this specific request (json / xml)\n\n**Returns**\nstdClass - object of the response details\n\n### getLastResponse\n*Gets the full response body from the last request*\n```php\n\\ShortUrl::getLastResponse()\n```\n**Parameters**\nN/A\n\n**Returns**\nstdClass|string response of the last request body\n\n## Security\n\nIf you discover any security related issues, please email\ninstead of using the issue tracker.\n\n## Credits\n\n- [Craig Smith](https://github.com/phpsa)\n- [All contributors](https://github.com/phpsa/laravel-yourls-plugin/graphs/contributors)\n\n\n[badge_laravel]:   https://img.shields.io/badge/Laravel-5.8%20to%205.8-orange.svg?style=flat-square\n[badge_issues]:    https://img.shields.io/github/issues/ARCANEDEV/Support.svg?style=flat-square","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpsa%2Flaravel-yourls-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphpsa%2Flaravel-yourls-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpsa%2Flaravel-yourls-plugin/lists"}