carono/php-adblock-parser

PHP parser for Adblock Plus filters

v0.1.7 2019-10-20 09:09 UTC

Requires

• ext-mbstring: *
• symfony/cache: ^4.3

Requires (Dev)

• phpunit/phpunit: ~5.5

MIT

• Limon Monte

• parser
• adblock

README

Usage

To learn about Adblock Plus filter syntax check these links:

• https://adblockplus.org/en/filter-cheatsheet
• https://adblockplus.org/en/filters

1. Get filter rules somewhere: write them manually, read lines from a file downloaded from EasyList, etc.:

   $rules = [
       "||ads.example.com^",
       "@@||ads.example.com/notbanner^$~script",
   ];

2. Create AdblockRules instance from the rules array:

   use Limonte\AdblockParser;
   
   $adblockParser = new AdblockParser($rules);
   $adblockParser->addRules($anotherRules);

3. Use this instance to check if an URL should be blocked or not:

   $adblockParser->shouldBlock("http://ads.example.com"); // true
   $adblockParser->shouldBlock("http://non-ads.example.com"); // false

Related projects

• Google Safebrowsing PHP library: limonte/google-safebrowsing
• McAfee SiteAdvisor PHP library: limonte/mcafee-siteadvisor
• Check if link is SPAM: limonte/spam-link-analyser

• Python parser for Adblock Plus filters: scrapinghub/adblockparser
• EasyList filter subscription: easylist/easylist