Download the PHP package hissezhaut/laravel-link-checker without Composer
On this page you can find all versions of the php package hissezhaut/laravel-link-checker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hissezhaut/laravel-link-checker
More information about hissezhaut/laravel-link-checker
Files in hissezhaut/laravel-link-checker
Package laravel-link-checker
Short Description Check all links in a Laravel app
License MIT
Homepage https://github.com/spatie/laravel-link-checker
Informations about the package laravel-link-checker
Check all links in a Laravel app
This package provides a command that can check all links on your laravel app. By default it will log all links that do not return a status code in the 200- or 300-range. There's also an option to mail broken links.
If you like this package, take a look at the other ones we have made.
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
Install
You can install the package via composer:
Next, you must install the service provider:
You must register the \Spatie\LinkChecker\CheckLinksCommand
:
You can optionally publish the config-file with:
This is the contents of the published config file:
Usage
You can start checking all links by issuing this command:
Want to run the crawler on a different url? No problem!
Schedule the command
To frequently check all links you can schedule the command:
Mail broken links
By default the package will log all broken links. If you want to have them mailed instead, just specify
Spatie\LinkChecker\Reporters\MailBrokenLinks
in the default_reporter
option in the config file.
Creating your own crawl profile
A crawlprofile determines which links need to be crawled. By default Spatie\LinkChecker\CheckAllLinks
is used,
which will check all links it finds. This behaviour can be customized by specify a class in the default_profile
-option in the config file.
The class must implement the Spatie\Crawler\CrawlProfile
-interface:
Creating your own reporter
A reporter determines what should be done when a link is crawled and when the crawling process is finished.
This package provides two reporters: Spatie\LinkChecker\Reporters\LogBrokenLinks
and Spatie\LinkChecker\Reporters\MailBrokenLinks
.
You can create your own behaviour by making a class adhere to the Spatie\Crawler\CrawlObserver
-interface:
To make it easier to create a reporter, you can extend Spatie\LinkChecker\Reporters\BaseReporter
which
provides many useful methods.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
First start the test server in a seperate terminal session:
With the server running you can execute the tests
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Freek Van der Herten
- All Contributors
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.