mirror of
https://github.com/elyby/php-tempmailbuster.git
synced 2025-05-31 14:11:41 +05:30
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fbe6e73780 | ||
|
|
60e657f823 | ||
|
|
2743cca1a2 | ||
|
|
9fec20c469 | ||
|
|
6616a5a787 | ||
|
|
33c1b6e3df | ||
|
|
77b6d84c41 | ||
|
|
0bbe59e9cc |
10
CHANGELOG.md
10
CHANGELOG.md
@@ -3,6 +3,16 @@
|
|||||||
All notable changes to `elyby/php-tempmailbuster` are documented in this file using the
|
All notable changes to `elyby/php-tempmailbuster` are documented in this file using the
|
||||||
[Keep a CHANGELOG](http://keepachangelog.com/) principles.
|
[Keep a CHANGELOG](http://keepachangelog.com/) principles.
|
||||||
|
|
||||||
|
## 1.0.2 - 2016-05-01
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
* Added binding to stable ely/anti-tempmail-repo versions.
|
||||||
|
|
||||||
|
## 1.0.1 - 2016-05-01
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
* Removed repository part from composer.json, 'cause ely/anti-tempmail-repo is now published on packagist.
|
||||||
|
|
||||||
## 1.0.0 - 2016-04-30
|
## 1.0.0 - 2016-04-30
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
36
README.md
36
README.md
@@ -1,11 +1,14 @@
|
|||||||
# PHP Tempmail Buster
|
# PHP Tempmail Buster
|
||||||
|
|
||||||
|
[![Latest Version on Packagist][ico-version]][link-packagist]
|
||||||
[![Software License][ico-license]](LICENSE.md)
|
[![Software License][ico-license]](LICENSE.md)
|
||||||
|
[![Total Downloads][ico-downloads]][link-downloads]
|
||||||
|
|
||||||
Расширяемый класс для блокировки E-mail адресов определённых доменов или организации белого списка допустимых доменов.
|
A package to protect your application from users with temp emails. Uses
|
||||||
Реализует лоадер для загрузки и валидации по списку из [Anti Tempmail Repo](https://github.com/elyby/anti-tempmail-repo).
|
[Anti Tempmail Repo](https://github.com/elyby/anti-tempmail-repo) as a default blacklist source. Provides an extendable
|
||||||
|
class for E-mail validation based on black- or whitelist.
|
||||||
|
|
||||||
## Установка
|
## Intallation
|
||||||
|
|
||||||
Install the latest version with
|
Install the latest version with
|
||||||
|
|
||||||
@@ -13,35 +16,36 @@ Install the latest version with
|
|||||||
$ composer require ely/php-tempmailbuster
|
$ composer require ely/php-tempmailbuster
|
||||||
```
|
```
|
||||||
|
|
||||||
## Использование
|
## Usage
|
||||||
|
|
||||||
Пример использования с применением стандартного лоадера:
|
Validation example using default loader:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
use Ely\TempMailBuster\Loader\AntiTempmailRepo;
|
use Ely\TempMailBuster\Loader\AntiTempmailRepo;
|
||||||
use Ely\TempMailBuster\Storage;
|
use Ely\TempMailBuster\Storage;
|
||||||
use Ely\TempMailBuster\Validator;
|
use Ely\TempMailBuster\Validator;
|
||||||
|
|
||||||
// Создаём класс лоадера
|
|
||||||
$loader = new AntiTempmailRepo();
|
$loader = new AntiTempmailRepo();
|
||||||
// Загружаем из него данные и передаём их в объект хранилища
|
// A storage can be instantiated by feeding it with an array of patterns:
|
||||||
$storage = new Storage($loader->load();
|
$storage = new Storage($loader->load());
|
||||||
// или используем статичный метод для работы с лоадерами
|
// or created from loader instance
|
||||||
$storage = Storage::fromLoader($loader);
|
$storage = Storage::fromLoader($loader);
|
||||||
// Создаём класс-валидатор
|
|
||||||
$validator = new Validator($storage);
|
$validator = new Validator($storage);
|
||||||
$validator->validate('team@ely.by'); // = true
|
$validator->validate('team@ely.by'); // = true
|
||||||
$validator->validate('hy42k@sendspamhere.com'); // = false
|
$validator->validate('hy42k@sendspamhere.com'); // = false
|
||||||
|
|
||||||
// Включаем режим белого списка
|
// Enable whitelisting mode
|
||||||
$validator->whitelistMode();
|
$validator->whitelistMode();
|
||||||
$validator->validate('team@ely.by'); // = false
|
$validator->validate('team@ely.by'); // = false
|
||||||
$validator->validate('hy42k@sendspamhere.com'); // = true
|
$validator->validate('hy42k@sendspamhere.com'); // = true
|
||||||
```
|
```
|
||||||
|
|
||||||
Конструктор принимает 2 аргумента: первичное и вторичное хранилище. Первичное хранилище работает в соответствии с
|
Validator constructor accepts 2 arguments: primary and secondary storages. Primary storage is used for validation based
|
||||||
выбранным режимом работы библиотеки, а вторичное (если указано) позволяет добавить исключение из правил. Смотрите
|
on current mode (whitelist/blacklist). Secondary storage (if provided) allows you to add exceptions from primary
|
||||||
больше примеров вызова метода `validate()` в [тестах](tests/ValidatorTest.php).
|
storage rules.
|
||||||
|
|
||||||
|
For more usage examples please take a look on [tests](tests/ValidatorTest.php).
|
||||||
|
|
||||||
## Change log
|
## Change log
|
||||||
|
|
||||||
@@ -60,7 +64,11 @@ This package was designed and developed within the [Ely.by](http://ely.by) proje
|
|||||||
|
|
||||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||||
|
|
||||||
|
[ico-version]: https://img.shields.io/packagist/v/ely/php-tempmailbuster.svg?style=flat-square
|
||||||
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
||||||
|
[ico-downloads]: https://img.shields.io/packagist/dt/ely/php-tempmailbuster.svg?style=flat-square
|
||||||
|
|
||||||
|
[link-packagist]: https://packagist.org/packages/ely/php-tempmailbuster
|
||||||
[link-author]: https://github.com/ErickSkrauch
|
[link-author]: https://github.com/ErickSkrauch
|
||||||
[link-contributors]: ../../contributors
|
[link-contributors]: ../../contributors
|
||||||
|
[link-downloads]: https://packagist.org/packages/ely/php-tempmailbuster
|
||||||
|
|||||||
@@ -17,25 +17,11 @@
|
|||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php" : "~5.4 | ~7.0",
|
"php" : "~5.4 | ~7.0",
|
||||||
"ely/anti-tempmail-repo" : "*"
|
"ely/anti-tempmail-repo" : "~0.1.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpunit/phpunit": "~4.8 || ~5.0"
|
"phpunit/phpunit": "~4.8 || ~5.0"
|
||||||
},
|
},
|
||||||
"repositories": [
|
|
||||||
{
|
|
||||||
"type": "package",
|
|
||||||
"package": {
|
|
||||||
"name": "ely/anti-tempmail-repo",
|
|
||||||
"version": "0.0.0",
|
|
||||||
"source": {
|
|
||||||
"url": "https://github.com/elyby/anti-tempmail-repo.git",
|
|
||||||
"type": "git",
|
|
||||||
"reference": "master"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Ely\\TempMailBuster\\": "src"
|
"Ely\\TempMailBuster\\": "src"
|
||||||
|
|||||||
Reference in New Issue
Block a user