avolle/cakephp-deadlinks

CakePHP Plugin to search database entries for dead links

2.0.0 2023-10-15 22:08 UTC

Requires

• php: ^8.1
• ext-curl: *
• cakephp/cakephp: ^5.0.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.0
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^10.0.0

MIT

• Alexander Volle

README

Scan links inside your database records to make sure they're not dead.

The links you once inserted into your database may not work in the future. This plugin makes sure all your links are well and alive. If any links are found to be dead, the results can be ouput through various methods.

Output methods:

• Terminal
• Log file
• Mail

Version map:

Installation

composer require avolle/cakephp-deadlinks

Usage

Add a config file in your app config folder, describing which tables and fields to scan. Optionally you can insert an email recipient to receive results when selecting the mail ouput method.

Example config file (/config/deadlinks.php): This config file will scan the following tables and fields:

• Files
  • linkOne
  • linkTwo
• Links
  • link
• Resources
  • link

<?php

return [
    'Deadlinks' => [
        /*
         * Mail Recipient. Person to receive results when mail output is selected
         */
        'mailRecipient' => '[e-mail]',

        /*
         * Tables to scan and their fields
         */
        'tables' => [
            'Files' => [
                'fields' => [
                    'linkOne',
                    'linkTwo',
                ],
            ],
            'Links' => [
                'fields' => [
                    'link',
                ],
            ],
            'Resources' => [
                'fields' => [
                    'link',
                ],
            ],
        ],
    ],
];

Add the plugin in your src/Application.php file. Put it inside the bootstrapCli method

protected function bootstrapCli(): void
{
    $this->addPlugin('Avolle/Deadlinks');
}

To run the scanner, execute this command in your terminal

• Output in terminal: bin\cake scan -t
• Output to log file: bin\cake scan -l
• Output to an email: bin\cake scan -m

You can also ouput several methods. For both terminal and log file, run bin\cake scan -t -l.

For help, run bin\cake scan -h