Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisrhymes/link-checker
A Laravel package that will check for broken links within HTML for a specified model's fields.
https://github.com/chrisrhymes/link-checker
broken-link-finder broken-links eloquent laravel laravel-package links php
Last synced: 4 months ago
JSON representation
A Laravel package that will check for broken links within HTML for a specified model's fields.
- Host: GitHub
- URL: https://github.com/chrisrhymes/link-checker
- Owner: chrisrhymes
- License: mit
- Created: 2022-09-16T16:46:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T21:13:52.000Z (about 1 year ago)
- Last Synced: 2024-10-04T21:05:24.489Z (4 months ago)
- Topics: broken-link-finder, broken-links, eloquent, laravel, laravel-package, links, php
- Language: PHP
- Homepage: https://packagist.org/packages/chrisrhymes/link-checker
- Size: 49.8 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Link Checker for Laravel
A package that will check for broken links in the specified model's fields. It will check both URL fields and fields containing HTML.
## Contents
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Relative links](#relative-links)
- [Rate Limiting](#rate-limiting)
- [User Agent](#user-agent)
- [Verify SSL](#verify-ssl)
- [Tests](#tests)
## Getting Started
```bash
composer require chrisrhymes/link-checker
```
### Migrate the database
```bash
php artisan migrate
```
### Add the Trait to your models
Add the HasBrokenLinks trait to your model
```php
failed()` and if it fails it is determined to be a broken link.
Any broken links will be stored in the broken_links table, with a polymorphic relationship back to the original model.
If an exception is thrown, such as a timeout, then an exception_message will also be recorded in the broken_links table.
```php
$post = Post::first();
$post->brokenLinks; // A collection of broken links for the model
$post->brokenLinks[0]->broken_link; // The link that is broken
$post->brokenLinks[0]->exception_message; // The optional exception message
```
### Relative links
If you have relative links within a html field in your model (that don't begin with 'http'), then you can pass a 3rd parameter as the base. The CheckModelForBrokenLinks job will prepend the base to the relative url before it is checked.
If your relative links don't begin with `/`, then ensure your base parameter has a trailing slash, `'http://example.com/'`.
```php
use ChrisRhymes\LinkChecker\Jobs\CheckModelForBrokenLinks;
use ChrisRhymes\LinkChecker\Facades\LinkChecker;
$post = Post::first();
// Dispatch the job directly
CheckModelForBrokenLinks::dispatch($post, ['content', 'url'], 'http://example.com');
// Or using the facade
LinkChecker::checkForBrokenLinks($post, ['content', 'url'], 'http://example.com');
```
## Rate Limiting
In order to reduce the amount of requests sent to a domain at a time, this package has rate limiting enabled.
The configuration file allows you to set the `rate_limit` to set how many requests can be sent to a single domain within a minute. The default is set to 5, so adjust as required for your circumstances.
The configuration file also allows you to set the `retry_until` so the job will be retried until the time limit (in munites) is reached.
## User Agent
To set a custom user agent for requests sent by the link checker, set the `user_agent` in the configuration file. For example `'user_agent' => 'my-user-agent',`
The default value is `link-checker`.
## Verify SSL
To disable verifying the SSL certificate of the link you are checking, [publish the package configuration](#publish-the-config-optional) and then set `'verify' => false,`.
This uses the HTTP client withOptions() to set the [verify request option in Guzzle](https://docs.guzzlephp.org/en/stable/request-options.html#verify).
## Tests
The tests are built with [Pest](https://pestphp.com/).
Run the tests using either of the below commands.
```bash
vendor/bin/pest
// Or
composer test
```