the-3labs-team/laravel-keyword-linker

A Laravel package to link keywords in your content


README

Latest Version on Packagist GitHub Tests Action Status Github PHPStan GitHub Code Style Action Status Maintainability Test Coverage License Mit Total Downloads

This is a package that converts keywords into links.

Installation

You can install the package via composer:

composer install the-3labs-team/keyword-linker

You can publish the config file with:

 php artisan vendor:publish --tag=keyword-linker-config    

This is the contents of the published config file:

return [
    'limit-auto-keywords' => 5, // limit auto keywords to be linked
    'whitelist' => [
        'p',
        'blockquote',
    ],
    
    'query_tracking' => [
        'enabled' => false,
        'query_string' => 'tracking=kwlinker',
    ],
];

Usage

use The3LabsTeam\KeywordLinker\Facades\KeywordLinker;

$content = "This is a test content";

$keywords = [
    'test' => 'https://example.com/test',
    // Usage: 'keyword' => 'link'
];

echo KeywordLinker::parse($content, $keywords);

# output: This is a <a href="http://example.com/test">test</a> content

Common usage

Use rel attribute to add nofollow to the link

$keywords = [
    'test' => [
        'link' => 'https://example.com/test',
        'rel' => 'nofollow'
    ],
    // Usage: 'keyword' => ['link' => 'link', 'rel' => 'nofollow']
];

Use target attribute to open the link in a new tab

$keywords = [
    'test' => [
        'link' => 'https://example.com/test',
        'target' => '_blank'
    ],
    // Usage: 'keyword' => ['link' => 'link', 'target' => '_blank']
];

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Sponsor

Tom's Hardware - Notizie, recensioni, guide all'acquisto e approfondimenti per tutti gli appassionati di computer, smartphone, videogiochi, film, serie tv, gadget e non solo Spaziogames - Tutto sul mondo dei videogiochi. Troverai tantissime anteprime, recensioni, notizie dei giochi per tutte le console, PC, iPhone e Android.
Cpop - News, recensioni, guide su fumetto, cinema & serie TV, gioco da tavolo e di ruolo e collezionismo. Tutto quello di cui hai bisogno per rimanere aggiornato sul mondo della cultura pop Data4Biz - Sito dedicato alla trasformazione digitale del business
SOS Home & Garden - Realtà dedicata a 360 gradi ai settori della casa e del giardino. Techradar - Le ultime notizie e recensioni dal mondo della tecnologia, su computer, sistemi per la casa, gadget e altro.
Aibay - Scopri AiBay, il leader delle notizie sull'intelligenza artificiale. Resta aggiornato sulle ultime innovazioni, ricerche e tendenze del mondo AI con approfondimenti, interviste esclusive e analisi dettagliate. Coinlabs - Notizie, analisi approfondite, guide e opinioni aggiornate sul mondo delle criptovalute, blockchain e finanza