datastone/craft-obfuscate

Datastone obfuscate

1.1.0 2024-05-08 12:01 UTC

This package is auto-updated.

Last update: 2024-05-08 12:12:43 UTC


README

Obfuscate an email or other strings to prevent spam-bots from sniffing it.

Installation

Install the plugin via the Craft CMS control panel or via the command line:

composer require datastone/craft-obfuscate
./craft plugin/install datastone-obfuscate

Usage

twig filter:

In the simplest form you can use

{{ "email@example.com" | obfuscate }}

Roadmap

  • add other methods to obfucate email like text directions
  • css and javascript tricks

More advance usage:

{{ string $str | [, obfuscate | obfuscateEmail | obfuscateMailTo] }}
craft extension:
{{ craft.obfuscator.obfuscate(string $str) }}
{{ craft.obfuscator.email(string $email) }}
{{ craft.obfuscator.mailto(string $email) }}

obfuscateMailTo:

{{ string $email | obfuscateMailTo([string $title [, $json ]]) }}
{{ craft.obfuscator.mailto(string $email [, string $title [, $json ]]) }}

example :

{{ 'exm@test.nl' | obfuscateMailTo('title', {'class' : 'className', 'attr' : ''}) }}

output :

<a href="mailto:exm@test.nl" class="className" attr>title</a>

string concat: (notice the () for twig otherwise the parsing goes wrong!)

{{ ('Some string to hide ' ~ foo.bar) | obfuscate }}
{{ craft.obfuscator.obfuscate('Some string to hide ' ~ foo.bar) }}