craft-obfuscator

KO | EN

gitlite — search

#python #javascript #nodejs #swift #go #golang #react #python3 #mysql #windows #ios #docker

craft-obfuscator

★ 16 Open GitHub ↗

A Craft CMS plugin that adds a Twig filter to obfuscate emails.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Obfuscator

A [Craft CMS][craft] plugin that adds a [Twig][] filter to obfuscate emails or any other content using [Hivelogic Enkoder][he].

[craft]:http://buildwithcraft.com/
[twig]:http://twig.sensiolabs.org/
[he]:http://hivelogic.com/enkoder/

This plugin uses [Standalone PHPEnkoder][sp].

[sp]: https://github.com/jnicol/standalone-phpenkoder

Contents
--------
- [Usage](#usage)
- [Installation](#installation)
- [Requirements](#requirements)
- [Changelog](./CHANGELOG.md)
- [License](./LICENSE.md)

Usage
-----

The following Twig snippet —

```twig
{% apply enkode_emails %}
    Reach us on me@example.com or
    <a href="mailto:anotherme@example.com">here</a>.
{% endapply %}
```

will result in HTML where both the plain text email, and the `mailto:`
anchor tag are recognised as emails and obfuscated. It will result in something
like this (re-formatted for readability):

```html
Reach us on

<span id="enkoder_1_2033799978">email hidden; JavaScript is required</span>
<script id="script_enkoder_1_2033799978" type="text/javascript"> /*  */ </script>

<span id="enkoder_0_1540754146">email hidden; JavaScript is required</span>
<script id="script_enkoder_0_1540754146" type="text/javascript"> /*  */ </script>.
```

In addition to the `enkode_emails` filter, Obfuscator comes with a bunch of additional
filters for more fine grained targeting of what to obfuscate.

```twig
{{ 'Reach us on me@example.com or <a href="mailto:anotherme@example.com">here</a>.'|enkode_emails }}

{{ '<a href="mailto:me@example.com">Contact Us</a>'|enkode_mailtos }}

{{ 'If you don’t have JavaScript, you’ll see a helpful message.'|enkode('JavaScript is required to view this message.') }}
```

Installation
------------

You can install this plugin from the [Plugin Store][ps] or with Composer.

[ps]:https://plugins.craftcms.com/obfuscator

#### From the Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Obfuscator”.
Then click on the “Install” button in its modal window.

#### Using Composer
Open your terminal and run the following commands:

# go to the project directory
    cd /path/to/project
    
    # tell composer to use the plugin
    composer require miranj/craft-obfuscator
    
    # tell Craft to install the plugin
    ./craft plugin/install obfuscator

Requirements
------------
This plugin requires Craft CMS 3, 4, or 5. The Craft 2 version is availabe in [the `v0` branch](https://github.com/miranj/craft-obfuscator/tree/v0).

---

Brought to you by [Miranj](https://miranj.in/)

craft-obfuscator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README