nexuslinkservices/external-link-purifier

v1.2.2 2016-08-31 11:48 UTC

This package is not auto-updated.

Last update: 2024-11-09 19:29:04 UTC


README

Define true/false value to purify external or all links as per your need

Latest Version Software License Scrutinizer Code Quality Build Status

Installation

If you use composer, you can add this package by running

composer require galiteintechnologies/external-link-purifier

Usage

i.e.: I want to remove external links from my content, so I need to define following variables in my configuration yaml file.

external_link:
    purify: true    
Note(s): 
1. If configuration yaml is not there in your project then the default configuration will be taken into consideration.
2. The bundle uses symfony yaml component to parse the yaml configuration.

Following is the reference code to make it working,

/**
 * CODE

 * create a new object of LinkPurifier class
 * call purify method with 3 arguments
 * $content to purify links
 * $domain keep links of this domain and remove other external links (optional), If not specified remove all links
 * $purify true/false (optional)
 */

$linkPurifier = new LinkPurifier($pathToYaml);  //$pathToYaml is optional as mentioned earlier
$filteredContent = $linkPurifier->Purify($contentToBePurifyForLinks, $domainToKeep, $purify);

That's it with the bundle.

CONTRIBUTING:

Pull requests are always welcome.