8 Commits

Author SHA1 Message Date
ErickSkrauch
fbe6e73780 Forgot to update CHANGELOG.md 2016-05-01 19:29:02 +03:00
ErickSkrauch
60e657f823 Added bind to a stable release of ely/anti-tempmail-repo 2016-05-01 19:27:08 +03:00
ErickSkrauch
2743cca1a2 Forgot to update CHANGELOG.md 2016-05-01 19:10:09 +03:00
ErickSkrauch
9fec20c469 Fixed line length 2016-05-01 19:01:50 +03:00
ErickSkrauch
6616a5a787 anti-tempmail-repo is now published on packagist, so we don't need to require package from repository 2016-05-01 19:00:09 +03:00
SleepWalker
33c1b6e3df README translation 2016-05-01 09:21:54 +03:00
ErickSkrauch
77b6d84c41 Fixed trendy shields 2016-04-30 21:30:51 +03:00
ErickSkrauch
0bbe59e9cc Added trendy shields 2016-04-30 21:29:37 +03:00
3 changed files with 33 additions and 29 deletions

View File

@@ -3,6 +3,16 @@
All notable changes to `elyby/php-tempmailbuster` are documented in this file using the
[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
### Added

View File

@@ -1,11 +1,14 @@
# PHP Tempmail Buster
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Total Downloads][ico-downloads]][link-downloads]
Расширяемый класс для блокировки E-mail адресов определённых доменов или организации белого списка допустимых доменов.
Реализует лоадер для загрузки и валидации по списку из [Anti Tempmail Repo](https://github.com/elyby/anti-tempmail-repo).
A package to protect your application from users with temp emails. Uses
[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
@@ -13,35 +16,36 @@ Install the latest version with
$ composer require ely/php-tempmailbuster
```
## Использование
## Usage
Пример использования с применением стандартного лоадера:
Validation example using default loader:
```php
use Ely\TempMailBuster\Loader\AntiTempmailRepo;
use Ely\TempMailBuster\Storage;
use Ely\TempMailBuster\Validator;
// Создаём класс лоадера
$loader = new AntiTempmailRepo();
// Загружаем из него данные и передаём их в объект хранилища
$storage = new Storage($loader->load();
// или используем статичный метод для работы с лоадерами
// A storage can be instantiated by feeding it with an array of patterns:
$storage = new Storage($loader->load());
// or created from loader instance
$storage = Storage::fromLoader($loader);
// Создаём класс-валидатор
$validator = new Validator($storage);
$validator->validate('team@ely.by'); // = true
$validator->validate('hy42k@sendspamhere.com'); // = false
// Включаем режим белого списка
// Enable whitelisting mode
$validator->whitelistMode();
$validator->validate('team@ely.by'); // = false
$validator->validate('hy42k@sendspamhere.com'); // = true
```
Конструктор принимает 2 аргумента: первичное и вторичное хранилище. Первичное хранилище работает в соответствии с
выбранным режимом работы библиотеки, а вторичное (если указано) позволяет добавить исключение из правил. Смотрите
больше примеров вызова метода `validate()` в [тестах](tests/ValidatorTest.php).
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
storage rules.
For more usage examples please take a look on [tests](tests/ValidatorTest.php).
## 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.
[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-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-contributors]: ../../contributors
[link-downloads]: https://packagist.org/packages/ely/php-tempmailbuster

View File

@@ -17,25 +17,11 @@
],
"require": {
"php" : "~5.4 | ~7.0",
"ely/anti-tempmail-repo" : "*"
"ely/anti-tempmail-repo" : "~0.1.0"
},
"require-dev": {
"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": {
"psr-4": {
"Ely\\TempMailBuster\\": "src"