Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gremo/email-obfuscator
A text filter for automatic email obfuscation using Javascript or CSS fallback
https://github.com/gremo/email-obfuscator
Last synced: about 2 months ago
JSON representation
A text filter for automatic email obfuscation using Javascript or CSS fallback
- Host: GitHub
- URL: https://github.com/gremo/email-obfuscator
- Owner: gremo
- License: mit
- Created: 2020-10-12T07:48:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-12T07:54:22.000Z (about 4 years ago)
- Last Synced: 2024-10-29T22:26:03.830Z (about 2 months ago)
- Language: PHP
- Size: 4.88 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Email Obfuscator
> I'm not the author of this package. The original package was `propaganistas/email-obfuscator` but the author decided to abandon and delete the GitHub repository, **breaking all sites** using it. I've just cloned and uploaded the latest version available.
A text filter for automatic email obfuscation using the well-established JavaScript and a CSS fallback:
- ROT13 ciphering for JavaScript-enabled browsers
- CSS reversed text direction for non-JavaScript browsers
## Installation
Install the bundle via Composer:
```bash
composer require gremo/email-obfuscator
```
Then include the supplied JavaScript file (`assets/email-obfuscator.min.js`) somewhere in your template. CND alternative (no uptime guaranteed):
```txt
https://cdn.rawgit.com/gremo/email-obfuscator/master/assets/email-obfuscator.min.js
```
### Platform specific steps
- [Standalone](#standalone)
- [Laravel 5](#laravel)
- [Twig](#twig)
#### Standalone
Require the `src/Obfuscator.php` file somewhere in your project:
```php
require_once 'PATH_TO_LIBRARY/src/Obfuscator.php';
```
Parse and obfuscate a string by using the `obfuscateEmail($string)` function.
#### Laravel 5
You have 3 options depending on your use case:
- If you want to obfuscate all email addresses that Laravel ever outputs, add the middleare class to the `$middleware` array in `App\Http\Middleware\Kernel.php`:
```php
protected $middleware = [
\Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
// ...
\Gremo\EmailObfuscator\Laravel\Middleware::class,
];
```
This is the reccomended method.
- If you only want to have specific controller methods return obfuscated email addresses, add the Middleware class to the `$routeMiddleware` array in `App\Http\Middleware\Kernel.php`:
```php
protected $routeMiddleware = [
'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
// ...
'obfuscate' => \Gremo\EmailObfuscator\Laravel\Middleware::class,
];
```
... and apply controller middleware as usual in a controller's construct method or route definition:
```php
public function __construct()
{
$this->middleware('obfuscate');
}
```
- If you want to apply obfuscation only on specific strings, just use the `obfuscateEmail($string)` function.
#### Twig
Add the extension to the `Twig_Environment`:
```php
$twig = new Twig_Environment(...);
$twig->addExtension(new \Gremo\EmailObfuscator\Twig\Extension());
```
The extension exposes an `obfuscateEmail` Twig filter, which can be applied to any string.
```twig
{{ "Lorem Ipsum"|obfuscateEmail }}
{{ variable|obfuscateEmail }}
```
## Credits
- [Scott Yang](http://scott.yang.id.au/2003/06/obfuscate-email-address-with-JavaScript-rot13) for the JavaScript used in this method.
- [Silvan Mühlemann](http://techblog.tilllate.com/2008/07/20/ten-methods-to-obfuscate-e-mail-addresses-compared/) for the inspiration of the CSS implementation.